aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorarcadia-devtools <arcadia-devtools@yandex-team.ru>2022-03-30 19:17:22 +0300
committerarcadia-devtools <arcadia-devtools@yandex-team.ru>2022-03-30 19:17:22 +0300
commit02b893a1db705829dded00045f0271f249bcae77 (patch)
tree47ebcc1618a0074d4b60fe0d2f24171a39812d63
parente4fbd1916730dd1694b95588ab1285752140b37c (diff)
downloadydb-02b893a1db705829dded00045f0271f249bcae77.tar.gz
intermediate changes
ref:68006ba6a5073fc60e78a54f059b8a0fecabc932
-rw-r--r--build/rules/go/vendor.policy2
-rw-r--r--build/ya.conf.json4
-rw-r--r--contrib/python/boto3/py3/.dist-info/METADATA38
-rw-r--r--contrib/python/boto3/py3/README.rst32
-rw-r--r--contrib/python/boto3/py3/boto3/__init__.py5
-rw-r--r--contrib/python/boto3/py3/boto3/docs/__init__.py3
-rw-r--r--contrib/python/boto3/py3/boto3/docs/action.py79
-rw-r--r--contrib/python/boto3/py3/boto3/docs/attr.py34
-rw-r--r--contrib/python/boto3/py3/boto3/docs/base.py7
-rw-r--r--contrib/python/boto3/py3/boto3/docs/client.py3
-rw-r--r--contrib/python/boto3/py3/boto3/docs/collection.py172
-rw-r--r--contrib/python/boto3/py3/boto3/docs/docstring.py19
-rw-r--r--contrib/python/boto3/py3/boto3/docs/method.py45
-rw-r--r--contrib/python/boto3/py3/boto3/docs/resource.py125
-rw-r--r--contrib/python/boto3/py3/boto3/docs/service.py53
-rw-r--r--contrib/python/boto3/py3/boto3/docs/subresource.py59
-rw-r--r--contrib/python/boto3/py3/boto3/docs/utils.py69
-rw-r--r--contrib/python/boto3/py3/boto3/docs/waiter.py62
-rw-r--r--contrib/python/boto3/py3/boto3/dynamodb/conditions.py105
-rw-r--r--contrib/python/boto3/py3/boto3/dynamodb/table.py50
-rw-r--r--contrib/python/boto3/py3/boto3/dynamodb/transform.py129
-rw-r--r--contrib/python/boto3/py3/boto3/dynamodb/types.py78
-rw-r--r--contrib/python/boto3/py3/boto3/ec2/deletetags.py15
-rw-r--r--contrib/python/boto3/py3/boto3/exceptions.py52
-rw-r--r--contrib/python/boto3/py3/boto3/resources/action.py59
-rw-r--r--contrib/python/boto3/py3/boto3/resources/base.py33
-rw-r--r--contrib/python/boto3/py3/boto3/resources/collection.py168
-rw-r--r--contrib/python/boto3/py3/boto3/resources/factory.py255
-rw-r--r--contrib/python/boto3/py3/boto3/resources/model.py86
-rw-r--r--contrib/python/boto3/py3/boto3/resources/params.py9
-rw-r--r--contrib/python/boto3/py3/boto3/resources/response.py58
-rw-r--r--contrib/python/boto3/py3/boto3/s3/inject.py297
-rw-r--r--contrib/python/boto3/py3/boto3/s3/transfer.py46
-rw-r--r--contrib/python/boto3/py3/boto3/session.py171
-rw-r--r--contrib/python/boto3/py3/boto3/utils.py21
-rw-r--r--contrib/python/botocore/py3/.dist-info/METADATA15
-rw-r--r--contrib/python/botocore/py3/README.rst9
-rw-r--r--contrib/python/botocore/py3/botocore/__init__.py4
-rw-r--r--contrib/python/botocore/py3/botocore/args.py4
-rw-r--r--contrib/python/botocore/py3/botocore/auth.py46
-rw-r--r--contrib/python/botocore/py3/botocore/awsrequest.py48
-rw-r--r--contrib/python/botocore/py3/botocore/client.py40
-rw-r--r--contrib/python/botocore/py3/botocore/config.py12
-rw-r--r--contrib/python/botocore/py3/botocore/configloader.py5
-rw-r--r--contrib/python/botocore/py3/botocore/configprovider.py3
-rw-r--r--contrib/python/botocore/py3/botocore/credentials.py47
-rw-r--r--contrib/python/botocore/py3/botocore/crt/auth.py41
-rw-r--r--contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json150
-rw-r--r--contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json143
-rw-r--r--contrib/python/botocore/py3/botocore/data/amplifybackend/2020-08-11/service-2.json89
-rw-r--r--contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/paginators-1.json10
-rw-r--r--contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/service-2.json164
-rw-r--r--contrib/python/botocore/py3/botocore/data/appflow/2020-08-23/service-2.json53
-rw-r--r--contrib/python/botocore/py3/botocore/data/apprunner/2020-05-15/service-2.json5
-rw-r--r--contrib/python/botocore/py3/botocore/data/athena/2017-05-18/service-2.json106
-rw-r--r--contrib/python/botocore/py3/botocore/data/auditmanager/2017-07-25/service-2.json4
-rw-r--r--contrib/python/botocore/py3/botocore/data/autoscaling/2011-01-01/service-2.json55
-rw-r--r--contrib/python/botocore/py3/botocore/data/backup/2018-11-15/service-2.json52
-rw-r--r--contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json16
-rw-r--r--contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/paginators-1.json74
-rw-r--r--contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/service-2.json2779
-rw-r--r--contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/waiters-2.json4
-rw-r--r--contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/paginators-1.json6
-rw-r--r--contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/service-2.json244
-rw-r--r--contrib/python/botocore/py3/botocore/data/ce/2017-10-25/service-2.json184
-rw-r--r--contrib/python/botocore/py3/botocore/data/chime-sdk-meetings/2021-07-15/service-2.json50
-rw-r--r--contrib/python/botocore/py3/botocore/data/chime/2018-05-01/service-2.json15
-rw-r--r--contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json25
-rw-r--r--contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/service-2.json139
-rw-r--r--contrib/python/botocore/py3/botocore/data/comprehend/2017-11-27/service-2.json282
-rw-r--r--contrib/python/botocore/py3/botocore/data/config/2014-11-12/service-2.json347
-rw-r--r--contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json22
-rw-r--r--contrib/python/botocore/py3/botocore/data/customer-profiles/2020-08-15/service-2.json591
-rw-r--r--contrib/python/botocore/py3/botocore/data/databrew/2017-07-25/service-2.json9
-rw-r--r--contrib/python/botocore/py3/botocore/data/dataexchange/2017-07-25/service-2.json177
-rw-r--r--contrib/python/botocore/py3/botocore/data/devops-guru/2020-12-01/service-2.json138
-rw-r--r--contrib/python/botocore/py3/botocore/data/dynamodb/2012-08-10/service-2.json14
-rw-r--r--contrib/python/botocore/py3/botocore/data/ebs/2019-11-02/service-2.json26
-rw-r--r--contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json242
-rw-r--r--contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/paginators-1.json5
-rw-r--r--contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json17
-rw-r--r--contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json101
-rw-r--r--contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json3
-rw-r--r--contrib/python/botocore/py3/botocore/data/elasticache/2015-02-02/service-2.json22
-rw-r--r--contrib/python/botocore/py3/botocore/data/endpoints.json360
-rw-r--r--contrib/python/botocore/py3/botocore/data/evidently/2021-02-01/service-2.json38
-rw-r--r--contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/paginators-1.json12
-rw-r--r--contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/service-2.json894
-rw-r--r--contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json182
-rw-r--r--contrib/python/botocore/py3/botocore/data/fms/2018-01-01/service-2.json159
-rw-r--r--contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json142
-rw-r--r--contrib/python/botocore/py3/botocore/data/gamelift/2015-10-01/service-2.json384
-rw-r--r--contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/paginators-1.json46
-rw-r--r--contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/service-2.json2509
-rw-r--r--contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json717
-rw-r--r--contrib/python/botocore/py3/botocore/data/greengrassv2/2020-11-30/service-2.json6
-rw-r--r--contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json14
-rw-r--r--contrib/python/botocore/py3/botocore/data/imagebuilder/2019-12-02/service-2.json85
-rw-r--r--contrib/python/botocore/py3/botocore/data/kafkaconnect/2021-09-14/service-2.json101
-rw-r--r--contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json417
-rw-r--r--contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/paginators-1.json22
-rw-r--r--contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/service-2.json1146
-rw-r--r--contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/waiters-2.json5
-rw-r--r--contrib/python/botocore/py3/botocore/data/lakeformation/2017-03-31/service-2.json5
-rw-r--r--contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/service-2.json51
-rw-r--r--contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/waiters-2.json56
-rw-r--r--contrib/python/botocore/py3/botocore/data/lexv2-models/2020-08-07/service-2.json2
-rw-r--r--contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json66
-rw-r--r--contrib/python/botocore/py3/botocore/data/location/2020-11-19/paginators-1.json3
-rw-r--r--contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json20
-rw-r--r--contrib/python/botocore/py3/botocore/data/macie/2017-12-19/service-2.json110
-rw-r--r--contrib/python/botocore/py3/botocore/data/mediaconnect/2018-11-14/service-2.json95
-rw-r--r--contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json70
-rw-r--r--contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json141
-rw-r--r--contrib/python/botocore/py3/botocore/data/mediapackage/2017-10-12/service-2.json3
-rw-r--r--contrib/python/botocore/py3/botocore/data/mgn/2020-02-26/service-2.json110
-rw-r--r--contrib/python/botocore/py3/botocore/data/migration-hub-refactor-spaces/2021-10-26/service-2.json26
-rw-r--r--contrib/python/botocore/py3/botocore/data/organizations/2016-11-28/service-2.json297
-rw-r--r--contrib/python/botocore/py3/botocore/data/outposts/2019-12-03/service-2.json32
-rw-r--r--contrib/python/botocore/py3/botocore/data/panorama/2019-07-24/service-2.json1444
-rw-r--r--contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json8
-rw-r--r--contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json209
-rw-r--r--contrib/python/botocore/py3/botocore/data/ram/2018-01-04/service-2.json8
-rw-r--r--contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json1083
-rw-r--r--contrib/python/botocore/py3/botocore/data/redshift/2012-12-01/service-2.json47
-rw-r--r--contrib/python/botocore/py3/botocore/data/robomaker/2018-06-29/service-2.json28
-rw-r--r--contrib/python/botocore/py3/botocore/data/route53-recovery-cluster/2019-12-02/service-2.json26
-rw-r--r--contrib/python/botocore/py3/botocore/data/route53/2013-04-01/service-2.json12
-rw-r--r--contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.json1
-rw-r--r--contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json1272
-rw-r--r--contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json13
-rw-r--r--contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/paginators-1.json6
-rw-r--r--contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/service-2.json85
-rw-r--r--contrib/python/botocore/py3/botocore/data/secretsmanager/2017-10-17/service-2.json2
-rw-r--r--contrib/python/botocore/py3/botocore/data/servicecatalog-appregistry/2020-06-24/service-2.json8
-rw-r--r--contrib/python/botocore/py3/botocore/data/ssm-incidents/2018-05-10/service-2.json7
-rw-r--r--contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json60
-rw-r--r--contrib/python/botocore/py3/botocore/data/sts/2011-06-15/service-2.json6
-rw-r--r--contrib/python/botocore/py3/botocore/data/synthetics/2017-10-11/service-2.json10
-rw-r--r--contrib/python/botocore/py3/botocore/data/textract/2018-06-27/service-2.json11
-rw-r--r--contrib/python/botocore/py3/botocore/data/timestream-query/2018-11-01/service-2.json9
-rw-r--r--contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json196
-rw-r--r--contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/paginators-1.json48
-rw-r--r--contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json93
-rw-r--r--contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/waiters-2.json45
-rw-r--r--contrib/python/botocore/py3/botocore/data/translate/2017-07-01/service-2.json8
-rw-r--r--contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json26
-rw-r--r--contrib/python/botocore/py3/botocore/discovery.py4
-rw-r--r--contrib/python/botocore/py3/botocore/docs/client.py15
-rw-r--r--contrib/python/botocore/py3/botocore/docs/docstring.py4
-rw-r--r--contrib/python/botocore/py3/botocore/docs/method.py13
-rw-r--r--contrib/python/botocore/py3/botocore/docs/paginator.py2
-rw-r--r--contrib/python/botocore/py3/botocore/docs/service.py9
-rw-r--r--contrib/python/botocore/py3/botocore/docs/sharedexample.py7
-rw-r--r--contrib/python/botocore/py3/botocore/docs/waiter.py2
-rw-r--r--contrib/python/botocore/py3/botocore/endpoint.py28
-rw-r--r--contrib/python/botocore/py3/botocore/eventstream.py1
-rw-r--r--contrib/python/botocore/py3/botocore/exceptions.py9
-rw-r--r--contrib/python/botocore/py3/botocore/handlers.py73
-rw-r--r--contrib/python/botocore/py3/botocore/history.py1
-rw-r--r--contrib/python/botocore/py3/botocore/hooks.py1
-rw-r--r--contrib/python/botocore/py3/botocore/httpchecksum.py453
-rw-r--r--contrib/python/botocore/py3/botocore/httpsession.py49
-rw-r--r--contrib/python/botocore/py3/botocore/loaders.py7
-rw-r--r--contrib/python/botocore/py3/botocore/model.py16
-rw-r--r--contrib/python/botocore/py3/botocore/monitoring.py3
-rw-r--r--contrib/python/botocore/py3/botocore/paginate.py14
-rw-r--r--contrib/python/botocore/py3/botocore/parsers.py25
-rw-r--r--contrib/python/botocore/py3/botocore/regions.py5
-rw-r--r--contrib/python/botocore/py3/botocore/response.py11
-rw-r--r--contrib/python/botocore/py3/botocore/retries/adaptive.py7
-rw-r--r--contrib/python/botocore/py3/botocore/retries/bucket.py2
-rw-r--r--contrib/python/botocore/py3/botocore/retries/special.py2
-rw-r--r--contrib/python/botocore/py3/botocore/retries/standard.py15
-rw-r--r--contrib/python/botocore/py3/botocore/retryhandler.py10
-rw-r--r--contrib/python/botocore/py3/botocore/serialize.py33
-rw-r--r--contrib/python/botocore/py3/botocore/session.py58
-rw-r--r--contrib/python/botocore/py3/botocore/signers.py14
-rw-r--r--contrib/python/botocore/py3/botocore/stub.py35
-rw-r--r--contrib/python/botocore/py3/botocore/utils.py111
-rw-r--r--contrib/python/botocore/py3/botocore/validate.py5
-rw-r--r--contrib/python/botocore/py3/botocore/waiter.py9
-rw-r--r--contrib/python/botocore/py3/patches/01-unvendor-six.patch38
-rw-r--r--contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch25
-rw-r--r--contrib/python/botocore/py3/patches/03-extended-listings.patch4
185 files changed, 19069 insertions, 4228 deletions
diff --git a/build/rules/go/vendor.policy b/build/rules/go/vendor.policy
index a92d71d08d..9f28d62703 100644
--- a/build/rules/go/vendor.policy
+++ b/build/rules/go/vendor.policy
@@ -120,7 +120,7 @@ ALLOW .* -> vendor/github.com/sony/gobreaker
ALLOW .* -> vendor/cuelang.org/go
# driver for write to and read from XLSX files
-ALLOW .* -> vendor/github.com/360EntSecGroup-Skylar/excelize/v2
+ALLOW .* -> vendor/github.com/xuri/excelize/v2
# in-process redis server for tests
ALLOW .* -> vendor/github.com/alicebob/miniredis/v2
diff --git a/build/ya.conf.json b/build/ya.conf.json
index b63ba31a22..461ebfc770 100644
--- a/build/ya.conf.json
+++ b/build/ya.conf.json
@@ -7927,7 +7927,7 @@
"qyp": {
"formula": {
"sandbox_id": [
- 1197649240
+ 1253668008
],
"match": "infra/qyp/vmctl/bin/vmctl"
},
@@ -8559,7 +8559,7 @@
},
"lama": {
"formula": {
- "sandbox_id": 1260998424,
+ "sandbox_id": 1261281509,
"match": "lama"
},
"executable": {
diff --git a/contrib/python/boto3/py3/.dist-info/METADATA b/contrib/python/boto3/py3/.dist-info/METADATA
index 16c571ffd7..de9542dc93 100644
--- a/contrib/python/boto3/py3/.dist-info/METADATA
+++ b/contrib/python/boto3/py3/.dist-info/METADATA
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: boto3
-Version: 1.20.54
+Version: 1.21.29
Summary: The AWS SDK for Python
Home-page: https://github.com/boto/boto3
Author: Amazon Web Services
@@ -22,8 +22,8 @@ Classifier: Programming Language :: Python :: 3.10
Requires-Python: >= 3.6
License-File: LICENSE
License-File: NOTICE
-Requires-Dist: botocore (<1.24.0,>=1.23.54)
-Requires-Dist: jmespath (<1.0.0,>=0.7.1)
+Requires-Dist: botocore (<1.25.0,>=1.24.29)
+Requires-Dist: jmespath (<2.0.0,>=0.7.1)
Requires-Dist: s3transfer (<0.6.0,>=0.5.0)
Provides-Extra: crt
Requires-Dist: botocore[crt] (<2.0a0,>=1.21.0) ; extra == 'crt'
@@ -45,12 +45,15 @@ Boto3 is maintained and published by `Amazon Web Services`_.
Notices
-------
-On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped
-on 07/15/2021. To avoid disruption, customers using Boto3 on Python 2.7 may
+On 2021-01-15, deprecation for Python 2.7 was announced and support was dropped
+on 2021-07-15. To avoid disruption, customers using Boto3 on Python 2.7 may
need to upgrade their version of Python or pin the version of Boto3. For
more information, see this `blog post <https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-python-2-7-in-aws-sdk-for-python-and-aws-cli-v1/>`__.
-Starting in May 2022, we will be dropping support for Python 3.6. This follows the Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__ for the runtime which occurred on 2021-12-23.
+On 2022-05-30, we will be dropping support for Python 3.6. This follows the
+Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__
+for the runtime which occurred on 2021-12-23.
+For more information, see this `blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
.. _boto: https://docs.pythonboto.org/
.. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
@@ -67,22 +70,29 @@ Starting in May 2022, we will be dropping support for Python 3.6. This follows t
Getting Started
---------------
-Assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this or you can install the library using ``pip``:
+Assuming that you have a supported version of Python installed, you can first
+set up your environment with:
+
+..code-block:: sh
+ $ python -m venv .venv
+ ...
+ $ . .venv/bin/activate
+
+Then, you can install boto3 from PyPI with:
+
+.. code-block:: sh
+
+ $ python -m pip install boto3
+
+or install from source with:
.. code-block:: sh
$ git clone https://github.com/boto/boto3.git
$ cd boto3
- $ virtualenv venv
- ...
- $ . venv/bin/activate
$ python -m pip install -r requirements.txt
$ python -m pip install -e .
-.. code-block:: sh
-
- $ python -m pip install boto3
-
Using Boto3
~~~~~~~~~~~~~~
diff --git a/contrib/python/boto3/py3/README.rst b/contrib/python/boto3/py3/README.rst
index b883519aa3..bd8ed7d826 100644
--- a/contrib/python/boto3/py3/README.rst
+++ b/contrib/python/boto3/py3/README.rst
@@ -15,12 +15,15 @@ Boto3 is maintained and published by `Amazon Web Services`_.
Notices
-------
-On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped
-on 07/15/2021. To avoid disruption, customers using Boto3 on Python 2.7 may
+On 2021-01-15, deprecation for Python 2.7 was announced and support was dropped
+on 2021-07-15. To avoid disruption, customers using Boto3 on Python 2.7 may
need to upgrade their version of Python or pin the version of Boto3. For
more information, see this `blog post <https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-python-2-7-in-aws-sdk-for-python-and-aws-cli-v1/>`__.
-Starting in May 2022, we will be dropping support for Python 3.6. This follows the Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__ for the runtime which occurred on 2021-12-23.
+On 2022-05-30, we will be dropping support for Python 3.6. This follows the
+Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__
+for the runtime which occurred on 2021-12-23.
+For more information, see this `blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
.. _boto: https://docs.pythonboto.org/
.. _`doc site`: https://boto3.amazonaws.com/v1/documentation/api/latest/index.html
@@ -37,22 +40,29 @@ Starting in May 2022, we will be dropping support for Python 3.6. This follows t
Getting Started
---------------
-Assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this or you can install the library using ``pip``:
+Assuming that you have a supported version of Python installed, you can first
+set up your environment with:
+
+..code-block:: sh
+ $ python -m venv .venv
+ ...
+ $ . .venv/bin/activate
+
+Then, you can install boto3 from PyPI with:
+
+.. code-block:: sh
+
+ $ python -m pip install boto3
+
+or install from source with:
.. code-block:: sh
$ git clone https://github.com/boto/boto3.git
$ cd boto3
- $ virtualenv venv
- ...
- $ . venv/bin/activate
$ python -m pip install -r requirements.txt
$ python -m pip install -e .
-.. code-block:: sh
-
- $ python -m pip install boto3
-
Using Boto3
~~~~~~~~~~~~~~
diff --git a/contrib/python/boto3/py3/boto3/__init__.py b/contrib/python/boto3/py3/boto3/__init__.py
index b2e607d819..cfe8942ba4 100644
--- a/contrib/python/boto3/py3/boto3/__init__.py
+++ b/contrib/python/boto3/py3/boto3/__init__.py
@@ -13,12 +13,11 @@
import logging
-from boto3.session import Session
from boto3.compat import _warn_deprecated_python
-
+from boto3.session import Session
__author__ = 'Amazon Web Services'
-__version__ = '1.20.54'
+__version__ = '1.21.29'
# The default Boto3 session; autoloaded when needed.
diff --git a/contrib/python/boto3/py3/boto3/docs/__init__.py b/contrib/python/boto3/py3/boto3/docs/__init__.py
index 7f3a0da47e..d1cd8b52f4 100644
--- a/contrib/python/boto3/py3/boto3/docs/__init__.py
+++ b/contrib/python/boto3/py3/boto3/docs/__init__.py
@@ -34,6 +34,7 @@ def generate_docs(root_dir, session):
for service_name in session.get_available_services():
docs = ServiceDocumenter(service_name, session).document_service()
service_doc_path = os.path.join(
- services_doc_path, service_name + '.rst')
+ services_doc_path, service_name + '.rst'
+ )
with open(service_doc_path, 'wb') as f:
f.write(docs)
diff --git a/contrib/python/boto3/py3/boto3/docs/action.py b/contrib/python/boto3/py3/boto3/docs/action.py
index be30ae5f29..907f428663 100644
--- a/contrib/python/boto3/py3/boto3/docs/action.py
+++ b/contrib/python/boto3/py3/boto3/docs/action.py
@@ -11,16 +11,20 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from botocore import xform_name
+from botocore.docs.method import (
+ document_custom_method,
+ document_model_driven_method,
+)
from botocore.model import OperationModel
from botocore.utils import get_service_module_name
-from botocore.docs.method import document_model_driven_method
-from botocore.docs.method import document_custom_method
from boto3.docs.base import BaseDocumenter
from boto3.docs.method import document_model_driven_resource_method
-from boto3.docs.utils import get_resource_ignore_params
-from boto3.docs.utils import get_resource_public_actions
-from boto3.docs.utils import add_resource_type_overview
+from boto3.docs.utils import (
+ add_resource_type_overview,
+ get_resource_ignore_params,
+ get_resource_public_actions,
+)
class ActionDocumenter(BaseDocumenter):
@@ -30,7 +34,8 @@ class ActionDocumenter(BaseDocumenter):
for modeled_action in modeled_actions_list:
modeled_actions[modeled_action.name] = modeled_action
resource_actions = get_resource_public_actions(
- self._resource.__class__)
+ self._resource.__class__
+ )
self.member_map['actions'] = sorted(resource_actions)
add_resource_type_overview(
section=section,
@@ -38,8 +43,10 @@ class ActionDocumenter(BaseDocumenter):
description=(
'Actions call operations on resources. They may '
'automatically handle the passing in of arguments set '
- 'from identifiers and some attributes.'),
- intro_link='actions_intro')
+ 'from identifiers and some attributes.'
+ ),
+ intro_link='actions_intro',
+ )
for action_name in sorted(resource_actions):
action_section = section.add_new_section(action_name)
@@ -50,7 +57,7 @@ class ActionDocumenter(BaseDocumenter):
resource_name=self._resource_name,
event_emitter=self._resource.meta.client.meta.events,
load_model=self._resource_model.load,
- service_model=self._service_model
+ service_model=self._service_model,
)
elif action_name in modeled_actions:
document_action(
@@ -62,11 +69,18 @@ class ActionDocumenter(BaseDocumenter):
)
else:
document_custom_method(
- action_section, action_name, resource_actions[action_name])
+ action_section, action_name, resource_actions[action_name]
+ )
-def document_action(section, resource_name, event_emitter, action_model,
- service_model, include_signature=True):
+def document_action(
+ section,
+ resource_name,
+ event_emitter,
+ action_model,
+ service_model,
+ include_signature=True,
+):
"""Documents a resource action
:param section: The section to write to
@@ -83,7 +97,8 @@ def document_action(section, resource_name, event_emitter, action_model,
It is useful for generating docstrings.
"""
operation_model = service_model.operation_model(
- action_model.request.operation)
+ action_model.request.operation
+ )
ignore_params = get_resource_ignore_params(action_model.request.params)
example_return_value = 'response'
@@ -92,23 +107,31 @@ def document_action(section, resource_name, event_emitter, action_model,
example_resource_name = xform_name(resource_name)
if service_model.service_name == resource_name:
example_resource_name = resource_name
- example_prefix = '%s = %s.%s' % (
- example_return_value, example_resource_name, action_model.name)
+ example_prefix = '{} = {}.{}'.format(
+ example_return_value, example_resource_name, action_model.name
+ )
document_model_driven_resource_method(
- section=section, method_name=action_model.name,
+ section=section,
+ method_name=action_model.name,
operation_model=operation_model,
event_emitter=event_emitter,
method_description=operation_model.documentation,
example_prefix=example_prefix,
exclude_input=ignore_params,
resource_action_model=action_model,
- include_signature=include_signature
+ include_signature=include_signature,
)
-def document_load_reload_action(section, action_name, resource_name,
- event_emitter, load_model, service_model,
- include_signature=True):
+def document_load_reload_action(
+ section,
+ action_name,
+ resource_name,
+ event_emitter,
+ load_model,
+ service_model,
+ include_signature=True,
+):
"""Documents the resource load action
:param section: The section to write to
@@ -127,22 +150,24 @@ def document_load_reload_action(section, action_name, resource_name,
It is useful for generating docstrings.
"""
description = (
- 'Calls :py:meth:`%s.Client.%s` to update the attributes of the'
- ' %s resource. Note that the load and reload methods are '
- 'the same method and can be used interchangeably.' % (
+ 'Calls :py:meth:`{}.Client.{}` to update the attributes of the '
+ '{} resource. Note that the load and reload methods are '
+ 'the same method and can be used interchangeably.'.format(
get_service_module_name(service_model),
xform_name(load_model.request.operation),
- resource_name)
+ resource_name,
+ )
)
example_resource_name = xform_name(resource_name)
if service_model.service_name == resource_name:
example_resource_name = resource_name
- example_prefix = '%s.%s' % (example_resource_name, action_name)
+ example_prefix = f'{example_resource_name}.{action_name}'
document_model_driven_method(
- section=section, method_name=action_name,
+ section=section,
+ method_name=action_name,
operation_model=OperationModel({}, service_model),
event_emitter=event_emitter,
method_description=description,
example_prefix=example_prefix,
- include_signature=include_signature
+ include_signature=include_signature,
)
diff --git a/contrib/python/boto3/py3/boto3/docs/attr.py b/contrib/python/boto3/py3/boto3/docs/attr.py
index 86e5e04c05..ced8bc287a 100644
--- a/contrib/python/boto3/py3/boto3/docs/attr.py
+++ b/contrib/python/boto3/py3/boto3/docs/attr.py
@@ -19,8 +19,15 @@ class ResourceShapeDocumenter(ResponseParamsDocumenter):
EVENT_NAME = 'resource-shape'
-def document_attribute(section, service_name, resource_name, attr_name,
- event_emitter, attr_model, include_signature=True):
+def document_attribute(
+ section,
+ service_name,
+ resource_name,
+ attr_name,
+ event_emitter,
+ attr_model,
+ include_signature=True,
+):
if include_signature:
section.style.start_sphinx_py_attr(attr_name)
# Note that an attribute may have one, may have many, or may have no
@@ -28,27 +35,28 @@ def document_attribute(section, service_name, resource_name, attr_name,
# operation_name to the resource name if we ever to hook in and modify
# a particular attribute.
ResourceShapeDocumenter(
- service_name=service_name, operation_name=resource_name,
- event_emitter=event_emitter).document_params(
- section=section,
- shape=attr_model)
+ service_name=service_name,
+ operation_name=resource_name,
+ event_emitter=event_emitter,
+ ).document_params(section=section, shape=attr_model)
-def document_identifier(section, resource_name, identifier_model,
- include_signature=True):
+def document_identifier(
+ section, resource_name, identifier_model, include_signature=True
+):
if include_signature:
section.style.start_sphinx_py_attr(identifier_model.name)
description = get_identifier_description(
- resource_name, identifier_model.name)
- description = '*(string)* ' + description
- section.write(description)
+ resource_name, identifier_model.name
+ )
+ section.write(f'*(string)* {description}')
def document_reference(section, reference_model, include_signature=True):
if include_signature:
section.style.start_sphinx_py_attr(reference_model.name)
- reference_type = '(:py:class:`%s`) ' % reference_model.resource.type
+ reference_type = f'(:py:class:`{reference_model.resource.type}`) '
section.write(reference_type)
section.include_doc_string(
- 'The related %s if set, otherwise ``None``.' % reference_model.name
+ f'The related {reference_model.name} if set, otherwise ``None``.'
)
diff --git a/contrib/python/boto3/py3/boto3/docs/base.py b/contrib/python/boto3/py3/boto3/docs/base.py
index 3daec8f00b..a12d94543f 100644
--- a/contrib/python/boto3/py3/boto3/docs/base.py
+++ b/contrib/python/boto3/py3/boto3/docs/base.py
@@ -13,7 +13,7 @@
from botocore.compat import OrderedDict
-class BaseDocumenter(object):
+class BaseDocumenter:
def __init__(self, resource):
self._resource = resource
self._client = self._resource.meta.client
@@ -24,8 +24,9 @@ class BaseDocumenter(object):
self._service_docs_name = self._client.__class__.__name__
self.member_map = OrderedDict()
self.represents_service_resource = (
- self._service_name == self._resource_name)
+ self._service_name == self._resource_name
+ )
@property
def class_name(self):
- return '%s.%s' % (self._service_docs_name, self._resource_name)
+ return f'{self._service_docs_name}.{self._resource_name}'
diff --git a/contrib/python/boto3/py3/boto3/docs/client.py b/contrib/python/boto3/py3/boto3/docs/client.py
index 38cfe9af6b..51e92e35d2 100644
--- a/contrib/python/boto3/py3/boto3/docs/client.py
+++ b/contrib/python/boto3/py3/boto3/docs/client.py
@@ -22,6 +22,7 @@ class Boto3ClientDocumenter(ClientDocumenter):
section.style.new_line()
section.write(
'client = boto3.client(\'{service}\')'.format(
- service=self._service_name)
+ service=self._service_name
+ )
)
section.style.end_codeblock()
diff --git a/contrib/python/boto3/py3/boto3/docs/collection.py b/contrib/python/boto3/py3/boto3/docs/collection.py
index db0fb799a2..a1f9ca7faa 100644
--- a/contrib/python/boto3/py3/boto3/docs/collection.py
+++ b/contrib/python/boto3/py3/boto3/docs/collection.py
@@ -15,9 +15,11 @@ from botocore.docs.method import get_instance_public_methods
from botocore.docs.utils import DocumentedShape
from boto3.docs.base import BaseDocumenter
-from boto3.docs.utils import get_resource_ignore_params
from boto3.docs.method import document_model_driven_resource_method
-from boto3.docs.utils import add_resource_type_overview
+from boto3.docs.utils import (
+ add_resource_type_overview,
+ get_resource_ignore_params,
+)
class CollectionDocumenter(BaseDocumenter):
@@ -29,8 +31,10 @@ class CollectionDocumenter(BaseDocumenter):
resource_type='Collections',
description=(
'Collections provide an interface to iterate over and '
- 'manipulate groups of resources. '),
- intro_link='guide_collections')
+ 'manipulate groups of resources. '
+ ),
+ intro_link='guide_collections',
+ )
self.member_map['collections'] = collections_list
for collection in collections:
collection_section = section.add_new_section(collection.name)
@@ -39,7 +43,8 @@ class CollectionDocumenter(BaseDocumenter):
def _document_collection(self, section, collection):
methods = get_instance_public_methods(
- getattr(self._resource, collection.name))
+ getattr(self._resource, collection.name)
+ )
document_collection_object(section, collection)
batch_actions = {}
for batch_action in collection.batch_actions:
@@ -54,7 +59,7 @@ class CollectionDocumenter(BaseDocumenter):
event_emitter=self._resource.meta.client.meta.events,
batch_action_model=batch_actions[method],
collection_model=collection,
- service_model=self._resource.meta.client.meta.service_model
+ service_model=self._resource.meta.client.meta.service_model,
)
else:
document_collection_method(
@@ -63,12 +68,13 @@ class CollectionDocumenter(BaseDocumenter):
action_name=method,
event_emitter=self._resource.meta.client.meta.events,
collection_model=collection,
- service_model=self._resource.meta.client.meta.service_model
+ service_model=self._resource.meta.client.meta.service_model,
)
-def document_collection_object(section, collection_model,
- include_signature=True):
+def document_collection_object(
+ section, collection_model, include_signature=True
+):
"""Documents a collection resource object
:param section: The section to write to
@@ -81,16 +87,24 @@ def document_collection_object(section, collection_model,
if include_signature:
section.style.start_sphinx_py_attr(collection_model.name)
section.include_doc_string(
- 'A collection of %s resources.' % collection_model.resource.type)
+ f'A collection of {collection_model.resource.type} resources.'
+ )
section.include_doc_string(
- 'A %s Collection will include all resources by default, '
- 'and extreme caution should be taken when performing '
- 'actions on all resources.' % collection_model.resource.type)
+ f'A {collection_model.resource.type} Collection will include all '
+ f'resources by default, and extreme caution should be taken when '
+ f'performing actions on all resources.'
+ )
-def document_batch_action(section, resource_name, event_emitter,
- batch_action_model, service_model, collection_model,
- include_signature=True):
+def document_batch_action(
+ section,
+ resource_name,
+ event_emitter,
+ batch_action_model,
+ service_model,
+ collection_model,
+ include_signature=True,
+):
"""Documents a collection's batch action
:param section: The section to write to
@@ -112,9 +126,11 @@ def document_batch_action(section, resource_name, event_emitter,
It is useful for generating docstrings.
"""
operation_model = service_model.operation_model(
- batch_action_model.request.operation)
+ batch_action_model.request.operation
+ )
ignore_params = get_resource_ignore_params(
- batch_action_model.request.params)
+ batch_action_model.request.params
+ )
example_return_value = 'response'
if batch_action_model.resource:
@@ -123,25 +139,34 @@ def document_batch_action(section, resource_name, event_emitter,
example_resource_name = xform_name(resource_name)
if service_model.service_name == resource_name:
example_resource_name = resource_name
- example_prefix = '%s = %s.%s.%s' % (
- example_return_value, example_resource_name,
- collection_model.name, batch_action_model.name
+ example_prefix = '{} = {}.{}.{}'.format(
+ example_return_value,
+ example_resource_name,
+ collection_model.name,
+ batch_action_model.name,
)
document_model_driven_resource_method(
- section=section, method_name=batch_action_model.name,
+ section=section,
+ method_name=batch_action_model.name,
operation_model=operation_model,
event_emitter=event_emitter,
method_description=operation_model.documentation,
example_prefix=example_prefix,
exclude_input=ignore_params,
resource_action_model=batch_action_model,
- include_signature=include_signature
+ include_signature=include_signature,
)
-def document_collection_method(section, resource_name, action_name,
- event_emitter, collection_model, service_model,
- include_signature=True):
+def document_collection_method(
+ section,
+ resource_name,
+ action_name,
+ event_emitter,
+ collection_model,
+ service_model,
+ include_signature=True,
+):
"""Documents a collection method
:param section: The section to write to
@@ -161,7 +186,8 @@ def document_collection_method(section, resource_name, action_name,
It is useful for generating docstrings.
"""
operation_model = service_model.operation_model(
- collection_model.request.operation)
+ collection_model.request.operation
+ )
underlying_operation_members = []
if operation_model.input_shape:
@@ -174,71 +200,87 @@ def document_collection_method(section, resource_name, action_name,
custom_action_info_dict = {
'all': {
'method_description': (
- 'Creates an iterable of all %s resources '
- 'in the collection.' % collection_model.resource.type),
- 'example_prefix': '%s_iterator = %s.%s.all' % (
+ f'Creates an iterable of all {collection_model.resource.type} '
+ f'resources in the collection.'
+ ),
+ 'example_prefix': '{}_iterator = {}.{}.all'.format(
xform_name(collection_model.resource.type),
- example_resource_name, collection_model.name),
- 'exclude_input': underlying_operation_members
+ example_resource_name,
+ collection_model.name,
+ ),
+ 'exclude_input': underlying_operation_members,
},
'filter': {
'method_description': (
- 'Creates an iterable of all %s resources '
- 'in the collection filtered by kwargs passed to '
- 'method. A %s collection will include all resources by '
- 'default if no filters are provided, and extreme '
- 'caution should be taken when performing actions '
- 'on all resources.' % (
- collection_model.resource.type,
- collection_model.resource.type
- )),
- 'example_prefix': '%s_iterator = %s.%s.filter' % (
+ f'Creates an iterable of all {collection_model.resource.type} '
+ f'resources in the collection filtered by kwargs passed to '
+ f'method. A {collection_model.resource.type} collection will '
+ f'include all resources by default if no filters are provided, '
+ f'and extreme caution should be taken when performing actions '
+ f'on all resources.'
+ ),
+ 'example_prefix': '{}_iterator = {}.{}.filter'.format(
xform_name(collection_model.resource.type),
- example_resource_name, collection_model.name),
+ example_resource_name,
+ collection_model.name,
+ ),
'exclude_input': get_resource_ignore_params(
- collection_model.request.params)
+ collection_model.request.params
+ ),
},
'limit': {
'method_description': (
- 'Creates an iterable up to a specified amount of '
- '%s resources in the collection.' %
- collection_model.resource.type),
- 'example_prefix': '%s_iterator = %s.%s.limit' % (
+ f'Creates an iterable up to a specified amount of '
+ f'{collection_model.resource.type} resources in the collection.'
+ ),
+ 'example_prefix': '{}_iterator = {}.{}.limit'.format(
xform_name(collection_model.resource.type),
- example_resource_name, collection_model.name),
+ example_resource_name,
+ collection_model.name,
+ ),
'include_input': [
DocumentedShape(
- name='count', type_name='integer',
+ name='count',
+ type_name='integer',
documentation=(
'The limit to the number of resources '
- 'in the iterable.'))],
- 'exclude_input': underlying_operation_members
+ 'in the iterable.'
+ ),
+ )
+ ],
+ 'exclude_input': underlying_operation_members,
},
'page_size': {
'method_description': (
- 'Creates an iterable of all %s resources '
- 'in the collection, but limits the number of '
- 'items returned by each service call by the specified '
- 'amount.' % collection_model.resource.type),
- 'example_prefix': '%s_iterator = %s.%s.page_size' % (
+ f'Creates an iterable of all {collection_model.resource.type} '
+ f'resources in the collection, but limits the number of '
+ f'items returned by each service call by the specified amount.'
+ ),
+ 'example_prefix': '{}_iterator = {}.{}.page_size'.format(
xform_name(collection_model.resource.type),
- example_resource_name, collection_model.name),
+ example_resource_name,
+ collection_model.name,
+ ),
'include_input': [
DocumentedShape(
- name='count', type_name='integer',
+ name='count',
+ type_name='integer',
documentation=(
- 'The number of items returned by each '
- 'service call'))],
- 'exclude_input': underlying_operation_members
- }
+ 'The number of items returned by each ' 'service call'
+ ),
+ )
+ ],
+ 'exclude_input': underlying_operation_members,
+ },
}
if action_name in custom_action_info_dict:
action_info = custom_action_info_dict[action_name]
document_model_driven_resource_method(
- section=section, method_name=action_name,
+ section=section,
+ method_name=action_name,
operation_model=operation_model,
event_emitter=event_emitter,
resource_action_model=collection_model,
include_signature=include_signature,
- **action_info
+ **action_info,
)
diff --git a/contrib/python/boto3/py3/boto3/docs/docstring.py b/contrib/python/boto3/py3/boto3/docs/docstring.py
index f2d638896f..daf67873ec 100644
--- a/contrib/python/boto3/py3/boto3/docs/docstring.py
+++ b/contrib/python/boto3/py3/boto3/docs/docstring.py
@@ -12,15 +12,18 @@
# language governing permissions and limitations under the License.
from botocore.docs.docstring import LazyLoadedDocstring
-from boto3.docs.action import document_action
-from boto3.docs.action import document_load_reload_action
+from boto3.docs.action import document_action, document_load_reload_action
+from boto3.docs.attr import (
+ document_attribute,
+ document_identifier,
+ document_reference,
+)
+from boto3.docs.collection import (
+ document_batch_action,
+ document_collection_method,
+ document_collection_object,
+)
from boto3.docs.subresource import document_sub_resource
-from boto3.docs.attr import document_attribute
-from boto3.docs.attr import document_identifier
-from boto3.docs.attr import document_reference
-from boto3.docs.collection import document_collection_object
-from boto3.docs.collection import document_collection_method
-from boto3.docs.collection import document_batch_action
from boto3.docs.waiter import document_resource_waiter
diff --git a/contrib/python/boto3/py3/boto3/docs/method.py b/contrib/python/boto3/py3/boto3/docs/method.py
index 40b5650699..b7520088c2 100644
--- a/contrib/python/boto3/py3/boto3/docs/method.py
+++ b/contrib/python/boto3/py3/boto3/docs/method.py
@@ -14,14 +14,24 @@ from botocore.docs.method import document_model_driven_method
def document_model_driven_resource_method(
- section, method_name, operation_model, event_emitter,
- method_description=None, example_prefix=None, include_input=None,
- include_output=None, exclude_input=None, exclude_output=None,
- document_output=True, resource_action_model=None,
- include_signature=True):
+ section,
+ method_name,
+ operation_model,
+ event_emitter,
+ method_description=None,
+ example_prefix=None,
+ include_input=None,
+ include_output=None,
+ exclude_input=None,
+ exclude_output=None,
+ document_output=True,
+ resource_action_model=None,
+ include_signature=True,
+):
document_model_driven_method(
- section=section, method_name=method_name,
+ section=section,
+ method_name=method_name,
operation_model=operation_model,
event_emitter=event_emitter,
method_description=method_description,
@@ -31,7 +41,7 @@ def document_model_driven_resource_method(
exclude_input=exclude_input,
exclude_output=exclude_output,
document_output=document_output,
- include_signature=include_signature
+ include_signature=include_signature,
)
# If this action returns a resource modify the return example to
@@ -42,24 +52,21 @@ def document_model_driven_resource_method(
resource_type = resource_action_model.resource.type
new_return_section = section.add_new_section('return')
- return_resource_type = '%s.%s' % (
- operation_model.service_model.service_name,
- resource_type)
+ return_resource_type = '{}.{}'.format(
+ operation_model.service_model.service_name, resource_type
+ )
- return_type = ':py:class:`%s`' % return_resource_type
- return_description = '%s resource' % (resource_type)
+ return_type = f':py:class:`{return_resource_type}`'
+ return_description = f'{resource_type} resource'
if _method_returns_resource_list(resource_action_model.resource):
- return_type = 'list(%s)' % return_type
- return_description = 'A list of %s resources' % (
- resource_type)
+ return_type = f'list({return_type})'
+ return_description = f'A list of {resource_type} resources'
new_return_section.style.new_line()
- new_return_section.write(
- ':rtype: %s' % return_type)
+ new_return_section.write(f':rtype: {return_type}')
new_return_section.style.new_line()
- new_return_section.write(
- ':returns: %s' % return_description)
+ new_return_section.write(f':returns: {return_description}')
new_return_section.style.new_line()
diff --git a/contrib/python/boto3/py3/boto3/docs/resource.py b/contrib/python/boto3/py3/boto3/docs/resource.py
index 9ce4a7cc9f..7d5516e9c1 100644
--- a/contrib/python/boto3/py3/boto3/docs/resource.py
+++ b/contrib/python/boto3/py3/boto3/docs/resource.py
@@ -13,23 +13,27 @@
from botocore import xform_name
from botocore.docs.utils import get_official_service_name
-from boto3.docs.base import BaseDocumenter
from boto3.docs.action import ActionDocumenter
-from boto3.docs.waiter import WaiterResourceDocumenter
+from boto3.docs.attr import (
+ document_attribute,
+ document_identifier,
+ document_reference,
+)
+from boto3.docs.base import BaseDocumenter
from boto3.docs.collection import CollectionDocumenter
from boto3.docs.subresource import SubResourceDocumenter
-from boto3.docs.attr import document_attribute
-from boto3.docs.attr import document_identifier
-from boto3.docs.attr import document_reference
-from boto3.docs.utils import get_identifier_args_for_signature
-from boto3.docs.utils import get_identifier_values_for_example
-from boto3.docs.utils import get_identifier_description
-from boto3.docs.utils import add_resource_type_overview
+from boto3.docs.utils import (
+ add_resource_type_overview,
+ get_identifier_args_for_signature,
+ get_identifier_description,
+ get_identifier_values_for_example,
+)
+from boto3.docs.waiter import WaiterResourceDocumenter
class ResourceDocumenter(BaseDocumenter):
def __init__(self, resource, botocore_session):
- super(ResourceDocumenter, self).__init__(resource)
+ super().__init__(resource)
self._botocore_session = botocore_session
def document_resource(self, section):
@@ -57,7 +61,8 @@ class ResourceDocumenter(BaseDocumenter):
# Write out the class signature.
class_args = get_identifier_args_for_signature(identifier_names)
section.style.start_sphinx_py_class(
- class_name='%s(%s)' % (self.class_name, class_args))
+ class_name=f'{self.class_name}({class_args})'
+ )
# Add as short description about the resource
description_section = section.add_new_section('description')
@@ -73,11 +78,12 @@ class ResourceDocumenter(BaseDocumenter):
self._add_params_description(param_section, identifier_names)
def _add_description(self, section):
- official_service_name = get_official_service_name(
- self._service_model)
+ official_service_name = get_official_service_name(self._service_model)
section.write(
- 'A resource representing an %s %s' % (
- official_service_name, self._resource_name))
+ 'A resource representing an {} {}'.format(
+ official_service_name, self._resource_name
+ )
+ )
def _add_example(self, section, identifier_names):
section.style.start_codeblock()
@@ -86,39 +92,49 @@ class ResourceDocumenter(BaseDocumenter):
section.style.new_line()
section.style.new_line()
section.write(
- '%s = boto3.resource(\'%s\')' % (
- self._service_name, self._service_name)
+ '{} = boto3.resource(\'{}\')'.format(
+ self._service_name, self._service_name
+ )
)
section.style.new_line()
example_values = get_identifier_values_for_example(identifier_names)
section.write(
- '%s = %s.%s(%s)' % (
- xform_name(self._resource_name), self._service_name,
- self._resource_name, example_values))
+ '{} = {}.{}({})'.format(
+ xform_name(self._resource_name),
+ self._service_name,
+ self._resource_name,
+ example_values,
+ )
+ )
section.style.end_codeblock()
def _add_params_description(self, section, identifier_names):
for identifier_name in identifier_names:
description = get_identifier_description(
- self._resource_name, identifier_name)
- section.write(':type %s: string' % identifier_name)
+ self._resource_name, identifier_name
+ )
+ section.write(f':type {identifier_name}: string')
section.style.new_line()
- section.write(':param %s: %s' % (
- identifier_name, description))
+ section.write(f':param {identifier_name}: {description}')
section.style.new_line()
def _add_overview_of_members(self, section):
for resource_member_type in self.member_map:
section.style.new_line()
- section.write('These are the resource\'s available %s:' % (
- resource_member_type))
+ section.write(
+ f'These are the resource\'s available {resource_member_type}:'
+ )
section.style.new_line()
for member in self.member_map[resource_member_type]:
- if resource_member_type in ['identifiers', 'attributes',
- 'references', 'collections']:
- section.style.li(':py:attr:`%s`' % member)
+ if resource_member_type in (
+ 'attributes',
+ 'collections',
+ 'identifiers',
+ 'references',
+ ):
+ section.style.li(f':py:attr:`{member}`')
else:
- section.style.li(':py:meth:`%s()`' % member)
+ section.style.li(f':py:meth:`{member}()`')
def _add_identifiers(self, section):
identifiers = self._resource.meta.resource_model.identifiers
@@ -131,15 +147,17 @@ class ResourceDocumenter(BaseDocumenter):
resource_type='Identifiers',
description=(
'Identifiers are properties of a resource that are '
- 'set upon instantiation of the resource.'),
- intro_link='identifiers_attributes_intro')
+ 'set upon instantiation of the resource.'
+ ),
+ intro_link='identifiers_attributes_intro',
+ )
for identifier in identifiers:
identifier_section = section.add_new_section(identifier.name)
member_list.append(identifier.name)
document_identifier(
section=identifier_section,
resource_name=self._resource_name,
- identifier_model=identifier
+ identifier_model=identifier,
)
def _add_attributes(self, section):
@@ -147,9 +165,11 @@ class ResourceDocumenter(BaseDocumenter):
attributes = {}
if self._resource.meta.resource_model.shape:
shape = service_model.shape_for(
- self._resource.meta.resource_model.shape)
+ self._resource.meta.resource_model.shape
+ )
attributes = self._resource.meta.resource_model.get_attributes(
- shape)
+ shape
+ )
section = section.add_new_section('attributes')
attribute_list = []
if attributes:
@@ -160,8 +180,10 @@ class ResourceDocumenter(BaseDocumenter):
'Attributes provide access'
' to the properties of a resource. Attributes are lazy-'
'loaded the first time one is accessed via the'
- ' :py:meth:`load` method.'),
- intro_link='identifiers_attributes_intro')
+ ' :py:meth:`load` method.'
+ ),
+ intro_link='identifiers_attributes_intro',
+ )
self.member_map['attributes'] = attribute_list
for attr_name in sorted(attributes):
_, attr_shape = attributes[attr_name]
@@ -173,7 +195,7 @@ class ResourceDocumenter(BaseDocumenter):
resource_name=self._resource_name,
attr_name=attr_name,
event_emitter=self._resource.meta.client.meta.events,
- attr_model=attr_shape
+ attr_model=attr_shape,
)
def _add_references(self, section):
@@ -186,15 +208,16 @@ class ResourceDocumenter(BaseDocumenter):
resource_type='References',
description=(
'References are related resource instances that have '
- 'a belongs-to relationship.'),
- intro_link='references_intro')
+ 'a belongs-to relationship.'
+ ),
+ intro_link='references_intro',
+ )
self.member_map['references'] = reference_list
for reference in references:
reference_section = section.add_new_section(reference.name)
reference_list.append(reference.name)
document_reference(
- section=reference_section,
- reference_model=reference
+ section=reference_section, reference_model=reference
)
def _add_actions(self, section):
@@ -226,9 +249,11 @@ class ResourceDocumenter(BaseDocumenter):
waiters = self._resource.meta.resource_model.waiters
if waiters:
service_waiter_model = self._botocore_session.get_waiter_model(
- self._service_name)
+ self._service_name
+ )
documenter = WaiterResourceDocumenter(
- self._resource, service_waiter_model)
+ self._resource, service_waiter_model
+ )
documenter.member_map = self.member_map
documenter.document_resource_waiters(section)
@@ -236,16 +261,14 @@ class ResourceDocumenter(BaseDocumenter):
class ServiceResourceDocumenter(ResourceDocumenter):
@property
def class_name(self):
- return '%s.ServiceResource' % self._service_docs_name
+ return f'{self._service_docs_name}.ServiceResource'
def _add_title(self, section):
section.style.h2('Service Resource')
def _add_description(self, section):
- official_service_name = get_official_service_name(
- self._service_model)
- section.write(
- 'A resource representing %s' % official_service_name)
+ official_service_name = get_official_service_name(self._service_model)
+ section.write(f'A resource representing {official_service_name}')
def _add_example(self, section, identifier_names):
section.style.start_codeblock()
@@ -254,6 +277,6 @@ class ServiceResourceDocumenter(ResourceDocumenter):
section.style.new_line()
section.style.new_line()
section.write(
- '%s = boto3.resource(\'%s\')' % (
- self._service_name, self._service_name))
+ f'{self._service_name} = boto3.resource(\'{self._service_name}\')'
+ )
section.style.end_codeblock()
diff --git a/contrib/python/boto3/py3/boto3/docs/service.py b/contrib/python/boto3/py3/boto3/docs/service.py
index 602b8c99de..56a4e6360d 100644
--- a/contrib/python/boto3/py3/boto3/docs/service.py
+++ b/contrib/python/boto3/py3/boto3/docs/service.py
@@ -12,15 +12,14 @@
# language governing permissions and limitations under the License.
import os
-import boto3
-from botocore.exceptions import DataNotFoundError
-from botocore.docs.service import ServiceDocumenter as BaseServiceDocumenter
from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.service import ServiceDocumenter as BaseServiceDocumenter
+from botocore.exceptions import DataNotFoundError
-from boto3.utils import ServiceContext
+import boto3
from boto3.docs.client import Boto3ClientDocumenter
-from boto3.docs.resource import ResourceDocumenter
-from boto3.docs.resource import ServiceResourceDocumenter
+from boto3.docs.resource import ResourceDocumenter, ServiceResourceDocumenter
+from boto3.utils import ServiceContext
class ServiceDocumenter(BaseServiceDocumenter):
@@ -28,7 +27,7 @@ class ServiceDocumenter(BaseServiceDocumenter):
EXAMPLE_PATH = os.path.join(os.path.dirname(boto3.__file__), 'examples')
def __init__(self, service_name, session):
- super(ServiceDocumenter, self).__init__(
+ super().__init__(
service_name=service_name,
# I know that this is an internal attribute, but the botocore session
# is needed to load the paginator and waiter models.
@@ -47,7 +46,7 @@ class ServiceDocumenter(BaseServiceDocumenter):
'waiters',
'service-resource',
'resources',
- 'examples'
+ 'examples',
]
def document_service(self):
@@ -56,8 +55,8 @@ class ServiceDocumenter(BaseServiceDocumenter):
:returns: The reStructured text of the documented service.
"""
doc_structure = DocumentStructure(
- self._service_name, section_names=self.sections,
- target='html')
+ self._service_name, section_names=self.sections, target='html'
+ )
self.title(doc_structure.get_section('title'))
self.table_of_contents(doc_structure.get_section('table-of-contents'))
@@ -66,7 +65,8 @@ class ServiceDocumenter(BaseServiceDocumenter):
self.waiter_api(doc_structure.get_section('waiters'))
if self._service_resource:
self._document_service_resource(
- doc_structure.get_section('service-resource'))
+ doc_structure.get_section('service-resource')
+ )
self._document_resources(doc_structure.get_section('resources'))
self._document_examples(doc_structure.get_section('examples'))
return doc_structure.flush_structure()
@@ -82,42 +82,45 @@ class ServiceDocumenter(BaseServiceDocumenter):
def _document_service_resource(self, section):
ServiceResourceDocumenter(
- self._service_resource, self._session).document_resource(
- section)
+ self._service_resource, self._session
+ ).document_resource(section)
def _document_resources(self, section):
temp_identifier_value = 'foo'
loader = self._session.get_component('data_loader')
json_resource_model = loader.load_service_model(
- self._service_name, 'resources-1')
+ self._service_name, 'resources-1'
+ )
service_model = self._service_resource.meta.client.meta.service_model
for resource_name in json_resource_model['resources']:
resource_model = json_resource_model['resources'][resource_name]
- resource_cls = self._boto3_session.resource_factory.\
- load_from_definition(
+ resource_cls = (
+ self._boto3_session.resource_factory.load_from_definition(
resource_name=resource_name,
single_resource_json_definition=resource_model,
service_context=ServiceContext(
service_name=self._service_name,
resource_json_definitions=json_resource_model[
- 'resources'],
+ 'resources'
+ ],
service_model=service_model,
- service_waiter_model=None
- )
+ service_waiter_model=None,
+ ),
)
+ )
identifiers = resource_cls.meta.resource_model.identifiers
args = []
for _ in identifiers:
args.append(temp_identifier_value)
resource = resource_cls(*args, client=self._client)
- ResourceDocumenter(
- resource, self._session).document_resource(
- section.add_new_section(resource.meta.resource_model.name))
+ ResourceDocumenter(resource, self._session).document_resource(
+ section.add_new_section(resource.meta.resource_model.name)
+ )
def _get_example_file(self):
return os.path.realpath(
- os.path.join(self.EXAMPLE_PATH,
- self._service_name + '.rst'))
+ os.path.join(self.EXAMPLE_PATH, self._service_name + '.rst')
+ )
def _document_examples(self, section):
examples_file = self._get_example_file()
@@ -127,5 +130,5 @@ class ServiceDocumenter(BaseServiceDocumenter):
section.write(".. contents::\n :local:\n :depth: 1")
section.style.new_line()
section.style.new_line()
- with open(examples_file, 'r') as f:
+ with open(examples_file) as f:
section.write(f.read())
diff --git a/contrib/python/boto3/py3/boto3/docs/subresource.py b/contrib/python/boto3/py3/boto3/docs/subresource.py
index d0685fa1df..e22311c814 100644
--- a/contrib/python/boto3/py3/boto3/docs/subresource.py
+++ b/contrib/python/boto3/py3/boto3/docs/subresource.py
@@ -14,10 +14,12 @@ from botocore import xform_name
from botocore.utils import get_service_module_name
from boto3.docs.base import BaseDocumenter
-from boto3.docs.utils import get_identifier_args_for_signature
-from boto3.docs.utils import get_identifier_values_for_example
-from boto3.docs.utils import get_identifier_description
-from boto3.docs.utils import add_resource_type_overview
+from boto3.docs.utils import (
+ add_resource_type_overview,
+ get_identifier_args_for_signature,
+ get_identifier_description,
+ get_identifier_values_for_example,
+)
class SubResourceDocumenter(BaseDocumenter):
@@ -28,11 +30,13 @@ class SubResourceDocumenter(BaseDocumenter):
description=(
'Sub-resources are methods that create a new instance of a'
' child resource. This resource\'s identifiers get passed'
- ' along to the child.'),
- intro_link='subresources_intro')
+ ' along to the child.'
+ ),
+ intro_link='subresources_intro',
+ )
sub_resources = sorted(
self._resource.meta.resource_model.subresources,
- key=lambda sub_resource: sub_resource.name
+ key=lambda sub_resource: sub_resource.name,
)
sub_resources_list = []
self.member_map['sub-resources'] = sub_resources_list
@@ -43,12 +47,17 @@ class SubResourceDocumenter(BaseDocumenter):
section=sub_resource_section,
resource_name=self._resource_name,
sub_resource_model=sub_resource,
- service_model=self._service_model
+ service_model=self._service_model,
)
-def document_sub_resource(section, resource_name, sub_resource_model,
- service_model, include_signature=True):
+def document_sub_resource(
+ section,
+ resource_name,
+ sub_resource_model,
+ service_model,
+ include_signature=True,
+):
"""Documents a resource action
:param section: The section to write to
@@ -70,21 +79,22 @@ def document_sub_resource(section, resource_name, sub_resource_model,
if include_signature:
signature_args = get_identifier_args_for_signature(identifiers_needed)
section.style.start_sphinx_py_method(
- sub_resource_model.name, signature_args)
+ sub_resource_model.name, signature_args
+ )
- method_intro_section = section.add_new_section(
- 'method-intro')
- description = 'Creates a %s resource.' % sub_resource_model.resource.type
+ method_intro_section = section.add_new_section('method-intro')
+ description = f'Creates a {sub_resource_model.resource.type} resource.'
method_intro_section.include_doc_string(description)
example_section = section.add_new_section('example')
example_values = get_identifier_values_for_example(identifiers_needed)
example_resource_name = xform_name(resource_name)
if service_model.service_name == resource_name:
example_resource_name = resource_name
- example = '%s = %s.%s(%s)' % (
+ example = '{} = {}.{}({})'.format(
xform_name(sub_resource_model.resource.type),
example_resource_name,
- sub_resource_model.name, example_values
+ sub_resource_model.name,
+ example_values,
)
example_section.style.start_codeblock()
example_section.write(example)
@@ -93,20 +103,23 @@ def document_sub_resource(section, resource_name, sub_resource_model,
param_section = section.add_new_section('params')
for identifier in identifiers_needed:
description = get_identifier_description(
- sub_resource_model.name, identifier)
- param_section.write(':type %s: string' % identifier)
+ sub_resource_model.name, identifier
+ )
+ param_section.write(f':type {identifier}: string')
param_section.style.new_line()
- param_section.write(':param %s: %s' % (
- identifier, description))
+ param_section.write(f':param {identifier}: {description}')
param_section.style.new_line()
return_section = section.add_new_section('return')
return_section.style.new_line()
return_section.write(
- ':rtype: :py:class:`%s.%s`' % (
+ ':rtype: :py:class:`{}.{}`'.format(
get_service_module_name(service_model),
- sub_resource_model.resource.type))
+ sub_resource_model.resource.type,
+ )
+ )
return_section.style.new_line()
return_section.write(
- ':returns: A %s resource' % sub_resource_model.resource.type)
+ f':returns: A {sub_resource_model.resource.type} resource'
+ )
return_section.style.new_line()
diff --git a/contrib/python/boto3/py3/boto3/docs/utils.py b/contrib/python/boto3/py3/boto3/docs/utils.py
index 60ad419bd6..13a098dd61 100644
--- a/contrib/python/boto3/py3/boto3/docs/utils.py
+++ b/contrib/python/boto3/py3/boto3/docs/utils.py
@@ -14,8 +14,6 @@ import inspect
import jmespath
-from botocore.compat import six
-
def get_resource_ignore_params(params):
"""Helper method to determine which parameters to ignore for actions
@@ -39,10 +37,7 @@ def get_resource_ignore_params(params):
def is_resource_action(action_handle):
- if six.PY3:
- return inspect.isfunction(action_handle)
- else:
- return inspect.ismethod(action_handle)
+ return inspect.isfunction(action_handle)
def get_resource_public_actions(resource_class):
@@ -58,8 +53,7 @@ def get_resource_public_actions(resource_class):
def get_identifier_values_for_example(identifier_names):
- example_values = ['\'%s\'' % identifier for identifier in identifier_names]
- return ','.join(example_values)
+ return ','.join([f'\'{identifier}\'' for identifier in identifier_names])
def get_identifier_args_for_signature(identifier_names):
@@ -67,12 +61,15 @@ def get_identifier_args_for_signature(identifier_names):
def get_identifier_description(resource_name, identifier_name):
- return "The %s's %s identifier. This **must** be set." % (
- resource_name, identifier_name)
+ return (
+ f"The {resource_name}'s {identifier_name} identifier. "
+ f"This **must** be set."
+ )
-def add_resource_type_overview(section, resource_type, description,
- intro_link=None):
+def add_resource_type_overview(
+ section, resource_type, description, intro_link=None
+):
section.style.new_line()
section.write('.. rst-class:: admonition-title')
section.style.new_line()
@@ -83,22 +80,25 @@ def add_resource_type_overview(section, resource_type, description,
section.write(description)
section.style.new_line()
if intro_link is not None:
- section.write('For more information about %s refer to the '
- ':ref:`Resources Introduction Guide<%s>`.' % (
- resource_type.lower(), intro_link))
+ section.write(
+ f'For more information about {resource_type.lower()} refer to the '
+ f':ref:`Resources Introduction Guide<{intro_link}>`.'
+ )
section.style.new_line()
-class DocumentModifiedShape(object):
- def __init__(self, shape_name, new_type, new_description,
- new_example_value):
+class DocumentModifiedShape:
+ def __init__(
+ self, shape_name, new_type, new_description, new_example_value
+ ):
self._shape_name = shape_name
self._new_type = new_type
self._new_description = new_description
self._new_example_value = new_example_value
- def replace_documentation_for_matching_shape(self, event_name, section,
- **kwargs):
+ def replace_documentation_for_matching_shape(
+ self, event_name, section, **kwargs
+ ):
if self._shape_name == section.context.get('shape'):
self._replace_documentation(event_name, section)
for section_name in section.available_sections:
@@ -107,23 +107,31 @@ class DocumentModifiedShape(object):
self._replace_documentation(event_name, sub_section)
else:
self.replace_documentation_for_matching_shape(
- event_name, sub_section)
+ event_name, sub_section
+ )
def _replace_documentation(self, event_name, section):
- if event_name.startswith('docs.request-example') or \
- event_name.startswith('docs.response-example'):
+ if event_name.startswith(
+ 'docs.request-example'
+ ) or event_name.startswith('docs.response-example'):
section.remove_all_sections()
section.clear_text()
section.write(self._new_example_value)
- if event_name.startswith('docs.request-params') or \
- event_name.startswith('docs.response-params'):
+ if event_name.startswith(
+ 'docs.request-params'
+ ) or event_name.startswith('docs.response-params'):
+ allowed_sections = (
+ 'param-name',
+ 'param-documentation',
+ 'end-structure',
+ 'param-type',
+ 'end-param',
+ )
for section_name in section.available_sections:
# Delete any extra members as a new shape is being
# used.
- if section_name not in ['param-name', 'param-documentation',
- 'end-structure', 'param-type',
- 'end-param']:
+ if section_name not in allowed_sections:
section.delete_section(section_name)
# Update the documentation
@@ -135,8 +143,7 @@ class DocumentModifiedShape(object):
type_section = section.get_section('param-type')
if type_section.getvalue().decode('utf-8').startswith(':type'):
type_section.clear_text()
- type_section.write(':type %s: %s' % (
- section.name, self._new_type))
+ type_section.write(f':type {section.name}: {self._new_type}')
else:
type_section.clear_text()
- type_section.style.italics('(%s) -- ' % self._new_type)
+ type_section.style.italics(f'({self._new_type}) -- ')
diff --git a/contrib/python/boto3/py3/boto3/docs/waiter.py b/contrib/python/boto3/py3/boto3/docs/waiter.py
index 38da4d80e8..255d850bc3 100644
--- a/contrib/python/boto3/py3/boto3/docs/waiter.py
+++ b/contrib/python/boto3/py3/boto3/docs/waiter.py
@@ -11,17 +11,19 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from botocore import xform_name
-from botocore.utils import get_service_module_name
from botocore.docs.method import document_model_driven_method
+from botocore.utils import get_service_module_name
from boto3.docs.base import BaseDocumenter
-from boto3.docs.utils import get_resource_ignore_params
-from boto3.docs.utils import add_resource_type_overview
+from boto3.docs.utils import (
+ add_resource_type_overview,
+ get_resource_ignore_params,
+)
class WaiterResourceDocumenter(BaseDocumenter):
def __init__(self, resource, service_waiter_model):
- super(WaiterResourceDocumenter, self).__init__(resource)
+ super().__init__(resource)
self._service_waiter_model = service_waiter_model
def document_resource_waiters(self, section):
@@ -31,8 +33,10 @@ class WaiterResourceDocumenter(BaseDocumenter):
resource_type='Waiters',
description=(
'Waiters provide an interface to wait for a resource'
- ' to reach a specific state.'),
- intro_link='waiters_intro')
+ ' to reach a specific state.'
+ ),
+ intro_link='waiters_intro',
+ )
waiter_list = []
self.member_map['waiters'] = waiter_list
for waiter in waiters:
@@ -44,42 +48,54 @@ class WaiterResourceDocumenter(BaseDocumenter):
event_emitter=self._resource.meta.client.meta.events,
service_model=self._service_model,
resource_waiter_model=waiter,
- service_waiter_model=self._service_waiter_model
+ service_waiter_model=self._service_waiter_model,
)
-def document_resource_waiter(section, resource_name, event_emitter,
- service_model, resource_waiter_model,
- service_waiter_model, include_signature=True):
+def document_resource_waiter(
+ section,
+ resource_name,
+ event_emitter,
+ service_model,
+ resource_waiter_model,
+ service_waiter_model,
+ include_signature=True,
+):
waiter_model = service_waiter_model.get_waiter(
- resource_waiter_model.waiter_name)
- operation_model = service_model.operation_model(
- waiter_model.operation)
+ resource_waiter_model.waiter_name
+ )
+ operation_model = service_model.operation_model(waiter_model.operation)
ignore_params = get_resource_ignore_params(resource_waiter_model.params)
service_module_name = get_service_module_name(service_model)
description = (
- 'Waits until this %s is %s. This method calls '
- ':py:meth:`%s.Waiter.%s.wait` which polls. '
- ':py:meth:`%s.Client.%s` every %s seconds until '
+ 'Waits until this {} is {}. This method calls '
+ ':py:meth:`{}.Waiter.{}.wait` which polls. '
+ ':py:meth:`{}.Client.{}` every {} seconds until '
'a successful state is reached. An error is returned '
- 'after %s failed checks.' % (
- resource_name, ' '.join(resource_waiter_model.name.split('_')[2:]),
+ 'after {} failed checks.'.format(
+ resource_name,
+ ' '.join(resource_waiter_model.name.split('_')[2:]),
service_module_name,
xform_name(resource_waiter_model.waiter_name),
service_module_name,
xform_name(waiter_model.operation),
- waiter_model.delay, waiter_model.max_attempts))
- example_prefix = '%s.%s' % (
- xform_name(resource_name), resource_waiter_model.name)
+ waiter_model.delay,
+ waiter_model.max_attempts,
+ )
+ )
+ example_prefix = '{}.{}'.format(
+ xform_name(resource_name), resource_waiter_model.name
+ )
document_model_driven_method(
- section=section, method_name=resource_waiter_model.name,
+ section=section,
+ method_name=resource_waiter_model.name,
operation_model=operation_model,
event_emitter=event_emitter,
example_prefix=example_prefix,
method_description=description,
exclude_input=ignore_params,
- include_signature=include_signature
+ include_signature=include_signature,
)
if 'return' in section.available_sections:
# Waiters do not return anything so we should remove
diff --git a/contrib/python/boto3/py3/boto3/dynamodb/conditions.py b/contrib/python/boto3/py3/boto3/dynamodb/conditions.py
index 41850b14b7..442f11c4cd 100644
--- a/contrib/python/boto3/py3/boto3/dynamodb/conditions.py
+++ b/contrib/python/boto3/py3/boto3/dynamodb/conditions.py
@@ -10,18 +10,19 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-from collections import namedtuple
import re
+from collections import namedtuple
-from boto3.exceptions import DynamoDBOperationNotSupportedError
-from boto3.exceptions import DynamoDBNeedsConditionError
-from boto3.exceptions import DynamoDBNeedsKeyConditionError
-
+from boto3.exceptions import (
+ DynamoDBNeedsConditionError,
+ DynamoDBNeedsKeyConditionError,
+ DynamoDBOperationNotSupportedError,
+)
ATTR_NAME_REGEX = re.compile(r'[^.\[\]]+(?![^\[]*\])')
-class ConditionBase(object):
+class ConditionBase:
expression_format = ''
expression_operator = ''
@@ -44,9 +45,11 @@ class ConditionBase(object):
return Not(self)
def get_expression(self):
- return {'format': self.expression_format,
- 'operator': self.expression_operator,
- 'values': self._values}
+ return {
+ 'format': self.expression_format,
+ 'operator': self.expression_operator,
+ 'values': self._values,
+ }
def __eq__(self, other):
if isinstance(other, type(self)):
@@ -58,7 +61,7 @@ class ConditionBase(object):
return not self.__eq__(other)
-class AttributeBase(object):
+class AttributeBase:
def __init__(self, name):
self.name = name
@@ -137,6 +140,7 @@ class ConditionAttributeBase(ConditionBase, AttributeBase):
One example is the Size condition. To complete a condition, you need
to apply another AttributeBase method like eq().
"""
+
def __init__(self, *values):
ConditionBase.__init__(self, *values)
# This is assuming the first value to the condition is the attribute
@@ -144,8 +148,8 @@ class ConditionAttributeBase(ConditionBase, AttributeBase):
AttributeBase.__init__(self, values[0].name)
def __eq__(self, other):
- return (
- ConditionBase.__eq__(self, other) and AttributeBase.__eq__(self, other)
+ return ConditionBase.__eq__(self, other) and AttributeBase.__eq__(
+ self, other
)
def __ne__(self, other):
@@ -241,6 +245,7 @@ class Key(AttributeBase):
class Attr(AttributeBase):
"""Represents an DynamoDB item's attribute."""
+
def ne(self, value):
"""Creates a condition where the attribute is not equal to the value
@@ -289,13 +294,17 @@ class Attr(AttributeBase):
BuiltConditionExpression = namedtuple(
'BuiltConditionExpression',
- ['condition_expression', 'attribute_name_placeholders',
- 'attribute_value_placeholders']
+ [
+ 'condition_expression',
+ 'attribute_name_placeholders',
+ 'attribute_value_placeholders',
+ ],
)
-class ConditionExpressionBuilder(object):
+class ConditionExpressionBuilder:
"""This class is used to build condition expressions with placeholders"""
+
def __init__(self):
self._name_count = 0
self._value_count = 0
@@ -337,56 +346,79 @@ class ConditionExpressionBuilder(object):
attribute_name_placeholders = {}
attribute_value_placeholders = {}
condition_expression = self._build_expression(
- condition, attribute_name_placeholders,
- attribute_value_placeholders, is_key_condition=is_key_condition)
+ condition,
+ attribute_name_placeholders,
+ attribute_value_placeholders,
+ is_key_condition=is_key_condition,
+ )
return BuiltConditionExpression(
condition_expression=condition_expression,
attribute_name_placeholders=attribute_name_placeholders,
- attribute_value_placeholders=attribute_value_placeholders
+ attribute_value_placeholders=attribute_value_placeholders,
)
- def _build_expression(self, condition, attribute_name_placeholders,
- attribute_value_placeholders, is_key_condition):
+ def _build_expression(
+ self,
+ condition,
+ attribute_name_placeholders,
+ attribute_value_placeholders,
+ is_key_condition,
+ ):
expression_dict = condition.get_expression()
replaced_values = []
for value in expression_dict['values']:
# Build the necessary placeholders for that value.
# Placeholders are built for both attribute names and values.
replaced_value = self._build_expression_component(
- value, attribute_name_placeholders,
- attribute_value_placeholders, condition.has_grouped_values,
- is_key_condition)
+ value,
+ attribute_name_placeholders,
+ attribute_value_placeholders,
+ condition.has_grouped_values,
+ is_key_condition,
+ )
replaced_values.append(replaced_value)
# Fill out the expression using the operator and the
# values that have been replaced with placeholders.
return expression_dict['format'].format(
- *replaced_values, operator=expression_dict['operator'])
+ *replaced_values, operator=expression_dict['operator']
+ )
- def _build_expression_component(self, value, attribute_name_placeholders,
- attribute_value_placeholders,
- has_grouped_values, is_key_condition):
+ def _build_expression_component(
+ self,
+ value,
+ attribute_name_placeholders,
+ attribute_value_placeholders,
+ has_grouped_values,
+ is_key_condition,
+ ):
# Continue to recurse if the value is a ConditionBase in order
# to extract out all parts of the expression.
if isinstance(value, ConditionBase):
return self._build_expression(
- value, attribute_name_placeholders,
- attribute_value_placeholders, is_key_condition)
+ value,
+ attribute_name_placeholders,
+ attribute_value_placeholders,
+ is_key_condition,
+ )
# If it is not a ConditionBase, we can recurse no further.
# So we check if it is an attribute and add placeholders for
# its name
elif isinstance(value, AttributeBase):
if is_key_condition and not isinstance(value, Key):
raise DynamoDBNeedsKeyConditionError(
- 'Attribute object %s is of type %s. '
- 'KeyConditionExpression only supports Attribute objects '
- 'of type Key' % (value.name, type(value)))
+ f'Attribute object {value.name} is of type {type(value)}. '
+ f'KeyConditionExpression only supports Attribute objects '
+ f'of type Key'
+ )
return self._build_name_placeholder(
- value, attribute_name_placeholders)
+ value, attribute_name_placeholders
+ )
# If it is anything else, we treat it as a value and thus placeholders
# are needed for the value.
else:
return self._build_value_placeholder(
- value, attribute_value_placeholders, has_grouped_values)
+ value, attribute_value_placeholders, has_grouped_values
+ )
def _build_name_placeholder(self, value, attribute_name_placeholders):
attribute_name = value.name
@@ -405,8 +437,9 @@ class ConditionExpressionBuilder(object):
# Replace the temporary placeholders with the designated placeholders.
return placeholder_format % tuple(str_format_args)
- def _build_value_placeholder(self, value, attribute_value_placeholders,
- has_grouped_values=False):
+ def _build_value_placeholder(
+ self, value, attribute_value_placeholders, has_grouped_values=False
+ ):
# If the values are grouped, we need to add a placeholder for
# each element inside of the actual value.
if has_grouped_values:
diff --git a/contrib/python/boto3/py3/boto3/dynamodb/table.py b/contrib/python/boto3/py3/boto3/dynamodb/table.py
index f2dd653334..d96ec8f5ee 100644
--- a/contrib/python/boto3/py3/boto3/dynamodb/table.py
+++ b/contrib/python/boto3/py3/boto3/dynamodb/table.py
@@ -12,7 +12,6 @@
# language governing permissions and limitations under the License.
import logging
-
logger = logging.getLogger(__name__)
@@ -25,9 +24,9 @@ def register_table_methods(base_classes, **kwargs):
# base class for every method we can just update this
# class instead. Just be sure to move the bulk of the
# actual method implementation to another class.
-class TableResource(object):
+class TableResource:
def __init__(self, *args, **kwargs):
- super(TableResource, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
def batch_writer(self, overwrite_by_pkeys=None):
"""Create a batch writer object.
@@ -56,14 +55,17 @@ class TableResource(object):
``["partition_key1", "sort_key2", "sort_key3"]``
"""
- return BatchWriter(self.name, self.meta.client,
- overwrite_by_pkeys=overwrite_by_pkeys)
+ return BatchWriter(
+ self.name, self.meta.client, overwrite_by_pkeys=overwrite_by_pkeys
+ )
-class BatchWriter(object):
+class BatchWriter:
"""Automatically handle batch writes to DynamoDB for a single table."""
- def __init__(self, table_name, client, flush_amount=25,
- overwrite_by_pkeys=None):
+
+ def __init__(
+ self, table_name, client, flush_amount=25, overwrite_by_pkeys=None
+ ):
"""
:type table_name: str
@@ -114,16 +116,22 @@ class BatchWriter(object):
for item in self._items_buffer:
if self._extract_pkey_values(item) == pkey_values_new:
self._items_buffer.remove(item)
- logger.debug("With overwrite_by_pkeys enabled, skipping "
- "request:%s", item)
+ logger.debug(
+ "With overwrite_by_pkeys enabled, skipping " "request:%s",
+ item,
+ )
def _extract_pkey_values(self, request):
if request.get('PutRequest'):
- return [request['PutRequest']['Item'][key]
- for key in self._overwrite_by_pkeys]
+ return [
+ request['PutRequest']['Item'][key]
+ for key in self._overwrite_by_pkeys
+ ]
elif request.get('DeleteRequest'):
- return [request['DeleteRequest']['Key'][key]
- for key in self._overwrite_by_pkeys]
+ return [
+ request['DeleteRequest']['Key'][key]
+ for key in self._overwrite_by_pkeys
+ ]
return None
def _flush_if_needed(self):
@@ -131,10 +139,11 @@ class BatchWriter(object):
self._flush()
def _flush(self):
- items_to_send = self._items_buffer[:self._flush_amount]
- self._items_buffer = self._items_buffer[self._flush_amount:]
+ items_to_send = self._items_buffer[: self._flush_amount]
+ self._items_buffer = self._items_buffer[self._flush_amount :]
response = self._client.batch_write_item(
- RequestItems={self._table_name: items_to_send})
+ RequestItems={self._table_name: items_to_send}
+ )
unprocessed_items = response['UnprocessedItems']
if unprocessed_items and unprocessed_items[self._table_name]:
@@ -143,8 +152,11 @@ class BatchWriter(object):
self._items_buffer.extend(unprocessed_items[self._table_name])
else:
self._items_buffer = []
- logger.debug("Batch write sent %s, unprocessed: %s",
- len(items_to_send), len(self._items_buffer))
+ logger.debug(
+ "Batch write sent %s, unprocessed: %s",
+ len(items_to_send),
+ len(self._items_buffer),
+ )
def __enter__(self):
return self
diff --git a/contrib/python/boto3/py3/boto3/dynamodb/transform.py b/contrib/python/boto3/py3/boto3/dynamodb/transform.py
index cc94280262..eef3aae625 100644
--- a/contrib/python/boto3/py3/boto3/dynamodb/transform.py
+++ b/contrib/python/boto3/py3/boto3/dynamodb/transform.py
@@ -13,10 +13,9 @@
import copy
from boto3.compat import collections_abc
-from boto3.dynamodb.types import TypeSerializer, TypeDeserializer
-from boto3.dynamodb.conditions import ConditionBase
-from boto3.dynamodb.conditions import ConditionExpressionBuilder
from boto3.docs.utils import DocumentModifiedShape
+from boto3.dynamodb.conditions import ConditionBase, ConditionExpressionBuilder
+from boto3.dynamodb.types import TypeDeserializer, TypeSerializer
def register_high_level_interface(base_classes, **kwargs):
@@ -27,16 +26,16 @@ def copy_dynamodb_params(params, **kwargs):
return copy.deepcopy(params)
-class DynamoDBHighLevelResource(object):
+class DynamoDBHighLevelResource:
def __init__(self, *args, **kwargs):
- super(DynamoDBHighLevelResource, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
# Apply handler that creates a copy of the user provided dynamodb
# item such that it can be modified.
self.meta.client.meta.events.register(
'provide-client-params.dynamodb',
copy_dynamodb_params,
- unique_id='dynamodb-create-params-copy'
+ unique_id='dynamodb-create-params-copy',
)
self._injector = TransformationInjector()
@@ -45,21 +44,24 @@ class DynamoDBHighLevelResource(object):
self.meta.client.meta.events.register(
'before-parameter-build.dynamodb',
self._injector.inject_condition_expressions,
- unique_id='dynamodb-condition-expression')
+ unique_id='dynamodb-condition-expression',
+ )
# Apply the handler that serializes the request from python
# types to dynamodb types.
self.meta.client.meta.events.register(
'before-parameter-build.dynamodb',
self._injector.inject_attribute_value_input,
- unique_id='dynamodb-attr-value-input')
+ unique_id='dynamodb-attr-value-input',
+ )
# Apply the handler that deserializes the response from dynamodb
# types to python types.
self.meta.client.meta.events.register(
'after-call.dynamodb',
self._injector.inject_attribute_value_output,
- unique_id='dynamodb-attr-value-output')
+ unique_id='dynamodb-attr-value-output',
+ )
# Apply the documentation customizations to account for
# the transformations.
@@ -73,7 +75,8 @@ class DynamoDBHighLevelResource(object):
),
new_example_value=(
'\'string\'|123|Binary(b\'bytes\')|True|None|set([\'string\'])'
- '|set([123])|set([Binary(b\'bytes\')])|[]|{}')
+ '|set([123])|set([Binary(b\'bytes\')])|[]|{}'
+ ),
)
key_expression_shape_docs = DocumentModifiedShape(
@@ -87,7 +90,7 @@ class DynamoDBHighLevelResource(object):
'listed in the '
':ref:`DynamoDB Reference Guide<ref_dynamodb_conditions>`.'
),
- new_example_value='Key(\'mykey\').eq(\'myvalue\')'
+ new_example_value='Key(\'mykey\').eq(\'myvalue\')',
)
con_expression_shape_docs = DocumentModifiedShape(
@@ -101,29 +104,38 @@ class DynamoDBHighLevelResource(object):
'are listed in the '
':ref:`DynamoDB Reference Guide<ref_dynamodb_conditions>`.'
),
- new_example_value='Attr(\'myattribute\').eq(\'myvalue\')'
+ new_example_value='Attr(\'myattribute\').eq(\'myvalue\')',
)
self.meta.client.meta.events.register(
'docs.*.dynamodb.*.complete-section',
attr_value_shape_docs.replace_documentation_for_matching_shape,
- unique_id='dynamodb-attr-value-docs')
+ unique_id='dynamodb-attr-value-docs',
+ )
self.meta.client.meta.events.register(
'docs.*.dynamodb.*.complete-section',
key_expression_shape_docs.replace_documentation_for_matching_shape,
- unique_id='dynamodb-key-expression-docs')
+ unique_id='dynamodb-key-expression-docs',
+ )
self.meta.client.meta.events.register(
'docs.*.dynamodb.*.complete-section',
con_expression_shape_docs.replace_documentation_for_matching_shape,
- unique_id='dynamodb-cond-expression-docs')
+ unique_id='dynamodb-cond-expression-docs',
+ )
-class TransformationInjector(object):
+class TransformationInjector:
"""Injects the transformations into the user provided parameters."""
- def __init__(self, transformer=None, condition_builder=None,
- serializer=None, deserializer=None):
+
+ def __init__(
+ self,
+ transformer=None,
+ condition_builder=None,
+ serializer=None,
+ deserializer=None,
+ ):
self._transformer = transformer
if transformer is None:
self._transformer = ParameterTransformer()
@@ -156,22 +168,22 @@ class TransformationInjector(object):
self._condition_builder,
placeholder_names=generated_names,
placeholder_values=generated_values,
- is_key_condition=False
+ is_key_condition=False,
)
self._transformer.transform(
- params, model.input_shape, transformation,
- 'ConditionExpression')
+ params, model.input_shape, transformation, 'ConditionExpression'
+ )
# Create and apply the Key Condition Expression transformation.
transformation = ConditionExpressionTransformation(
self._condition_builder,
placeholder_names=generated_names,
placeholder_values=generated_values,
- is_key_condition=True
+ is_key_condition=True,
)
self._transformer.transform(
- params, model.input_shape, transformation,
- 'KeyExpression')
+ params, model.input_shape, transformation, 'KeyExpression'
+ )
expr_attr_names_input = 'ExpressionAttributeNames'
expr_attr_values_input = 'ExpressionAttributeValues'
@@ -193,26 +205,37 @@ class TransformationInjector(object):
def inject_attribute_value_input(self, params, model, **kwargs):
"""Injects DynamoDB serialization into parameter input"""
self._transformer.transform(
- params, model.input_shape, self._serializer.serialize,
- 'AttributeValue')
+ params,
+ model.input_shape,
+ self._serializer.serialize,
+ 'AttributeValue',
+ )
def inject_attribute_value_output(self, parsed, model, **kwargs):
"""Injects DynamoDB deserialization into responses"""
if model.output_shape is not None:
self._transformer.transform(
- parsed, model.output_shape, self._deserializer.deserialize,
- 'AttributeValue'
+ parsed,
+ model.output_shape,
+ self._deserializer.deserialize,
+ 'AttributeValue',
)
-class ConditionExpressionTransformation(object):
+class ConditionExpressionTransformation:
"""Provides a transformation for condition expressions
The ``ParameterTransformer`` class can call this class directly
to transform the condition expressions in the parameters provided.
"""
- def __init__(self, condition_builder, placeholder_names,
- placeholder_values, is_key_condition=False):
+
+ def __init__(
+ self,
+ condition_builder,
+ placeholder_names,
+ placeholder_values,
+ is_key_condition=False,
+ ):
self._condition_builder = condition_builder
self._placeholder_names = placeholder_names
self._placeholder_values = placeholder_values
@@ -223,19 +246,22 @@ class ConditionExpressionTransformation(object):
# Create a conditional expression string with placeholders
# for the provided condition.
built_expression = self._condition_builder.build_expression(
- value, is_key_condition=self._is_key_condition)
+ value, is_key_condition=self._is_key_condition
+ )
self._placeholder_names.update(
- built_expression.attribute_name_placeholders)
+ built_expression.attribute_name_placeholders
+ )
self._placeholder_values.update(
- built_expression.attribute_value_placeholders)
+ built_expression.attribute_value_placeholders
+ )
return built_expression.condition_expression
# Use the user provided value if it is not a ConditonBase object.
return value
-class ParameterTransformer(object):
+class ParameterTransformer:
"""Transforms the input to and output from botocore based on shape"""
def transform(self, params, model, transformation, target_shape):
@@ -250,18 +276,20 @@ class ParameterTransformer(object):
:param target_shape: The name of the shape to apply the
transformation to
"""
- self._transform_parameters(
- model, params, transformation, target_shape)
+ self._transform_parameters(model, params, transformation, target_shape)
- def _transform_parameters(self, model, params, transformation,
- target_shape):
+ def _transform_parameters(
+ self, model, params, transformation, target_shape
+ ):
type_name = model.type_name
- if type_name in ['structure', 'map', 'list']:
- getattr(self, '_transform_%s' % type_name)(
- model, params, transformation, target_shape)
+ if type_name in ('structure', 'map', 'list'):
+ getattr(self, f'_transform_{type_name}')(
+ model, params, transformation, target_shape
+ )
- def _transform_structure(self, model, params, transformation,
- target_shape):
+ def _transform_structure(
+ self, model, params, transformation, target_shape
+ ):
if not isinstance(params, collections_abc.Mapping):
return
for param in params:
@@ -272,8 +300,11 @@ class ParameterTransformer(object):
params[param] = transformation(params[param])
else:
self._transform_parameters(
- member_model, params[param], transformation,
- target_shape)
+ member_model,
+ params[param],
+ transformation,
+ target_shape,
+ )
def _transform_map(self, model, params, transformation, target_shape):
if not isinstance(params, collections_abc.Mapping):
@@ -285,7 +316,8 @@ class ParameterTransformer(object):
params[key] = transformation(value)
else:
self._transform_parameters(
- value_model, params[key], transformation, target_shape)
+ value_model, params[key], transformation, target_shape
+ )
def _transform_list(self, model, params, transformation, target_shape):
if not isinstance(params, collections_abc.MutableSequence):
@@ -297,4 +329,5 @@ class ParameterTransformer(object):
params[i] = transformation(item)
else:
self._transform_parameters(
- member_model, params[i], transformation, target_shape)
+ member_model, params[i], transformation, target_shape
+ )
diff --git a/contrib/python/boto3/py3/boto3/dynamodb/types.py b/contrib/python/boto3/py3/boto3/dynamodb/types.py
index 16721aa639..f696a6d4cf 100644
--- a/contrib/python/boto3/py3/boto3/dynamodb/types.py
+++ b/contrib/python/boto3/py3/boto3/dynamodb/types.py
@@ -10,13 +10,16 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-from decimal import Decimal, Context, Clamped
-from decimal import Overflow, Inexact, Underflow, Rounded
-
-from boto3.compat import collections_abc
-
-from botocore.compat import six
-
+import collections.abc
+from decimal import (
+ Clamped,
+ Context,
+ Decimal,
+ Inexact,
+ Overflow,
+ Rounded,
+ Underflow,
+)
STRING = 'S'
NUMBER = 'N'
@@ -31,24 +34,28 @@ LIST = 'L'
DYNAMODB_CONTEXT = Context(
- Emin=-128, Emax=126, prec=38,
- traps=[Clamped, Overflow, Inexact, Rounded, Underflow])
+ Emin=-128,
+ Emax=126,
+ prec=38,
+ traps=[Clamped, Overflow, Inexact, Rounded, Underflow],
+)
-BINARY_TYPES = (bytearray, six.binary_type)
+BINARY_TYPES = (bytearray, bytes)
-class Binary(object):
+class Binary:
"""A class for representing Binary in dynamodb
Especially for Python 2, use this class to explicitly specify
binary data for item in DynamoDB. It is essentially a wrapper around
binary. Unicode and Python 3 string types are not allowed.
"""
+
def __init__(self, value):
if not isinstance(value, BINARY_TYPES):
- raise TypeError('Value must be of the following types: %s.' %
- ', '.join([str(t) for t in BINARY_TYPES]))
+ types = ', '.join([str(t) for t in BINARY_TYPES])
+ raise TypeError(f'Value must be of the following types: {types}')
self.value = value
def __eq__(self, other):
@@ -60,7 +67,7 @@ class Binary(object):
return not self.__eq__(other)
def __repr__(self):
- return 'Binary(%r)' % self.value
+ return f'Binary({self.value!r})'
def __str__(self):
return self.value
@@ -72,8 +79,9 @@ class Binary(object):
return hash(self.value)
-class TypeSerializer(object):
+class TypeSerializer:
"""This class serializes Python data types to DynamoDB types."""
+
def serialize(self, value):
"""The method to serialize the Python data types.
@@ -103,7 +111,7 @@ class TypeSerializer(object):
dictionaries can be directly passed to botocore methods.
"""
dynamodb_type = self._get_dynamodb_type(value)
- serializer = getattr(self, '_serialize_%s' % dynamodb_type.lower())
+ serializer = getattr(self, f'_serialize_{dynamodb_type}'.lower())
return {dynamodb_type: serializer(value)}
def _get_dynamodb_type(self, value):
@@ -140,7 +148,7 @@ class TypeSerializer(object):
dynamodb_type = LIST
else:
- msg = 'Unsupported type "%s" for value "%s"' % (type(value), value)
+ msg = f'Unsupported type "{type(value)}" for value "{value}"'
raise TypeError(msg)
return dynamodb_type
@@ -156,29 +164,26 @@ class TypeSerializer(object):
return False
def _is_number(self, value):
- if isinstance(value, (six.integer_types, Decimal)):
+ if isinstance(value, (int, Decimal)):
return True
elif isinstance(value, float):
raise TypeError(
- 'Float types are not supported. Use Decimal types instead.')
+ 'Float types are not supported. Use Decimal types instead.'
+ )
return False
def _is_string(self, value):
- if isinstance(value, six.string_types):
+ if isinstance(value, str):
return True
return False
def _is_binary(self, value):
- if isinstance(value, Binary):
- return True
- elif isinstance(value, bytearray):
- return True
- elif six.PY3 and isinstance(value, six.binary_type):
+ if isinstance(value, (Binary, bytearray, bytes)):
return True
return False
def _is_set(self, value):
- if isinstance(value, collections_abc.Set):
+ if isinstance(value, collections.abc.Set):
return True
return False
@@ -189,7 +194,7 @@ class TypeSerializer(object):
return False
def _is_map(self, value):
- if isinstance(value, collections_abc.Mapping):
+ if isinstance(value, collections.abc.Mapping):
return True
return False
@@ -231,11 +236,12 @@ class TypeSerializer(object):
return [self.serialize(v) for v in value]
def _serialize_m(self, value):
- return dict([(k, self.serialize(v)) for k, v in value.items()])
+ return {k: self.serialize(v) for k, v in value.items()}
-class TypeDeserializer(object):
+class TypeDeserializer:
"""This class deserializes DynamoDB types to Python types."""
+
def deserialize(self, value):
"""The method to deserialize the DynamoDB data types.
@@ -259,15 +265,17 @@ class TypeDeserializer(object):
"""
if not value:
- raise TypeError('Value must be a nonempty dictionary whose key '
- 'is a valid dynamodb type.')
+ raise TypeError(
+ 'Value must be a nonempty dictionary whose key '
+ 'is a valid dynamodb type.'
+ )
dynamodb_type = list(value.keys())[0]
try:
deserializer = getattr(
- self, '_deserialize_%s' % dynamodb_type.lower())
+ self, f'_deserialize_{dynamodb_type}'.lower()
+ )
except AttributeError:
- raise TypeError(
- 'Dynamodb type %s is not supported' % dynamodb_type)
+ raise TypeError(f'Dynamodb type {dynamodb_type} is not supported')
return deserializer(value[dynamodb_type])
def _deserialize_null(self, value):
@@ -298,4 +306,4 @@ class TypeDeserializer(object):
return [self.deserialize(v) for v in value]
def _deserialize_m(self, value):
- return dict([(k, self.deserialize(v)) for k, v in value.items()])
+ return {k: self.deserialize(v) for k, v in value.items()}
diff --git a/contrib/python/boto3/py3/boto3/ec2/deletetags.py b/contrib/python/boto3/py3/boto3/ec2/deletetags.py
index ebbbfc99c6..19876d041e 100644
--- a/contrib/python/boto3/py3/boto3/ec2/deletetags.py
+++ b/contrib/python/boto3/py3/boto3/ec2/deletetags.py
@@ -17,15 +17,18 @@ def inject_delete_tags(event_emitter, **kwargs):
action_model = {
'request': {
'operation': 'DeleteTags',
- 'params': [{
- 'target': 'Resources[0]',
- 'source': 'identifier',
- 'name': 'Id'
- }]
+ 'params': [
+ {
+ 'target': 'Resources[0]',
+ 'source': 'identifier',
+ 'name': 'Id',
+ }
+ ],
}
}
action = CustomModeledAction(
- 'delete_tags', action_model, delete_tags, event_emitter)
+ 'delete_tags', action_model, delete_tags, event_emitter
+ )
action.inject(**kwargs)
diff --git a/contrib/python/boto3/py3/boto3/exceptions.py b/contrib/python/boto3/py3/boto3/exceptions.py
index 9120577767..0068de9ced 100644
--- a/contrib/python/boto3/py3/boto3/exceptions.py
+++ b/contrib/python/boto3/py3/boto3/exceptions.py
@@ -35,33 +35,37 @@ class NoVersionFound(Boto3Error):
# this low level Botocore error before this exception was
# introduced in boto3.
# Same thing for ResourceNotExistsError below.
-class UnknownAPIVersionError(Boto3Error,
- botocore.exceptions.DataNotFoundError):
- def __init__(self, service_name, bad_api_version,
- available_api_versions):
+class UnknownAPIVersionError(
+ Boto3Error, botocore.exceptions.DataNotFoundError
+):
+ def __init__(self, service_name, bad_api_version, available_api_versions):
msg = (
- "The '%s' resource does not an API version of: %s\n"
- "Valid API versions are: %s"
- % (service_name, bad_api_version, available_api_versions)
+ f"The '{service_name}' resource does not an API version of: {bad_api_version}\n"
+ f"Valid API versions are: {available_api_versions}"
)
# Not using super because we don't want the DataNotFoundError
# to be called, it has a different __init__ signature.
Boto3Error.__init__(self, msg)
-class ResourceNotExistsError(Boto3Error,
- botocore.exceptions.DataNotFoundError):
+class ResourceNotExistsError(
+ Boto3Error, botocore.exceptions.DataNotFoundError
+):
"""Raised when you attempt to create a resource that does not exist."""
+
def __init__(self, service_name, available_services, has_low_level_client):
msg = (
- "The '%s' resource does not exist.\n"
+ "The '{}' resource does not exist.\n"
"The available resources are:\n"
- " - %s\n" % (service_name, '\n - '.join(available_services))
+ " - {}\n".format(
+ service_name, '\n - '.join(available_services)
+ )
)
if has_low_level_client:
- msg += (
- "\nConsider using a boto3.client('%s') instead "
- "of a resource for '%s'" % (service_name, service_name))
+ msg = (
+ f"{msg}\nConsider using a boto3.client('{service_name}') "
+ f"instead of a resource for '{service_name}'"
+ )
# Not using super because we don't want the DataNotFoundError
# to be called, it has a different __init__ signature.
Boto3Error.__init__(self, msg)
@@ -69,7 +73,7 @@ class ResourceNotExistsError(Boto3Error,
class RetriesExceededError(Boto3Error):
def __init__(self, last_exception, msg='Max Retries Exceeded'):
- super(RetriesExceededError, self).__init__(msg)
+ super().__init__(msg)
self.last_exception = last_exception
@@ -83,12 +87,13 @@ class S3UploadFailedError(Boto3Error):
class DynamoDBOperationNotSupportedError(Boto3Error):
"""Raised for operations that are not supported for an operand."""
+
def __init__(self, operation, value):
msg = (
- '%s operation cannot be applied to value %s of type %s directly. '
- 'Must use AttributeBase object methods (i.e. Attr().eq()). to '
- 'generate ConditionBase instances first.' %
- (operation, value, type(value)))
+ f'{operation} operation cannot be applied to value {value} of type '
+ f'{type(value)} directly. Must use AttributeBase object methods '
+ f'(i.e. Attr().eq()). to generate ConditionBase instances first.'
+ )
Exception.__init__(self, msg)
@@ -98,11 +103,13 @@ DynanmoDBOperationNotSupportedError = DynamoDBOperationNotSupportedError
class DynamoDBNeedsConditionError(Boto3Error):
"""Raised when input is not a condition"""
+
def __init__(self, value):
msg = (
- 'Expecting a ConditionBase object. Got %s of type %s. '
- 'Use AttributeBase object methods (i.e. Attr().eq()). to '
- 'generate ConditionBase instances.' % (value, type(value)))
+ f'Expecting a ConditionBase object. Got {value} of type {type(value)}. '
+ f'Use AttributeBase object methods (i.e. Attr().eq()). to '
+ f'generate ConditionBase instances.'
+ )
Exception.__init__(self, msg)
@@ -115,4 +122,5 @@ class PythonDeprecationWarning(Warning):
Python version being used is scheduled to become unsupported
in an future release. See warning for specifics.
"""
+
pass
diff --git a/contrib/python/boto3/py3/boto3/resources/action.py b/contrib/python/boto3/py3/boto3/resources/action.py
index 3fefe90207..7c7d83922c 100644
--- a/contrib/python/boto3/py3/boto3/resources/action.py
+++ b/contrib/python/boto3/py3/boto3/resources/action.py
@@ -15,18 +15,17 @@ import logging
from botocore import xform_name
-from .params import create_request_parameters
-from .response import RawHandler, ResourceHandler
-from .model import Action
-
from boto3.docs.docstring import ActionDocstring
from boto3.utils import inject_attribute
+from .model import Action
+from .params import create_request_parameters
+from .response import RawHandler, ResourceHandler
logger = logging.getLogger(__name__)
-class ServiceAction(object):
+class ServiceAction:
"""
A class representing a callable action on a resource, for example
``sqs.get_queue_by_name(...)`` or ``s3.Bucket('foo').delete()``.
@@ -43,6 +42,7 @@ class ServiceAction(object):
:type service_context: :py:class:`~boto3.utils.ServiceContext`
:param service_context: Context about the AWS service
"""
+
def __init__(self, action_model, factory=None, service_context=None):
self._action_model = action_model
@@ -52,9 +52,10 @@ class ServiceAction(object):
if resource_response_model:
self._response_handler = ResourceHandler(
search_path=resource_response_model.path,
- factory=factory, resource_model=resource_response_model,
+ factory=factory,
+ resource_model=resource_response_model,
service_context=service_context,
- operation_name=action_model.request.operation
+ operation_name=action_model.request.operation,
)
else:
self._response_handler = RawHandler(action_model.path)
@@ -77,8 +78,12 @@ class ServiceAction(object):
params = create_request_parameters(parent, self._action_model.request)
params.update(kwargs)
- logger.debug('Calling %s:%s with %r', parent.meta.service_name,
- operation_name, params)
+ logger.debug(
+ 'Calling %s:%s with %r',
+ parent.meta.service_name,
+ operation_name,
+ params,
+ )
response = getattr(parent.meta.client, operation_name)(*args, **params)
@@ -105,6 +110,7 @@ class BatchAction(ServiceAction):
:type service_context: :py:class:`~boto3.utils.ServiceContext`
:param service_context: Context about the AWS service
"""
+
def __call__(self, parent, *args, **kwargs):
"""
Perform the batch action's operation on every page of results
@@ -137,8 +143,11 @@ class BatchAction(ServiceAction):
client = resource.meta.client
create_request_parameters(
- resource, self._action_model.request,
- params=params, index=index)
+ resource,
+ self._action_model.request,
+ params=params,
+ index=index,
+ )
if not params:
# There are no items, no need to make a call.
@@ -146,20 +155,20 @@ class BatchAction(ServiceAction):
params.update(kwargs)
- logger.debug('Calling %s:%s with %r',
- service_name, operation_name, params)
+ logger.debug(
+ 'Calling %s:%s with %r', service_name, operation_name, params
+ )
response = getattr(client, operation_name)(*args, **params)
logger.debug('Response: %r', response)
- responses.append(
- self._response_handler(parent, params, response))
+ responses.append(self._response_handler(parent, params, response))
return responses
-class WaiterAction(object):
+class WaiterAction:
"""
A class representing a callable waiter action on a resource, for example
``s3.Bucket('foo').wait_until_bucket_exists()``.
@@ -173,6 +182,7 @@ class WaiterAction(object):
resource. It usually begins with a
``wait_until_``
"""
+
def __init__(self, waiter_model, waiter_resource_name):
self._waiter_model = waiter_model
self._waiter_resource_name = waiter_resource_name
@@ -193,9 +203,12 @@ class WaiterAction(object):
params = create_request_parameters(parent, self._waiter_model)
params.update(kwargs)
- logger.debug('Calling %s:%s with %r',
- parent.meta.service_name,
- self._waiter_resource_name, params)
+ logger.debug(
+ 'Calling %s:%s with %r',
+ parent.meta.service_name,
+ self._waiter_resource_name,
+ params,
+ )
client = parent.meta.client
waiter = client.get_waiter(client_waiter_name)
@@ -204,10 +217,10 @@ class WaiterAction(object):
logger.debug('Response: %r', response)
-class CustomModeledAction(object):
+class CustomModeledAction:
"""A custom, modeled action to inject into a resource."""
- def __init__(self, action_name, action_model,
- function, event_emitter):
+
+ def __init__(self, action_name, action_model, function, event_emitter):
"""
:type action_name: str
:param action_name: The name of the action to inject, e.g.
@@ -239,6 +252,6 @@ class CustomModeledAction(object):
event_emitter=self.emitter,
action_model=action,
service_model=service_context.service_model,
- include_signature=False
+ include_signature=False,
)
inject_attribute(class_attributes, self.name, self.function)
diff --git a/contrib/python/boto3/py3/boto3/resources/base.py b/contrib/python/boto3/py3/boto3/resources/base.py
index b77bd985c6..c398280962 100644
--- a/contrib/python/boto3/py3/boto3/resources/base.py
+++ b/contrib/python/boto3/py3/boto3/resources/base.py
@@ -15,16 +15,22 @@ import logging
import boto3
-
logger = logging.getLogger(__name__)
-class ResourceMeta(object):
+class ResourceMeta:
"""
An object containing metadata about a resource.
"""
- def __init__(self, service_name, identifiers=None, client=None,
- data=None, resource_model=None):
+
+ def __init__(
+ self,
+ service_name,
+ identifiers=None,
+ client=None,
+ data=None,
+ resource_model=None,
+ ):
#: (``string``) The service name, e.g. 's3'
self.service_name = service_name
@@ -42,8 +48,9 @@ class ResourceMeta(object):
self.resource_model = resource_model
def __repr__(self):
- return 'ResourceMeta(\'{0}\', identifiers={1})'.format(
- self.service_name, self.identifiers)
+ return 'ResourceMeta(\'{}\', identifiers={})'.format(
+ self.service_name, self.identifiers
+ )
def __eq__(self, other):
# Two metas are equal if their components are all equal
@@ -61,7 +68,7 @@ class ResourceMeta(object):
return ResourceMeta(service_name, **params)
-class ServiceResource(object):
+class ServiceResource:
"""
A base class for resources.
@@ -108,22 +115,22 @@ class ServiceResource(object):
continue
if name not in self.meta.identifiers:
- raise ValueError('Unknown keyword argument: {0}'.format(name))
+ raise ValueError(f'Unknown keyword argument: {name}')
setattr(self, '_' + name, value)
# Validate that all identifiers have been set.
for identifier in self.meta.identifiers:
if getattr(self, identifier) is None:
- raise ValueError(
- 'Required parameter {0} not set'.format(identifier))
+ raise ValueError(f'Required parameter {identifier} not set')
def __repr__(self):
identifiers = []
for identifier in self.meta.identifiers:
- identifiers.append('{0}={1}'.format(
- identifier, repr(getattr(self, identifier))))
- return "{0}({1})".format(
+ identifiers.append(
+ f'{identifier}={repr(getattr(self, identifier))}'
+ )
+ return "{}({})".format(
self.__class__.__name__,
', '.join(identifiers),
)
diff --git a/contrib/python/boto3/py3/boto3/resources/collection.py b/contrib/python/boto3/py3/boto3/resources/collection.py
index 2118e57738..7f7862ec56 100644
--- a/contrib/python/boto3/py3/boto3/resources/collection.py
+++ b/contrib/python/boto3/py3/boto3/resources/collection.py
@@ -17,16 +17,15 @@ import logging
from botocore import xform_name
from botocore.utils import merge_dicts
+from ..docs import docstring
from .action import BatchAction
from .params import create_request_parameters
from .response import ResourceHandler
-from ..docs import docstring
-
logger = logging.getLogger(__name__)
-class ResourceCollection(object):
+class ResourceCollection:
"""
Represents a collection of resources, which can be iterated through,
optionally with filtering. Collections automatically handle pagination
@@ -43,22 +42,21 @@ class ResourceCollection(object):
:param handler: The resource response handler used to create resource
instances
"""
+
def __init__(self, model, parent, handler, **kwargs):
self._model = model
self._parent = parent
- self._py_operation_name = xform_name(
- model.request.operation)
+ self._py_operation_name = xform_name(model.request.operation)
self._handler = handler
self._params = copy.deepcopy(kwargs)
def __repr__(self):
- return '{0}({1}, {2})'.format(
+ return '{}({}, {})'.format(
self.__class__.__name__,
self._parent,
- '{0}.{1}'.format(
- self._parent.meta.service_name,
- self._model.resource.type
- )
+ '{}.{}'.format(
+ self._parent.meta.service_name, self._model.resource.type
+ ),
)
def __iter__(self):
@@ -109,8 +107,9 @@ class ResourceCollection(object):
"""
params = copy.deepcopy(self._params)
merge_dicts(params, kwargs, append_lists=True)
- clone = self.__class__(self._model, self._parent,
- self._handler, **params)
+ clone = self.__class__(
+ self._model, self._parent, self._handler, **params
+ )
return clone
def pages(self):
@@ -137,8 +136,7 @@ class ResourceCollection(object):
cleaned_params = self._params.copy()
limit = cleaned_params.pop('limit', None)
page_size = cleaned_params.pop('page_size', None)
- params = create_request_parameters(
- self._parent, self._model.request)
+ params = create_request_parameters(self._parent, self._model.request)
merge_dicts(params, cleaned_params, append_lists=True)
# Is this a paginated operation? If so, we need to get an
@@ -147,17 +145,24 @@ class ResourceCollection(object):
# page in a list. For non-paginated results, we just ignore
# the page size parameter.
if client.can_paginate(self._py_operation_name):
- logger.debug('Calling paginated %s:%s with %r',
- self._parent.meta.service_name,
- self._py_operation_name, params)
+ logger.debug(
+ 'Calling paginated %s:%s with %r',
+ self._parent.meta.service_name,
+ self._py_operation_name,
+ params,
+ )
paginator = client.get_paginator(self._py_operation_name)
pages = paginator.paginate(
- PaginationConfig={
- 'MaxItems': limit, 'PageSize': page_size}, **params)
+ PaginationConfig={'MaxItems': limit, 'PageSize': page_size},
+ **params
+ )
else:
- logger.debug('Calling %s:%s with %r',
- self._parent.meta.service_name,
- self._py_operation_name, params)
+ logger.debug(
+ 'Calling %s:%s with %r',
+ self._parent.meta.service_name,
+ self._py_operation_name,
+ params,
+ )
pages = [getattr(client, self._py_operation_name)(**params)]
# Now that we have a page iterator or single page of results
@@ -257,7 +262,7 @@ class ResourceCollection(object):
return self._clone(page_size=count)
-class CollectionManager(object):
+class CollectionManager:
"""
A collection manager provides access to resource collection instances,
which can be iterated and filtered. The manager exposes some
@@ -300,6 +305,7 @@ class CollectionManager(object):
:type service_context: :py:class:`~boto3.utils.ServiceContext`
:param service_context: Context about the AWS service
"""
+
# The class to use when creating an iterator
_collection_cls = ResourceCollection
@@ -310,20 +316,20 @@ class CollectionManager(object):
search_path = collection_model.resource.path
self._handler = ResourceHandler(
- search_path=search_path, factory=factory,
+ search_path=search_path,
+ factory=factory,
resource_model=collection_model.resource,
service_context=service_context,
- operation_name=operation_name
+ operation_name=operation_name,
)
def __repr__(self):
- return '{0}({1}, {2})'.format(
+ return '{}({}, {})'.format(
self.__class__.__name__,
self._parent,
- '{0}.{1}'.format(
- self._parent.meta.service_name,
- self._model.resource.type
- )
+ '{}.{}'.format(
+ self._parent.meta.service_name, self._model.resource.type
+ ),
)
def iterator(self, **kwargs):
@@ -333,40 +339,48 @@ class CollectionManager(object):
:rtype: :py:class:`ResourceCollection`
:return: An iterable representing the collection of resources
"""
- return self._collection_cls(self._model, self._parent,
- self._handler, **kwargs)
+ return self._collection_cls(
+ self._model, self._parent, self._handler, **kwargs
+ )
# Set up some methods to proxy ResourceCollection methods
def all(self):
return self.iterator()
+
all.__doc__ = ResourceCollection.all.__doc__
def filter(self, **kwargs):
return self.iterator(**kwargs)
+
filter.__doc__ = ResourceCollection.filter.__doc__
def limit(self, count):
return self.iterator(limit=count)
+
limit.__doc__ = ResourceCollection.limit.__doc__
def page_size(self, count):
return self.iterator(page_size=count)
+
page_size.__doc__ = ResourceCollection.page_size.__doc__
def pages(self):
return self.iterator().pages()
+
pages.__doc__ = ResourceCollection.pages.__doc__
-class CollectionFactory(object):
+class CollectionFactory:
"""
A factory to create new
:py:class:`CollectionManager` and :py:class:`ResourceCollection`
subclasses from a :py:class:`~boto3.resources.model.Collection`
model. These subclasses include methods to perform batch operations.
"""
- def load_from_definition(self, resource_name, collection_model,
- service_context, event_emitter):
+
+ def load_from_definition(
+ self, resource_name, collection_model, service_context, event_emitter
+ ):
"""
Loads a collection from a model, creating a new
:py:class:`CollectionManager` subclass
@@ -393,40 +407,55 @@ class CollectionFactory(object):
# Create the batch actions for a collection
self._load_batch_actions(
- attrs, resource_name, collection_model,
- service_context.service_model, event_emitter)
+ attrs,
+ resource_name,
+ collection_model,
+ service_context.service_model,
+ event_emitter,
+ )
# Add the documentation to the collection class's methods
self._load_documented_collection_methods(
- attrs=attrs, resource_name=resource_name,
+ attrs=attrs,
+ resource_name=resource_name,
collection_model=collection_model,
service_model=service_context.service_model,
event_emitter=event_emitter,
- base_class=ResourceCollection)
+ base_class=ResourceCollection,
+ )
if service_context.service_name == resource_name:
- cls_name = '{0}.{1}Collection'.format(
- service_context.service_name, collection_name)
+ cls_name = '{}.{}Collection'.format(
+ service_context.service_name, collection_name
+ )
else:
- cls_name = '{0}.{1}.{2}Collection'.format(
- service_context.service_name, resource_name, collection_name)
+ cls_name = '{}.{}.{}Collection'.format(
+ service_context.service_name, resource_name, collection_name
+ )
- collection_cls = type(str(cls_name), (ResourceCollection,),
- attrs)
+ collection_cls = type(str(cls_name), (ResourceCollection,), attrs)
# Add the documentation to the collection manager's methods
self._load_documented_collection_methods(
- attrs=attrs, resource_name=resource_name,
+ attrs=attrs,
+ resource_name=resource_name,
collection_model=collection_model,
service_model=service_context.service_model,
event_emitter=event_emitter,
- base_class=CollectionManager)
+ base_class=CollectionManager,
+ )
attrs['_collection_cls'] = collection_cls
cls_name += 'Manager'
return type(str(cls_name), (CollectionManager,), attrs)
- def _load_batch_actions(self, attrs, resource_name, collection_model,
- service_model, event_emitter):
+ def _load_batch_actions(
+ self,
+ attrs,
+ resource_name,
+ collection_model,
+ service_model,
+ event_emitter,
+ ):
"""
Batch actions on the collection become methods on both
the collection manager and iterators.
@@ -434,12 +463,23 @@ class CollectionFactory(object):
for action_model in collection_model.batch_actions:
snake_cased = xform_name(action_model.name)
attrs[snake_cased] = self._create_batch_action(
- resource_name, snake_cased, action_model, collection_model,
- service_model, event_emitter)
+ resource_name,
+ snake_cased,
+ action_model,
+ collection_model,
+ service_model,
+ event_emitter,
+ )
def _load_documented_collection_methods(
- factory_self, attrs, resource_name, collection_model,
- service_model, event_emitter, base_class):
+ factory_self,
+ attrs,
+ resource_name,
+ collection_model,
+ service_model,
+ event_emitter,
+ base_class,
+ ):
# The base class already has these methods defined. However
# the docstrings are generic and not based for a particular service
# or resource. So we override these methods by proxying to the
@@ -456,7 +496,7 @@ class CollectionFactory(object):
event_emitter=event_emitter,
collection_model=collection_model,
service_model=service_model,
- include_signature=False
+ include_signature=False,
)
attrs['all'] = all
@@ -470,7 +510,7 @@ class CollectionFactory(object):
event_emitter=event_emitter,
collection_model=collection_model,
service_model=service_model,
- include_signature=False
+ include_signature=False,
)
attrs['filter'] = filter
@@ -484,7 +524,7 @@ class CollectionFactory(object):
event_emitter=event_emitter,
collection_model=collection_model,
service_model=service_model,
- include_signature=False
+ include_signature=False,
)
attrs['limit'] = limit
@@ -498,13 +538,19 @@ class CollectionFactory(object):
event_emitter=event_emitter,
collection_model=collection_model,
service_model=service_model,
- include_signature=False
+ include_signature=False,
)
attrs['page_size'] = page_size
- def _create_batch_action(factory_self, resource_name, snake_cased,
- action_model, collection_model, service_model,
- event_emitter):
+ def _create_batch_action(
+ factory_self,
+ resource_name,
+ snake_cased,
+ action_model,
+ collection_model,
+ service_model,
+ event_emitter,
+ ):
"""
Creates a new method which makes a batch operation request
to the underlying service API.
@@ -521,6 +567,6 @@ class CollectionFactory(object):
batch_action_model=action_model,
service_model=service_model,
collection_model=collection_model,
- include_signature=False
+ include_signature=False,
)
return batch_action
diff --git a/contrib/python/boto3/py3/boto3/resources/factory.py b/contrib/python/boto3/py3/boto3/resources/factory.py
index 90b3ce97d8..1d33e5cb22 100644
--- a/contrib/python/boto3/py3/boto3/resources/factory.py
+++ b/contrib/python/boto3/py3/boto3/resources/factory.py
@@ -14,20 +14,18 @@
import logging
from functools import partial
-from .action import ServiceAction
-from .action import WaiterAction
+from ..docs import docstring
+from ..exceptions import ResourceLoadException
+from .action import ServiceAction, WaiterAction
from .base import ResourceMeta, ServiceResource
from .collection import CollectionFactory
from .model import ResourceModel
-from .response import build_identifiers, ResourceHandler
-from ..exceptions import ResourceLoadException
-from ..docs import docstring
-
+from .response import ResourceHandler, build_identifiers
logger = logging.getLogger(__name__)
-class ResourceFactory(object):
+class ResourceFactory:
"""
A factory to create new :py:class:`~boto3.resources.base.ServiceResource`
classes from a :py:class:`~boto3.resources.model.ResourceModel`. There are
@@ -35,12 +33,14 @@ class ResourceFactory(object):
SQS resource) and another on models contained within the service (e.g. an
SQS Queue resource).
"""
+
def __init__(self, emitter):
self._collection_factory = CollectionFactory()
self._emitter = emitter
- def load_from_definition(self, resource_name,
- single_resource_json_definition, service_context):
+ def load_from_definition(
+ self, resource_name, single_resource_json_definition, service_context
+ ):
"""
Loads a resource from a model, creating a new
:py:class:`~boto3.resources.base.ServiceResource` subclass
@@ -62,13 +62,15 @@ class ResourceFactory(object):
:rtype: Subclass of :py:class:`~boto3.resources.base.ServiceResource`
:return: The service or resource class.
"""
- logger.debug('Loading %s:%s', service_context.service_name,
- resource_name)
+ logger.debug(
+ 'Loading %s:%s', service_context.service_name, resource_name
+ )
# Using the loaded JSON create a ResourceModel object.
resource_model = ResourceModel(
- resource_name, single_resource_json_definition,
- service_context.resource_json_definitions
+ resource_name,
+ single_resource_json_definition,
+ service_context.resource_json_definitions,
)
# Do some renaming of the shape if there was a naming collision
@@ -76,12 +78,14 @@ class ResourceFactory(object):
shape = None
if resource_model.shape:
shape = service_context.service_model.shape_for(
- resource_model.shape)
+ resource_model.shape
+ )
resource_model.load_rename_map(shape)
# Set some basic info
meta = ResourceMeta(
- service_context.service_name, resource_model=resource_model)
+ service_context.service_name, resource_model=resource_model
+ )
attrs = {
'meta': meta,
}
@@ -91,37 +95,50 @@ class ResourceFactory(object):
# Identifiers
self._load_identifiers(
- attrs=attrs, meta=meta, resource_name=resource_name,
- resource_model=resource_model
+ attrs=attrs,
+ meta=meta,
+ resource_name=resource_name,
+ resource_model=resource_model,
)
# Load/Reload actions
self._load_actions(
- attrs=attrs, resource_name=resource_name,
- resource_model=resource_model, service_context=service_context
+ attrs=attrs,
+ resource_name=resource_name,
+ resource_model=resource_model,
+ service_context=service_context,
)
# Attributes that get auto-loaded
self._load_attributes(
- attrs=attrs, meta=meta, resource_name=resource_name,
+ attrs=attrs,
+ meta=meta,
+ resource_name=resource_name,
resource_model=resource_model,
- service_context=service_context)
+ service_context=service_context,
+ )
# Collections and their corresponding methods
self._load_collections(
- attrs=attrs, resource_model=resource_model,
- service_context=service_context)
+ attrs=attrs,
+ resource_model=resource_model,
+ service_context=service_context,
+ )
# References and Subresources
self._load_has_relations(
- attrs=attrs, resource_name=resource_name,
- resource_model=resource_model, service_context=service_context
+ attrs=attrs,
+ resource_name=resource_name,
+ resource_model=resource_model,
+ service_context=service_context,
)
# Waiter resource actions
self._load_waiters(
- attrs=attrs, resource_name=resource_name,
- resource_model=resource_model, service_context=service_context
+ attrs=attrs,
+ resource_name=resource_name,
+ resource_model=resource_model,
+ service_context=service_context,
)
# Create the name based on the requested service and resource
@@ -133,9 +150,11 @@ class ResourceFactory(object):
base_classes = [ServiceResource]
if self._emitter is not None:
self._emitter.emit(
- 'creating-resource-class.%s' % cls_name,
- class_attributes=attrs, base_classes=base_classes,
- service_context=service_context)
+ f'creating-resource-class.{cls_name}',
+ class_attributes=attrs,
+ base_classes=base_classes,
+ service_context=service_context,
+ )
return type(str(cls_name), tuple(base_classes), attrs)
def _load_identifiers(self, attrs, meta, resource_model, resource_name):
@@ -147,10 +166,12 @@ class ResourceFactory(object):
for identifier in resource_model.identifiers:
meta.identifiers.append(identifier.name)
attrs[identifier.name] = self._create_identifier(
- identifier, resource_name)
+ identifier, resource_name
+ )
- def _load_actions(self, attrs, resource_name, resource_model,
- service_context):
+ def _load_actions(
+ self, attrs, resource_name, resource_model, service_context
+ ):
"""
Actions on the resource become methods, with the ``load`` method
being a special case which sets internal data for attributes, and
@@ -158,17 +179,23 @@ class ResourceFactory(object):
"""
if resource_model.load:
attrs['load'] = self._create_action(
- action_model=resource_model.load, resource_name=resource_name,
- service_context=service_context, is_load=True)
+ action_model=resource_model.load,
+ resource_name=resource_name,
+ service_context=service_context,
+ is_load=True,
+ )
attrs['reload'] = attrs['load']
for action in resource_model.actions:
attrs[action.name] = self._create_action(
- action_model=action, resource_name=resource_name,
- service_context=service_context)
+ action_model=action,
+ resource_name=resource_name,
+ service_context=service_context,
+ )
- def _load_attributes(self, attrs, meta, resource_name, resource_model,
- service_context):
+ def _load_attributes(
+ self, attrs, meta, resource_name, resource_model, service_context
+ ):
"""
Load resource attributes based on the resource shape. The shape
name is referenced in the resource JSON, but the shape itself
@@ -178,12 +205,13 @@ class ResourceFactory(object):
if not resource_model.shape:
return
- shape = service_context.service_model.shape_for(
- resource_model.shape)
+ shape = service_context.service_model.shape_for(resource_model.shape)
- identifiers = dict(
- (i.member_name, i)
- for i in resource_model.identifiers if i.member_name)
+ identifiers = {
+ i.member_name: i
+ for i in resource_model.identifiers
+ if i.member_name
+ }
attributes = resource_model.get_attributes(shape)
for name, (orig_name, member) in attributes.items():
if name in identifiers:
@@ -191,14 +219,15 @@ class ResourceFactory(object):
resource_name=resource_name,
identifier=identifiers[name],
member_model=member,
- service_context=service_context
+ service_context=service_context,
)
else:
prop = self._create_autoload_property(
resource_name=resource_name,
- name=orig_name, snake_cased=name,
+ name=orig_name,
+ snake_cased=name,
member_model=member,
- service_context=service_context
+ service_context=service_context,
)
attrs[name] = prop
@@ -213,11 +242,12 @@ class ResourceFactory(object):
attrs[collection_model.name] = self._create_collection(
resource_name=resource_model.name,
collection_model=collection_model,
- service_context=service_context
+ service_context=service_context,
)
- def _load_has_relations(self, attrs, resource_name, resource_model,
- service_context):
+ def _load_has_relations(
+ self, attrs, resource_name, resource_model, service_context
+ ):
"""
Load related resources, which are defined via a ``has``
relationship but conceptually come in two forms:
@@ -235,7 +265,7 @@ class ResourceFactory(object):
attrs[reference.name] = self._create_reference(
reference_model=reference,
resource_name=resource_name,
- service_context=service_context
+ service_context=service_context,
)
for subresource in resource_model.subresources:
@@ -244,11 +274,12 @@ class ResourceFactory(object):
attrs[subresource.name] = self._create_class_partial(
subresource_model=subresource,
resource_name=resource_name,
- service_context=service_context
+ service_context=service_context,
)
self._create_available_subresources_command(
- attrs, resource_model.subresources)
+ attrs, resource_model.subresources
+ )
def _create_available_subresources_command(self, attrs, subresources):
_subresources = [subresource.name for subresource in subresources]
@@ -267,8 +298,9 @@ class ResourceFactory(object):
attrs['get_available_subresources'] = get_available_subresources
- def _load_waiters(self, attrs, resource_name, resource_model,
- service_context):
+ def _load_waiters(
+ self, attrs, resource_name, resource_model, service_context
+ ):
"""
Load resource waiters from the model. Each waiter allows you to
wait until a resource reaches a specific state by polling the state
@@ -278,13 +310,14 @@ class ResourceFactory(object):
attrs[waiter.name] = self._create_waiter(
resource_waiter_model=waiter,
resource_name=resource_name,
- service_context=service_context
+ service_context=service_context,
)
def _create_identifier(factory_self, identifier, resource_name):
"""
Creates a read-only property for identifier attributes.
"""
+
def get_identifier(self):
# The default value is set to ``None`` instead of
# raising an AttributeError because when resources are
@@ -298,16 +331,18 @@ class ResourceFactory(object):
get_identifier.__doc__ = docstring.IdentifierDocstring(
resource_name=resource_name,
identifier_model=identifier,
- include_signature=False
+ include_signature=False,
)
return property(get_identifier)
- def _create_identifier_alias(factory_self, resource_name, identifier,
- member_model, service_context):
+ def _create_identifier_alias(
+ factory_self, resource_name, identifier, member_model, service_context
+ ):
"""
Creates a read-only property that aliases an identifier.
"""
+
def get_identifier(self):
return getattr(self, '_' + identifier.name, None)
@@ -318,13 +353,19 @@ class ResourceFactory(object):
attr_name=identifier.member_name,
event_emitter=factory_self._emitter,
attr_model=member_model,
- include_signature=False
+ include_signature=False,
)
return property(get_identifier)
- def _create_autoload_property(factory_self, resource_name, name,
- snake_cased, member_model, service_context):
+ def _create_autoload_property(
+ factory_self,
+ resource_name,
+ name,
+ snake_cased,
+ member_model,
+ service_context,
+ ):
"""
Creates a new property on the resource to lazy-load its value
via the resource's ``load`` method (if it exists).
@@ -339,8 +380,8 @@ class ResourceFactory(object):
self.load()
else:
raise ResourceLoadException(
- '{0} has no load method'.format(
- self.__class__.__name__))
+ f'{self.__class__.__name__} has no load method'
+ )
return self.meta.data.get(name)
@@ -351,19 +392,22 @@ class ResourceFactory(object):
attr_name=snake_cased,
event_emitter=factory_self._emitter,
attr_model=member_model,
- include_signature=False
+ include_signature=False,
)
return property(property_loader)
- def _create_waiter(factory_self, resource_waiter_model, resource_name,
- service_context):
+ def _create_waiter(
+ factory_self, resource_waiter_model, resource_name, service_context
+ ):
"""
Creates a new wait method for each resource where both a waiter and
resource model is defined.
"""
- waiter = WaiterAction(resource_waiter_model,
- waiter_resource_name=resource_waiter_model.name)
+ waiter = WaiterAction(
+ resource_waiter_model,
+ waiter_resource_name=resource_waiter_model.name,
+ )
def do_waiter(self, *args, **kwargs):
waiter(self, *args, **kwargs)
@@ -375,32 +419,40 @@ class ResourceFactory(object):
service_model=service_context.service_model,
resource_waiter_model=resource_waiter_model,
service_waiter_model=service_context.service_waiter_model,
- include_signature=False
+ include_signature=False,
)
return do_waiter
- def _create_collection(factory_self, resource_name, collection_model,
- service_context):
+ def _create_collection(
+ factory_self, resource_name, collection_model, service_context
+ ):
"""
Creates a new property on the resource to lazy-load a collection.
"""
cls = factory_self._collection_factory.load_from_definition(
- resource_name=resource_name, collection_model=collection_model,
+ resource_name=resource_name,
+ collection_model=collection_model,
service_context=service_context,
- event_emitter=factory_self._emitter)
+ event_emitter=factory_self._emitter,
+ )
def get_collection(self):
return cls(
- collection_model=collection_model, parent=self,
- factory=factory_self, service_context=service_context)
+ collection_model=collection_model,
+ parent=self,
+ factory=factory_self,
+ service_context=service_context,
+ )
get_collection.__name__ = str(collection_model.name)
get_collection.__doc__ = docstring.CollectionDocstring(
- collection_model=collection_model, include_signature=False)
+ collection_model=collection_model, include_signature=False
+ )
return property(get_collection)
- def _create_reference(factory_self, reference_model, resource_name,
- service_context):
+ def _create_reference(
+ factory_self, reference_model, resource_name, service_context
+ ):
"""
Creates a new property on the resource to lazy-load a reference.
"""
@@ -408,16 +460,18 @@ class ResourceFactory(object):
# or response, so we can re-use the response handlers to
# build up resources from identifiers and data members.
handler = ResourceHandler(
- search_path=reference_model.resource.path, factory=factory_self,
+ search_path=reference_model.resource.path,
+ factory=factory_self,
resource_model=reference_model.resource,
- service_context=service_context
+ service_context=service_context,
)
# Are there any identifiers that need access to data members?
# This is important when building the resource below since
# it requires the data to be loaded.
- needs_data = any(i.source == 'data' for i in
- reference_model.resource.identifiers)
+ needs_data = any(
+ i.source == 'data' for i in reference_model.resource.identifiers
+ )
def get_reference(self):
# We need to lazy-evaluate the reference to handle circular
@@ -433,13 +487,13 @@ class ResourceFactory(object):
get_reference.__name__ = str(reference_model.name)
get_reference.__doc__ = docstring.ReferenceDocstring(
- reference_model=reference_model,
- include_signature=False
+ reference_model=reference_model, include_signature=False
)
return property(get_reference)
- def _create_class_partial(factory_self, subresource_model, resource_name,
- service_context):
+ def _create_class_partial(
+ factory_self, subresource_model, resource_name, service_context
+ ):
"""
Creates a new method which acts as a functools.partial, passing
along the instance's low-level `client` to the new resource
@@ -457,7 +511,7 @@ class ResourceFactory(object):
resource_cls = factory_self.load_from_definition(
resource_name=name,
single_resource_json_definition=json_def,
- service_context=service_context
+ service_context=service_context,
)
# Assumes that identifiers are in order, which lets you do
@@ -470,20 +524,26 @@ class ResourceFactory(object):
for identifier, value in build_identifiers(identifiers, self):
positional_args.append(value)
- return partial(resource_cls, *positional_args,
- client=self.meta.client)(*args, **kwargs)
+ return partial(
+ resource_cls, *positional_args, client=self.meta.client
+ )(*args, **kwargs)
create_resource.__name__ = str(name)
create_resource.__doc__ = docstring.SubResourceDocstring(
resource_name=resource_name,
sub_resource_model=subresource_model,
service_model=service_context.service_model,
- include_signature=False
+ include_signature=False,
)
return create_resource
- def _create_action(factory_self, action_model, resource_name,
- service_context, is_load=False):
+ def _create_action(
+ factory_self,
+ action_model,
+ resource_name,
+ service_context,
+ is_load=False,
+ ):
"""
Creates a new method which makes a request to the underlying
AWS service.
@@ -492,8 +552,7 @@ class ResourceFactory(object):
# method below is invoked, which allows instances of the resource
# to share the ServiceAction instance.
action = ServiceAction(
- action_model, factory=factory_self,
- service_context=service_context
+ action_model, factory=factory_self, service_context=service_context
)
# A resource's ``load`` method is special because it sets
@@ -504,6 +563,7 @@ class ResourceFactory(object):
def do_action(self, *args, **kwargs):
response = action(self, *args, **kwargs)
self.meta.data = response
+
# Create the docstring for the load/reload mehtods.
lazy_docstring = docstring.LoadReloadDocstring(
action_name=action_model.name,
@@ -511,7 +571,7 @@ class ResourceFactory(object):
event_emitter=factory_self._emitter,
load_model=action_model,
service_model=service_context.service_model,
- include_signature=False
+ include_signature=False,
)
else:
# We need a new method here because we want access to the
@@ -526,12 +586,13 @@ class ResourceFactory(object):
self.meta.data = None
return response
+
lazy_docstring = docstring.ActionDocstring(
resource_name=resource_name,
event_emitter=factory_self._emitter,
action_model=action_model,
service_model=service_context.service_model,
- include_signature=False
+ include_signature=False,
)
do_action.__name__ = str(action_model.name)
diff --git a/contrib/python/boto3/py3/boto3/resources/model.py b/contrib/python/boto3/py3/boto3/resources/model.py
index 478d265b34..29371ee661 100644
--- a/contrib/python/boto3/py3/boto3/resources/model.py
+++ b/contrib/python/boto3/py3/boto3/resources/model.py
@@ -27,24 +27,24 @@ import logging
from botocore import xform_name
-
logger = logging.getLogger(__name__)
-class Identifier(object):
+class Identifier:
"""
A resource identifier, given by its name.
:type name: string
:param name: The name of the identifier
"""
+
def __init__(self, name, member_name=None):
#: (``string``) The name of the identifier
self.name = name
self.member_name = member_name
-class Action(object):
+class Action:
"""
A service operation action.
@@ -55,6 +55,7 @@ class Action(object):
:type resource_defs: dict
:param resource_defs: All resources defined in the service
"""
+
def __init__(self, name, definition, resource_defs):
self._definition = definition
@@ -67,13 +68,14 @@ class Action(object):
#: (:py:class:`ResponseResource`) This action's resource or ``None``
self.resource = None
if 'resource' in definition:
- self.resource = ResponseResource(definition.get('resource', {}),
- resource_defs)
+ self.resource = ResponseResource(
+ definition.get('resource', {}), resource_defs
+ )
#: (``string``) The JMESPath search path or ``None``
self.path = definition.get('path')
-class DefinitionWithParams(object):
+class DefinitionWithParams:
"""
An item which has parameters exposed via the ``params`` property.
A request has an operation and parameters, while a waiter has
@@ -82,6 +84,7 @@ class DefinitionWithParams(object):
:type definition: dict
:param definition: The JSON definition
"""
+
def __init__(self, definition):
self._definition = definition
@@ -100,7 +103,7 @@ class DefinitionWithParams(object):
return params
-class Parameter(object):
+class Parameter:
"""
An auto-filled parameter which has a source and target. For example,
the ``QueueUrl`` may be auto-filled from a resource's ``url`` identifier
@@ -113,8 +116,10 @@ class Parameter(object):
:type source: string
:param source: The source name, e.g. ``Url``
"""
- def __init__(self, target, source, name=None, path=None, value=None,
- **kwargs):
+
+ def __init__(
+ self, target, source, name=None, path=None, value=None, **kwargs
+ ):
#: (``string``) The destination parameter name
self.target = target
#: (``string``) Where the source is defined
@@ -138,8 +143,9 @@ class Request(DefinitionWithParams):
:type definition: dict
:param definition: The JSON definition
"""
+
def __init__(self, definition):
- super(Request, self).__init__(definition)
+ super().__init__(definition)
#: (``string``) The name of the low-level service operation
self.operation = definition.get('operation')
@@ -154,10 +160,11 @@ class Waiter(DefinitionWithParams):
:type definition: dict
:param definition: The JSON definition
"""
+
PREFIX = 'WaitUntil'
def __init__(self, name, definition):
- super(Waiter, self).__init__(definition)
+ super().__init__(definition)
#: (``string``) The name of this waiter
self.name = name
@@ -166,7 +173,7 @@ class Waiter(DefinitionWithParams):
self.waiter_name = definition.get('waiterName')
-class ResponseResource(object):
+class ResponseResource:
"""
A resource response to create after performing an action.
@@ -175,6 +182,7 @@ class ResponseResource(object):
:type resource_defs: dict
:param resource_defs: All resources defined in the service
"""
+
def __init__(self, definition, resource_defs):
self._definition = definition
self._resource_defs = resource_defs
@@ -195,8 +203,7 @@ class ResponseResource(object):
identifiers = []
for item in self._definition.get('identifiers', []):
- identifiers.append(
- Parameter(**item))
+ identifiers.append(Parameter(**item))
return identifiers
@@ -207,8 +214,9 @@ class ResponseResource(object):
:type: :py:class:`ResourceModel`
"""
- return ResourceModel(self.type, self._resource_defs[self.type],
- self._resource_defs)
+ return ResourceModel(
+ self.type, self._resource_defs[self.type], self._resource_defs
+ )
class Collection(Action):
@@ -222,6 +230,7 @@ class Collection(Action):
:type resource_defs: dict
:param resource_defs: All resources defined in the service
"""
+
@property
def batch_actions(self):
"""
@@ -234,7 +243,7 @@ class Collection(Action):
return self.resource.model.batch_actions
-class ResourceModel(object):
+class ResourceModel:
"""
A model representing a resource, defined via a JSON description
format. A resource has identifiers, attributes, actions,
@@ -248,6 +257,7 @@ class ResourceModel(object):
:type resource_defs: dict
:param resource_defs: All resources defined in the service
"""
+
def __init__(self, name, definition, resource_defs):
self._definition = definition
self._resource_defs = resource_defs
@@ -296,7 +306,7 @@ class ResourceModel(object):
:param shape: The underlying shape for this resource.
"""
# Meta is a reserved name for resources
- names = set(['meta'])
+ names = {'meta'}
self._renamed = {}
if self._definition.get('load'):
@@ -318,8 +328,9 @@ class ResourceModel(object):
break
if not data_required:
- self._load_name_with_category(names, name, 'subresource',
- snake_case=False)
+ self._load_name_with_category(
+ names, name, 'subresource', snake_case=False
+ )
else:
self._load_name_with_category(names, name, 'reference')
@@ -327,15 +338,15 @@ class ResourceModel(object):
self._load_name_with_category(names, name, 'collection')
for name in self._definition.get('waiters', {}):
- self._load_name_with_category(names, Waiter.PREFIX + name,
- 'waiter')
+ self._load_name_with_category(
+ names, Waiter.PREFIX + name, 'waiter'
+ )
if shape is not None:
for name in shape.members.keys():
self._load_name_with_category(names, name, 'attribute')
- def _load_name_with_category(self, names, name, category,
- snake_case=True):
+ def _load_name_with_category(self, names, name, category, snake_case=True):
"""
Load a name with a given category, possibly renaming it
if that name is already in use. The name will be stored
@@ -355,15 +366,18 @@ class ResourceModel(object):
name = xform_name(name)
if name in names:
- logger.debug('Renaming %s %s %s' % (self.name, category, name))
+ logger.debug(f'Renaming {self.name} {category} {name}')
self._renamed[(category, name)] = name + '_' + category
name += '_' + category
if name in names:
# This isn't good, let's raise instead of trying to keep
# renaming this value.
- raise ValueError('Problem renaming {0} {1} to {2}!'.format(
- self.name, category, name))
+ raise ValueError(
+ 'Problem renaming {} {} to {}!'.format(
+ self.name, category, name
+ )
+ )
names.add(name)
@@ -411,8 +425,9 @@ class ResourceModel(object):
if snake_cased in identifier_names:
# Skip identifiers, these are set through other means
continue
- snake_cased = self._get_name('attribute', snake_cased,
- snake_case=False)
+ snake_cased = self._get_name(
+ 'attribute', snake_cased, snake_case=False
+ )
attributes[snake_cased] = (name, member)
return attributes
@@ -524,17 +539,12 @@ class ResourceModel(object):
# }
# }
#
- fake_has = {
- 'resource': {
- 'type': name,
- 'identifiers': []
- }
- }
+ fake_has = {'resource': {'type': name, 'identifiers': []}}
for identifier in resource_def.get('identifiers', []):
- fake_has['resource']['identifiers'].append({
- 'target': identifier['name'], 'source': 'input'
- })
+ fake_has['resource']['identifiers'].append(
+ {'target': identifier['name'], 'source': 'input'}
+ )
definition[name] = fake_has
else:
diff --git a/contrib/python/boto3/py3/boto3/resources/params.py b/contrib/python/boto3/py3/boto3/resources/params.py
index 6db52ab57d..3c5c74b3c7 100644
--- a/contrib/python/boto3/py3/boto3/resources/params.py
+++ b/contrib/python/boto3/py3/boto3/resources/params.py
@@ -18,7 +18,6 @@ from botocore import xform_name
from ..exceptions import ResourceLoadException
-
INDEX_RE = re.compile(r'\[(.*)\]$')
@@ -43,7 +42,8 @@ def get_data_member(parent, path):
parent.load()
else:
raise ResourceLoadException(
- '{0} has no load method!'.format(parent.__class__.__name__))
+ f'{parent.__class__.__name__} has no load method!'
+ )
return jmespath.search(path, parent.meta.data)
@@ -90,8 +90,7 @@ def create_request_parameters(parent, request_model, params=None, index=None):
# This is provided by the user, so ignore it here
continue
else:
- raise NotImplementedError(
- 'Unsupported source type: {0}'.format(source))
+ raise NotImplementedError(f'Unsupported source type: {source}')
build_param_structure(params, target, value, index)
@@ -133,7 +132,7 @@ def build_param_structure(params, target, value, index=None):
else:
# We have an explicit index
index = int(result.group(1))
- part = part[:-len(str(index) + '[]')]
+ part = part[: -len(str(index) + '[]')]
else:
# Index will be set after we know the proper part
# name and that it's a list instance.
diff --git a/contrib/python/boto3/py3/boto3/resources/response.py b/contrib/python/boto3/py3/boto3/resources/response.py
index c37d3ae9a5..6dd92acb24 100644
--- a/contrib/python/boto3/py3/boto3/resources/response.py
+++ b/contrib/python/boto3/py3/boto3/resources/response.py
@@ -68,8 +68,7 @@ def build_identifiers(identifiers, parent, params=None, raw_response=None):
# This value is set by the user, so ignore it here
continue
else:
- raise NotImplementedError(
- 'Unsupported source type: {0}'.format(source))
+ raise NotImplementedError(f'Unsupported source type: {source}')
results.append((xform_name(target), value))
@@ -111,8 +110,10 @@ def build_empty_response(search_path, operation_name, service_model):
shape = shape.member
else:
raise NotImplementedError(
- 'Search path hits shape type {0} from {1}'.format(
- shape.type_name, item))
+ 'Search path hits shape type {} from {}'.format(
+ shape.type_name, item
+ )
+ )
# Anything not handled here is set to None
if shape.type_name == 'structure':
@@ -125,7 +126,7 @@ def build_empty_response(search_path, operation_name, service_model):
return response
-class RawHandler(object):
+class RawHandler:
"""
A raw action response handler. This passed through the response
dictionary, optionally after performing a JMESPath search if one
@@ -136,6 +137,7 @@ class RawHandler(object):
:rtype: dict
:return: Service response
"""
+
def __init__(self, search_path):
self.search_path = search_path
@@ -155,7 +157,7 @@ class RawHandler(object):
return response
-class ResourceHandler(object):
+class ResourceHandler:
"""
Creates a new resource or list of new resources from the low-level
response based on the given response resource definition.
@@ -180,8 +182,15 @@ class ResourceHandler(object):
:rtype: ServiceResource or list
:return: New resource instance(s).
"""
- def __init__(self, search_path, factory, resource_model,
- service_context, operation_name=None):
+
+ def __init__(
+ self,
+ search_path,
+ factory,
+ resource_model,
+ service_context,
+ operation_name=None,
+ ):
self.search_path = search_path
self.factory = factory
self.resource_model = resource_model
@@ -199,13 +208,14 @@ class ResourceHandler(object):
"""
resource_name = self.resource_model.type
json_definition = self.service_context.resource_json_definitions.get(
- resource_name)
+ resource_name
+ )
# Load the new resource class that will result from this action.
resource_cls = self.factory.load_from_definition(
resource_name=resource_name,
single_resource_json_definition=json_definition,
- service_context=self.service_context
+ service_context=self.service_context,
)
raw_response = response
search_response = None
@@ -222,9 +232,11 @@ class ResourceHandler(object):
# will have one item consumed from the front of the list for each
# resource that is instantiated. Items which are not a list will
# be set as the same value on each new resource instance.
- identifiers = dict(build_identifiers(
- self.resource_model.identifiers, parent, params,
- raw_response))
+ identifiers = dict(
+ build_identifiers(
+ self.resource_model.identifiers, parent, params, raw_response
+ )
+ )
# If any of the identifiers is a list, then the response is plural
plural = [v for v in identifiers.values() if isinstance(v, list)]
@@ -242,13 +254,16 @@ class ResourceHandler(object):
if search_response:
response_item = search_response[i]
response.append(
- self.handle_response_item(resource_cls, parent,
- identifiers, response_item))
+ self.handle_response_item(
+ resource_cls, parent, identifiers, response_item
+ )
+ )
elif all_not_none(identifiers.values()):
# All identifiers must always exist, otherwise the resource
# cannot be instantiated.
response = self.handle_response_item(
- resource_cls, parent, identifiers, search_response)
+ resource_cls, parent, identifiers, search_response
+ )
else:
# The response should be empty, but that may mean an
# empty dict, list, or None based on whether we make
@@ -259,13 +274,16 @@ class ResourceHandler(object):
# A remote service call was made, so try and determine
# its shape.
response = build_empty_response(
- self.search_path, self.operation_name,
- self.service_context.service_model)
+ self.search_path,
+ self.operation_name,
+ self.service_context.service_model,
+ )
return response
- def handle_response_item(self, resource_cls, parent, identifiers,
- resource_data):
+ def handle_response_item(
+ self, resource_cls, parent, identifiers, resource_data
+ ):
"""
Handles the creation of a single response item by setting
parameters and creating the appropriate resource instance.
diff --git a/contrib/python/boto3/py3/boto3/s3/inject.py b/contrib/python/boto3/py3/boto3/s3/inject.py
index f299e6a81d..d57e308358 100644
--- a/contrib/python/boto3/py3/boto3/s3/inject.py
+++ b/contrib/python/boto3/py3/boto3/s3/inject.py
@@ -12,10 +12,13 @@
# language governing permissions and limitations under the License.
from botocore.exceptions import ClientError
-from boto3.s3.transfer import create_transfer_manager
-from boto3.s3.transfer import TransferConfig, S3Transfer
-from boto3.s3.transfer import ProgressCallbackInvoker
from boto3 import utils
+from boto3.s3.transfer import (
+ ProgressCallbackInvoker,
+ S3Transfer,
+ TransferConfig,
+ create_transfer_manager,
+)
def inject_s3_transfer_methods(class_attributes, **kwargs):
@@ -24,30 +27,37 @@ def inject_s3_transfer_methods(class_attributes, **kwargs):
utils.inject_attribute(class_attributes, 'copy', copy)
utils.inject_attribute(class_attributes, 'upload_fileobj', upload_fileobj)
utils.inject_attribute(
- class_attributes, 'download_fileobj', download_fileobj)
+ class_attributes, 'download_fileobj', download_fileobj
+ )
def inject_bucket_methods(class_attributes, **kwargs):
utils.inject_attribute(class_attributes, 'load', bucket_load)
utils.inject_attribute(class_attributes, 'upload_file', bucket_upload_file)
utils.inject_attribute(
- class_attributes, 'download_file', bucket_download_file)
+ class_attributes, 'download_file', bucket_download_file
+ )
utils.inject_attribute(class_attributes, 'copy', bucket_copy)
utils.inject_attribute(
- class_attributes, 'upload_fileobj', bucket_upload_fileobj)
+ class_attributes, 'upload_fileobj', bucket_upload_fileobj
+ )
utils.inject_attribute(
- class_attributes, 'download_fileobj', bucket_download_fileobj)
+ class_attributes, 'download_fileobj', bucket_download_fileobj
+ )
def inject_object_methods(class_attributes, **kwargs):
utils.inject_attribute(class_attributes, 'upload_file', object_upload_file)
utils.inject_attribute(
- class_attributes, 'download_file', object_download_file)
+ class_attributes, 'download_file', object_download_file
+ )
utils.inject_attribute(class_attributes, 'copy', object_copy)
utils.inject_attribute(
- class_attributes, 'upload_fileobj', object_upload_fileobj)
+ class_attributes, 'upload_fileobj', object_upload_fileobj
+ )
utils.inject_attribute(
- class_attributes, 'download_fileobj', object_download_fileobj)
+ class_attributes, 'download_fileobj', object_download_fileobj
+ )
def inject_object_summary_methods(class_attributes, **kwargs):
@@ -85,14 +95,16 @@ def object_summary_load(self, *args, **kwargs):
resource.
"""
response = self.meta.client.head_object(
- Bucket=self.bucket_name, Key=self.key)
+ Bucket=self.bucket_name, Key=self.key
+ )
if 'ContentLength' in response:
response['Size'] = response.pop('ContentLength')
self.meta.data = response
-def upload_file(self, Filename, Bucket, Key, ExtraArgs=None,
- Callback=None, Config=None):
+def upload_file(
+ self, Filename, Bucket, Key, ExtraArgs=None, Callback=None, Config=None
+):
"""Upload a file to an S3 object.
Usage::
@@ -129,12 +141,17 @@ def upload_file(self, Filename, Bucket, Key, ExtraArgs=None,
"""
with S3Transfer(self, Config) as transfer:
return transfer.upload_file(
- filename=Filename, bucket=Bucket, key=Key,
- extra_args=ExtraArgs, callback=Callback)
+ filename=Filename,
+ bucket=Bucket,
+ key=Key,
+ extra_args=ExtraArgs,
+ callback=Callback,
+ )
-def download_file(self, Bucket, Key, Filename, ExtraArgs=None,
- Callback=None, Config=None):
+def download_file(
+ self, Bucket, Key, Filename, ExtraArgs=None, Callback=None, Config=None
+):
"""Download an S3 object to a file.
Usage::
@@ -171,12 +188,17 @@ def download_file(self, Bucket, Key, Filename, ExtraArgs=None,
"""
with S3Transfer(self, Config) as transfer:
return transfer.download_file(
- bucket=Bucket, key=Key, filename=Filename,
- extra_args=ExtraArgs, callback=Callback)
+ bucket=Bucket,
+ key=Key,
+ filename=Filename,
+ extra_args=ExtraArgs,
+ callback=Callback,
+ )
-def bucket_upload_file(self, Filename, Key,
- ExtraArgs=None, Callback=None, Config=None):
+def bucket_upload_file(
+ self, Filename, Key, ExtraArgs=None, Callback=None, Config=None
+):
"""Upload a file to an S3 object.
Usage::
@@ -209,12 +231,18 @@ def bucket_upload_file(self, Filename, Key,
transfer.
"""
return self.meta.client.upload_file(
- Filename=Filename, Bucket=self.name, Key=Key,
- ExtraArgs=ExtraArgs, Callback=Callback, Config=Config)
-
-
-def bucket_download_file(self, Key, Filename,
- ExtraArgs=None, Callback=None, Config=None):
+ Filename=Filename,
+ Bucket=self.name,
+ Key=Key,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def bucket_download_file(
+ self, Key, Filename, ExtraArgs=None, Callback=None, Config=None
+):
"""Download an S3 object to a file.
Usage::
@@ -247,12 +275,18 @@ def bucket_download_file(self, Key, Filename,
transfer.
"""
return self.meta.client.download_file(
- Bucket=self.name, Key=Key, Filename=Filename,
- ExtraArgs=ExtraArgs, Callback=Callback, Config=Config)
-
-
-def object_upload_file(self, Filename,
- ExtraArgs=None, Callback=None, Config=None):
+ Bucket=self.name,
+ Key=Key,
+ Filename=Filename,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def object_upload_file(
+ self, Filename, ExtraArgs=None, Callback=None, Config=None
+):
"""Upload a file to an S3 object.
Usage::
@@ -282,12 +316,18 @@ def object_upload_file(self, Filename,
transfer.
"""
return self.meta.client.upload_file(
- Filename=Filename, Bucket=self.bucket_name, Key=self.key,
- ExtraArgs=ExtraArgs, Callback=Callback, Config=Config)
-
-
-def object_download_file(self, Filename,
- ExtraArgs=None, Callback=None, Config=None):
+ Filename=Filename,
+ Bucket=self.bucket_name,
+ Key=self.key,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def object_download_file(
+ self, Filename, ExtraArgs=None, Callback=None, Config=None
+):
"""Download an S3 object to a file.
Usage::
@@ -317,12 +357,25 @@ def object_download_file(self, Filename,
transfer.
"""
return self.meta.client.download_file(
- Bucket=self.bucket_name, Key=self.key, Filename=Filename,
- ExtraArgs=ExtraArgs, Callback=Callback, Config=Config)
-
-
-def copy(self, CopySource, Bucket, Key, ExtraArgs=None, Callback=None,
- SourceClient=None, Config=None):
+ Bucket=self.bucket_name,
+ Key=self.key,
+ Filename=Filename,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def copy(
+ self,
+ CopySource,
+ Bucket,
+ Key,
+ ExtraArgs=None,
+ Callback=None,
+ SourceClient=None,
+ Config=None,
+):
"""Copy an object from one S3 location to another.
This is a managed transfer which will perform a multipart copy in
@@ -381,14 +434,25 @@ def copy(self, CopySource, Bucket, Key, ExtraArgs=None, Callback=None,
with create_transfer_manager(self, config) as manager:
future = manager.copy(
- copy_source=CopySource, bucket=Bucket, key=Key,
- extra_args=ExtraArgs, subscribers=subscribers,
- source_client=SourceClient)
+ copy_source=CopySource,
+ bucket=Bucket,
+ key=Key,
+ extra_args=ExtraArgs,
+ subscribers=subscribers,
+ source_client=SourceClient,
+ )
return future.result()
-def bucket_copy(self, CopySource, Key, ExtraArgs=None, Callback=None,
- SourceClient=None, Config=None):
+def bucket_copy(
+ self,
+ CopySource,
+ Key,
+ ExtraArgs=None,
+ Callback=None,
+ SourceClient=None,
+ Config=None,
+):
"""Copy an object from one S3 location to an object in this bucket.
This is a managed transfer which will perform a multipart copy in
@@ -436,12 +500,24 @@ def bucket_copy(self, CopySource, Key, ExtraArgs=None, Callback=None,
copy.
"""
return self.meta.client.copy(
- CopySource=CopySource, Bucket=self.name, Key=Key, ExtraArgs=ExtraArgs,
- Callback=Callback, SourceClient=SourceClient, Config=Config)
-
-
-def object_copy(self, CopySource, ExtraArgs=None, Callback=None,
- SourceClient=None, Config=None):
+ CopySource=CopySource,
+ Bucket=self.name,
+ Key=Key,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ SourceClient=SourceClient,
+ Config=Config,
+ )
+
+
+def object_copy(
+ self,
+ CopySource,
+ ExtraArgs=None,
+ Callback=None,
+ SourceClient=None,
+ Config=None,
+):
"""Copy an object from one S3 location to this object.
This is a managed transfer which will perform a multipart copy in
@@ -487,13 +563,19 @@ def object_copy(self, CopySource, ExtraArgs=None, Callback=None,
copy.
"""
return self.meta.client.copy(
- CopySource=CopySource, Bucket=self.bucket_name, Key=self.key,
- ExtraArgs=ExtraArgs, Callback=Callback, SourceClient=SourceClient,
- Config=Config)
-
-
-def upload_fileobj(self, Fileobj, Bucket, Key, ExtraArgs=None,
- Callback=None, Config=None):
+ CopySource=CopySource,
+ Bucket=self.bucket_name,
+ Key=self.key,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ SourceClient=SourceClient,
+ Config=Config,
+ )
+
+
+def upload_fileobj(
+ self, Fileobj, Bucket, Key, ExtraArgs=None, Callback=None, Config=None
+):
"""Upload a file-like object to S3.
The file-like object must be in binary mode.
@@ -545,13 +627,18 @@ def upload_fileobj(self, Fileobj, Bucket, Key, ExtraArgs=None,
with create_transfer_manager(self, config) as manager:
future = manager.upload(
- fileobj=Fileobj, bucket=Bucket, key=Key,
- extra_args=ExtraArgs, subscribers=subscribers)
+ fileobj=Fileobj,
+ bucket=Bucket,
+ key=Key,
+ extra_args=ExtraArgs,
+ subscribers=subscribers,
+ )
return future.result()
-def bucket_upload_fileobj(self, Fileobj, Key, ExtraArgs=None,
- Callback=None, Config=None):
+def bucket_upload_fileobj(
+ self, Fileobj, Key, ExtraArgs=None, Callback=None, Config=None
+):
"""Upload a file-like object to this bucket.
The file-like object must be in binary mode.
@@ -589,12 +676,18 @@ def bucket_upload_fileobj(self, Fileobj, Key, ExtraArgs=None,
upload.
"""
return self.meta.client.upload_fileobj(
- Fileobj=Fileobj, Bucket=self.name, Key=Key, ExtraArgs=ExtraArgs,
- Callback=Callback, Config=Config)
-
-
-def object_upload_fileobj(self, Fileobj, ExtraArgs=None, Callback=None,
- Config=None):
+ Fileobj=Fileobj,
+ Bucket=self.name,
+ Key=Key,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def object_upload_fileobj(
+ self, Fileobj, ExtraArgs=None, Callback=None, Config=None
+):
"""Upload a file-like object to this object.
The file-like object must be in binary mode.
@@ -630,12 +723,18 @@ def object_upload_fileobj(self, Fileobj, ExtraArgs=None, Callback=None,
upload.
"""
return self.meta.client.upload_fileobj(
- Fileobj=Fileobj, Bucket=self.bucket_name, Key=self.key,
- ExtraArgs=ExtraArgs, Callback=Callback, Config=Config)
-
-
-def download_fileobj(self, Bucket, Key, Fileobj, ExtraArgs=None,
- Callback=None, Config=None):
+ Fileobj=Fileobj,
+ Bucket=self.bucket_name,
+ Key=self.key,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def download_fileobj(
+ self, Bucket, Key, Fileobj, ExtraArgs=None, Callback=None, Config=None
+):
"""Download an object from S3 to a file-like object.
The file-like object must be in binary mode.
@@ -687,13 +786,18 @@ def download_fileobj(self, Bucket, Key, Fileobj, ExtraArgs=None,
with create_transfer_manager(self, config) as manager:
future = manager.download(
- bucket=Bucket, key=Key, fileobj=Fileobj,
- extra_args=ExtraArgs, subscribers=subscribers)
+ bucket=Bucket,
+ key=Key,
+ fileobj=Fileobj,
+ extra_args=ExtraArgs,
+ subscribers=subscribers,
+ )
return future.result()
-def bucket_download_fileobj(self, Key, Fileobj, ExtraArgs=None,
- Callback=None, Config=None):
+def bucket_download_fileobj(
+ self, Key, Fileobj, ExtraArgs=None, Callback=None, Config=None
+):
"""Download an object from this bucket to a file-like-object.
The file-like object must be in binary mode.
@@ -731,12 +835,18 @@ def bucket_download_fileobj(self, Key, Fileobj, ExtraArgs=None,
download.
"""
return self.meta.client.download_fileobj(
- Bucket=self.name, Key=Key, Fileobj=Fileobj, ExtraArgs=ExtraArgs,
- Callback=Callback, Config=Config)
-
-
-def object_download_fileobj(self, Fileobj, ExtraArgs=None, Callback=None,
- Config=None):
+ Bucket=self.name,
+ Key=Key,
+ Fileobj=Fileobj,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
+
+
+def object_download_fileobj(
+ self, Fileobj, ExtraArgs=None, Callback=None, Config=None
+):
"""Download this object from S3 to a file-like object.
The file-like object must be in binary mode.
@@ -772,5 +882,10 @@ def object_download_fileobj(self, Fileobj, ExtraArgs=None, Callback=None,
download.
"""
return self.meta.client.download_fileobj(
- Bucket=self.bucket_name, Key=self.key, Fileobj=Fileobj,
- ExtraArgs=ExtraArgs, Callback=Callback, Config=Config)
+ Bucket=self.bucket_name,
+ Key=self.key,
+ Fileobj=Fileobj,
+ ExtraArgs=ExtraArgs,
+ Callback=Callback,
+ Config=Config,
+ )
diff --git a/contrib/python/boto3/py3/boto3/s3/transfer.py b/contrib/python/boto3/py3/boto3/s3/transfer.py
index 79d4487329..cd7210e726 100644
--- a/contrib/python/boto3/py3/boto3/s3/transfer.py
+++ b/contrib/python/boto3/py3/boto3/s3/transfer.py
@@ -123,18 +123,17 @@ transfer. For example:
"""
from botocore.exceptions import ClientError
-from botocore.compat import six
-from s3transfer.exceptions import RetriesExceededError as \
- S3TransferRetriesExceededError
+from s3transfer.exceptions import (
+ RetriesExceededError as S3TransferRetriesExceededError,
+)
+from s3transfer.futures import NonThreadedExecutor
from s3transfer.manager import TransferConfig as S3TransferConfig
from s3transfer.manager import TransferManager
-from s3transfer.futures import NonThreadedExecutor
from s3transfer.subscribers import BaseSubscriber
from s3transfer.utils import OSUtils
from boto3.exceptions import RetriesExceededError, S3UploadFailedError
-
KB = 1024
MB = KB * KB
@@ -163,7 +162,7 @@ def create_transfer_manager(client, config, osutil=None):
class TransferConfig(S3TransferConfig):
ALIAS = {
'max_concurrency': 'max_request_concurrency',
- 'max_io_queue': 'max_io_queue_size'
+ 'max_io_queue': 'max_io_queue_size',
}
def __init__(
@@ -217,7 +216,7 @@ class TransferConfig(S3TransferConfig):
in uploading and downloading file content. The value is an integer
in terms of bytes per second.
"""
- super(TransferConfig, self).__init__(
+ super().__init__(
multipart_threshold=multipart_threshold,
max_request_concurrency=max_concurrency,
multipart_chunksize=multipart_chunksize,
@@ -237,12 +236,12 @@ class TransferConfig(S3TransferConfig):
# If the alias name is used, make sure we set the name that it points
# to as that is what actually is used in governing the TransferManager.
if name in self.ALIAS:
- super(TransferConfig, self).__setattr__(self.ALIAS[name], value)
+ super().__setattr__(self.ALIAS[name], value)
# Always set the value of the actual name provided.
- super(TransferConfig, self).__setattr__(name, value)
+ super().__setattr__(name, value)
-class S3Transfer(object):
+class S3Transfer:
ALLOWED_DOWNLOAD_ARGS = TransferManager.ALLOWED_DOWNLOAD_ARGS
ALLOWED_UPLOAD_ARGS = TransferManager.ALLOWED_UPLOAD_ARGS
@@ -266,8 +265,9 @@ class S3Transfer(object):
else:
self._manager = create_transfer_manager(client, config, osutil)
- def upload_file(self, filename, bucket, key,
- callback=None, extra_args=None):
+ def upload_file(
+ self, filename, bucket, key, callback=None, extra_args=None
+ ):
"""Upload a file to an S3 object.
Variants have also been injected into S3 client, Bucket and Object.
@@ -277,12 +277,13 @@ class S3Transfer(object):
:py:meth:`S3.Client.upload_file`
:py:meth:`S3.Client.upload_fileobj`
"""
- if not isinstance(filename, six.string_types):
+ if not isinstance(filename, str):
raise ValueError('Filename must be a string')
subscribers = self._get_subscribers(callback)
future = self._manager.upload(
- filename, bucket, key, extra_args, subscribers)
+ filename, bucket, key, extra_args, subscribers
+ )
try:
future.result()
# If a client error was raised, add the backwards compatibility layer
@@ -291,11 +292,14 @@ class S3Transfer(object):
# client error.
except ClientError as e:
raise S3UploadFailedError(
- "Failed to upload %s to %s: %s" % (
- filename, '/'.join([bucket, key]), e))
+ "Failed to upload {} to {}: {}".format(
+ filename, '/'.join([bucket, key]), e
+ )
+ )
- def download_file(self, bucket, key, filename, extra_args=None,
- callback=None):
+ def download_file(
+ self, bucket, key, filename, extra_args=None, callback=None
+ ):
"""Download an S3 object to a file.
Variants have also been injected into S3 client, Bucket and Object.
@@ -305,12 +309,13 @@ class S3Transfer(object):
:py:meth:`S3.Client.download_file`
:py:meth:`S3.Client.download_fileobj`
"""
- if not isinstance(filename, six.string_types):
+ if not isinstance(filename, str):
raise ValueError('Filename must be a string')
subscribers = self._get_subscribers(callback)
future = self._manager.download(
- bucket, key, filename, extra_args, subscribers)
+ bucket, key, filename, extra_args, subscribers
+ )
try:
future.result()
# This is for backwards compatibility where when retries are
@@ -339,6 +344,7 @@ class ProgressCallbackInvoker(BaseSubscriber):
:param callback: A callable that takes a single positional argument for
how many bytes were transferred.
"""
+
def __init__(self, callback):
self._callback = callback
diff --git a/contrib/python/boto3/py3/boto3/session.py b/contrib/python/boto3/py3/boto3/session.py
index 70c256159a..bdda65ad41 100644
--- a/contrib/python/boto3/py3/boto3/session.py
+++ b/contrib/python/boto3/py3/boto3/session.py
@@ -25,7 +25,7 @@ from boto3.exceptions import ResourceNotExistsError, UnknownAPIVersionError
from .resources.factory import ResourceFactory
-class Session(object):
+class Session:
"""
A session stores configuration state and allows you to create service
clients and resources.
@@ -45,9 +45,16 @@ class Session(object):
:param profile_name: The name of a profile to use. If not given, then
the default profile is used.
"""
- def __init__(self, aws_access_key_id=None, aws_secret_access_key=None,
- aws_session_token=None, region_name=None,
- botocore_session=None, profile_name=None):
+
+ def __init__(
+ self,
+ aws_access_key_id=None,
+ aws_secret_access_key=None,
+ aws_session_token=None,
+ region_name=None,
+ botocore_session=None,
+ profile_name=None,
+ ):
if botocore_session is not None:
self._session = botocore_session
else:
@@ -56,8 +63,9 @@ class Session(object):
# Setup custom user-agent string if it isn't already customized
if self._session.user_agent_name == 'Botocore':
- botocore_info = 'Botocore/{0}'.format(
- self._session.user_agent_version)
+ botocore_info = 'Botocore/{}'.format(
+ self._session.user_agent_version
+ )
if self._session.user_agent_extra:
self._session.user_agent_extra += ' ' + botocore_info
else:
@@ -70,20 +78,23 @@ class Session(object):
if aws_access_key_id or aws_secret_access_key or aws_session_token:
self._session.set_credentials(
- aws_access_key_id, aws_secret_access_key, aws_session_token)
+ aws_access_key_id, aws_secret_access_key, aws_session_token
+ )
if region_name is not None:
self._session.set_config_variable('region', region_name)
self.resource_factory = ResourceFactory(
- self._session.get_component('event_emitter'))
+ self._session.get_component('event_emitter')
+ )
self._setup_loader()
self._register_default_handlers()
def __repr__(self):
- return '{0}(region_name={1})'.format(
+ return '{}(region_name={})'.format(
self.__class__.__name__,
- repr(self._session.get_config_variable('region')))
+ repr(self._session.get_config_variable('region')),
+ )
@property
def profile_name(self):
@@ -119,7 +130,8 @@ class Session(object):
"""
self._loader = self._session.get_component('data_loader')
self._loader.search_paths.append(
- os.path.join(os.path.dirname(__file__), 'data'))
+ os.path.join(os.path.dirname(__file__), 'data')
+ )
def get_available_services(self):
"""
@@ -149,10 +161,16 @@ class Session(object):
"""
return self._session.get_available_partitions()
- def get_available_regions(self, service_name, partition_name='aws',
- allow_non_regional=False):
+ def get_available_regions(
+ self, service_name, partition_name='aws', allow_non_regional=False
+ ):
"""Lists the region and endpoint names of a particular partition.
+ The list of regions returned by this method are regions that are
+ explicitly known by the client to exist and is not comprehensive. A
+ region not returned in this list may still be available for the
+ provided service.
+
:type service_name: string
:param service_name: Name of a service to list endpoint for (e.g., s3).
@@ -169,8 +187,10 @@ class Session(object):
:return: Returns a list of endpoint names (e.g., ["us-east-1"]).
"""
return self._session.get_available_regions(
- service_name=service_name, partition_name=partition_name,
- allow_non_regional=allow_non_regional)
+ service_name=service_name,
+ partition_name=partition_name,
+ allow_non_regional=allow_non_regional,
+ )
def get_credentials(self):
"""
@@ -194,10 +214,19 @@ class Session(object):
"""
return self._session.get_partition_for_region(region_name)
- def client(self, service_name, region_name=None, api_version=None,
- use_ssl=True, verify=None, endpoint_url=None,
- aws_access_key_id=None, aws_secret_access_key=None,
- aws_session_token=None, config=None):
+ def client(
+ self,
+ service_name,
+ region_name=None,
+ api_version=None,
+ use_ssl=True,
+ verify=None,
+ endpoint_url=None,
+ aws_access_key_id=None,
+ aws_secret_access_key=None,
+ aws_session_token=None,
+ config=None,
+ ):
"""
Create a low-level service client by name.
@@ -268,16 +297,31 @@ class Session(object):
"""
return self._session.create_client(
- service_name, region_name=region_name, api_version=api_version,
- use_ssl=use_ssl, verify=verify, endpoint_url=endpoint_url,
+ service_name,
+ region_name=region_name,
+ api_version=api_version,
+ use_ssl=use_ssl,
+ verify=verify,
+ endpoint_url=endpoint_url,
aws_access_key_id=aws_access_key_id,
aws_secret_access_key=aws_secret_access_key,
- aws_session_token=aws_session_token, config=config)
+ aws_session_token=aws_session_token,
+ config=config,
+ )
- def resource(self, service_name, region_name=None, api_version=None,
- use_ssl=True, verify=None, endpoint_url=None,
- aws_access_key_id=None, aws_secret_access_key=None,
- aws_session_token=None, config=None):
+ def resource(
+ self,
+ service_name,
+ region_name=None,
+ api_version=None,
+ use_ssl=True,
+ verify=None,
+ endpoint_url=None,
+ aws_access_key_id=None,
+ aws_secret_access_key=None,
+ aws_session_token=None,
+ config=None,
+ ):
"""
Create a resource service client by name.
@@ -350,19 +394,24 @@ class Session(object):
"""
try:
resource_model = self._loader.load_service_model(
- service_name, 'resources-1', api_version)
+ service_name, 'resources-1', api_version
+ )
except UnknownServiceError:
available = self.get_available_resources()
has_low_level_client = (
- service_name in self.get_available_services())
- raise ResourceNotExistsError(service_name, available,
- has_low_level_client)
+ service_name in self.get_available_services()
+ )
+ raise ResourceNotExistsError(
+ service_name, available, has_low_level_client
+ )
except DataNotFoundError:
# This is because we've provided an invalid API version.
available_api_versions = self._loader.list_api_versions(
- service_name, 'resources-1')
+ service_name, 'resources-1'
+ )
raise UnknownAPIVersionError(
- service_name, api_version, ', '.join(available_api_versions))
+ service_name, api_version, ', '.join(available_api_versions)
+ )
if api_version is None:
# Even though botocore's load_service_model() can handle
@@ -381,7 +430,8 @@ class Session(object):
# and loader.determine_latest_version(..., 'resources-1')
# both load the same api version of the file.
api_version = self._loader.determine_latest_version(
- service_name, 'resources-1')
+ service_name, 'resources-1'
+ )
# Creating a new resource instance requires the low-level client
# and service model, the resource version and resource JSON data.
@@ -394,28 +444,35 @@ class Session(object):
else:
config = Config(user_agent_extra='Resource')
client = self.client(
- service_name, region_name=region_name, api_version=api_version,
- use_ssl=use_ssl, verify=verify, endpoint_url=endpoint_url,
+ service_name,
+ region_name=region_name,
+ api_version=api_version,
+ use_ssl=use_ssl,
+ verify=verify,
+ endpoint_url=endpoint_url,
aws_access_key_id=aws_access_key_id,
aws_secret_access_key=aws_secret_access_key,
- aws_session_token=aws_session_token, config=config)
+ aws_session_token=aws_session_token,
+ config=config,
+ )
service_model = client.meta.service_model
# Create a ServiceContext object to serve as a reference to
# important read-only information about the general service.
service_context = boto3.utils.ServiceContext(
- service_name=service_name, service_model=service_model,
+ service_name=service_name,
+ service_model=service_model,
resource_json_definitions=resource_model['resources'],
service_waiter_model=boto3.utils.LazyLoadedWaiterModel(
self._session, service_name, api_version
- )
+ ),
)
# Create the service resource class.
cls = self.resource_factory.load_from_definition(
resource_name=service_name,
single_resource_json_definition=resource_model['service'],
- service_context=service_context
+ service_context=service_context,
)
return cls(client=client)
@@ -426,40 +483,50 @@ class Session(object):
self._session.register(
'creating-client-class.s3',
boto3.utils.lazy_call(
- 'boto3.s3.inject.inject_s3_transfer_methods'))
+ 'boto3.s3.inject.inject_s3_transfer_methods'
+ ),
+ )
self._session.register(
'creating-resource-class.s3.Bucket',
- boto3.utils.lazy_call(
- 'boto3.s3.inject.inject_bucket_methods'))
+ boto3.utils.lazy_call('boto3.s3.inject.inject_bucket_methods'),
+ )
self._session.register(
'creating-resource-class.s3.Object',
- boto3.utils.lazy_call(
- 'boto3.s3.inject.inject_object_methods'))
+ boto3.utils.lazy_call('boto3.s3.inject.inject_object_methods'),
+ )
self._session.register(
'creating-resource-class.s3.ObjectSummary',
boto3.utils.lazy_call(
- 'boto3.s3.inject.inject_object_summary_methods'))
+ 'boto3.s3.inject.inject_object_summary_methods'
+ ),
+ )
# DynamoDb customizations
self._session.register(
'creating-resource-class.dynamodb',
boto3.utils.lazy_call(
- 'boto3.dynamodb.transform.register_high_level_interface'),
- unique_id='high-level-dynamodb')
+ 'boto3.dynamodb.transform.register_high_level_interface'
+ ),
+ unique_id='high-level-dynamodb',
+ )
self._session.register(
'creating-resource-class.dynamodb.Table',
boto3.utils.lazy_call(
- 'boto3.dynamodb.table.register_table_methods'),
- unique_id='high-level-dynamodb-table')
+ 'boto3.dynamodb.table.register_table_methods'
+ ),
+ unique_id='high-level-dynamodb-table',
+ )
# EC2 Customizations
self._session.register(
'creating-resource-class.ec2.ServiceResource',
- boto3.utils.lazy_call(
- 'boto3.ec2.createtags.inject_create_tags'))
+ boto3.utils.lazy_call('boto3.ec2.createtags.inject_create_tags'),
+ )
self._session.register(
'creating-resource-class.ec2.Instance',
boto3.utils.lazy_call(
'boto3.ec2.deletetags.inject_delete_tags',
- event_emitter=self.events))
+ event_emitter=self.events,
+ ),
+ )
diff --git a/contrib/python/boto3/py3/boto3/utils.py b/contrib/python/boto3/py3/boto3/utils.py
index 2d11a7eb03..27561adc90 100644
--- a/contrib/python/boto3/py3/boto3/utils.py
+++ b/contrib/python/boto3/py3/boto3/utils.py
@@ -13,11 +13,14 @@
import sys
from collections import namedtuple
-
_ServiceContext = namedtuple(
'ServiceContext',
- ['service_name', 'service_model', 'service_waiter_model',
- 'resource_json_definitions']
+ [
+ 'service_name',
+ 'service_model',
+ 'service_waiter_model',
+ 'resource_json_definitions',
+ ],
)
@@ -40,6 +43,7 @@ class ServiceContext(_ServiceContext):
shapes for a service. It is equivalient of loading a
``resource-1.json`` and retrieving the value at the key "resources".
"""
+
pass
@@ -68,13 +72,14 @@ def lazy_call(full_name, **kwargs):
def inject_attribute(class_attributes, name, value):
if name in class_attributes:
raise RuntimeError(
- 'Cannot inject class attribute "%s", attribute '
- 'already exists in class dict.' % name)
+ f'Cannot inject class attribute "{name}", attribute '
+ f'already exists in class dict.'
+ )
else:
class_attributes[name] = value
-class LazyLoadedWaiterModel(object):
+class LazyLoadedWaiterModel:
"""A lazily loaded waiter model
This does not load the service waiter model until an attempt is made
@@ -83,6 +88,7 @@ class LazyLoadedWaiterModel(object):
the waiter-2.json until it is accessed through a ``get_waiter`` call
when the docstring is generated/accessed.
"""
+
def __init__(self, bc_session, service_name, api_version):
self._session = bc_session
self._service_name = service_name
@@ -90,4 +96,5 @@ class LazyLoadedWaiterModel(object):
def get_waiter(self, waiter_name):
return self._session.get_waiter_model(
- self._service_name, self._api_version).get_waiter(waiter_name)
+ self._service_name, self._api_version
+ ).get_waiter(waiter_name)
diff --git a/contrib/python/botocore/py3/.dist-info/METADATA b/contrib/python/botocore/py3/.dist-info/METADATA
index 652c6685c6..bf92ec3de4 100644
--- a/contrib/python/botocore/py3/.dist-info/METADATA
+++ b/contrib/python/botocore/py3/.dist-info/METADATA
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: botocore
-Version: 1.23.54
+Version: 1.24.29
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services
@@ -21,11 +21,11 @@ Classifier: Programming Language :: Python :: 3.10
Requires-Python: >= 3.6
License-File: LICENSE.txt
License-File: NOTICE
-Requires-Dist: jmespath (<1.0.0,>=0.7.1)
Requires-Dist: python-dateutil (<3.0.0,>=2.1)
Requires-Dist: urllib3 (<1.27,>=1.25.4)
+Requires-Dist: jmespath (<2.0.0,>=0.7.1)
Provides-Extra: crt
-Requires-Dist: awscrt (==0.12.5) ; extra == 'crt'
+Requires-Dist: awscrt (==0.13.5) ; extra == 'crt'
botocore
========
@@ -42,12 +42,15 @@ Botocore is maintained and published by `Amazon Web Services`_.
Notices
-------
-On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped
-on 07/15/2021. To avoid disruption, customers using Botocore on Python 2.7 may
+On 2021-01-15, deprecation for Python 2.7 was announced and support was dropped
+on 2021-07-15. To avoid disruption, customers using Botocore on Python 2.7 may
need to upgrade their version of Python or pin the version of Botocore. For
more information, see this `blog post <https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-python-2-7-in-aws-sdk-for-python-and-aws-cli-v1/>`__.
-Starting in May 2022, we will be dropping support for Python 3.6. This follows the Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__ for the runtime which occurred on 2021-12-23.
+On 2022-05-30, we will be dropping support for Python 3.6. This follows the
+Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__
+for the runtime which occurred on 2021-12-23.
+For more information, see this `blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
.. _`Amazon Web Services`: https://aws.amazon.com/what-is-aws/
.. |Python| image:: https://img.shields.io/pypi/pyversions/botocore.svg?style=flat
diff --git a/contrib/python/botocore/py3/README.rst b/contrib/python/botocore/py3/README.rst
index b906d3f5bb..c823a9f20b 100644
--- a/contrib/python/botocore/py3/README.rst
+++ b/contrib/python/botocore/py3/README.rst
@@ -13,12 +13,15 @@ Botocore is maintained and published by `Amazon Web Services`_.
Notices
-------
-On 01/15/2021 deprecation for Python 2.7 was announced and support was dropped
-on 07/15/2021. To avoid disruption, customers using Botocore on Python 2.7 may
+On 2021-01-15, deprecation for Python 2.7 was announced and support was dropped
+on 2021-07-15. To avoid disruption, customers using Botocore on Python 2.7 may
need to upgrade their version of Python or pin the version of Botocore. For
more information, see this `blog post <https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-python-2-7-in-aws-sdk-for-python-and-aws-cli-v1/>`__.
-Starting in May 2022, we will be dropping support for Python 3.6. This follows the Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__ for the runtime which occurred on 2021-12-23.
+On 2022-05-30, we will be dropping support for Python 3.6. This follows the
+Python Software Foundation `end of support <https://www.python.org/dev/peps/pep-0494/#lifespan>`__
+for the runtime which occurred on 2021-12-23.
+For more information, see this `blog post <https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/>`__.
.. _`Amazon Web Services`: https://aws.amazon.com/what-is-aws/
.. |Python| image:: https://img.shields.io/pypi/pyversions/botocore.svg?style=flat
diff --git a/contrib/python/botocore/py3/botocore/__init__.py b/contrib/python/botocore/py3/botocore/__init__.py
index 70440409a0..a7d12d5158 100644
--- a/contrib/python/botocore/py3/botocore/__init__.py
+++ b/contrib/python/botocore/py3/botocore/__init__.py
@@ -12,11 +12,11 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
+import logging
import os
import re
-import logging
-__version__ = '1.23.54'
+__version__ = '1.24.29'
class NullHandler(logging.Handler):
diff --git a/contrib/python/botocore/py3/botocore/args.py b/contrib/python/botocore/py3/botocore/args.py
index d3457ae32b..3fa0b931c1 100644
--- a/contrib/python/botocore/py3/botocore/args.py
+++ b/contrib/python/botocore/py3/botocore/args.py
@@ -21,12 +21,12 @@ import logging
import socket
import botocore.exceptions
+import botocore.parsers
import botocore.serialize
import botocore.utils
-from botocore.signers import RequestSigner
from botocore.config import Config
from botocore.endpoint import EndpointCreator
-
+from botocore.signers import RequestSigner
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/auth.py b/contrib/python/botocore/py3/botocore/auth.py
index 47d9fdfb82..3ec6219d41 100644
--- a/contrib/python/botocore/py3/botocore/auth.py
+++ b/contrib/python/botocore/py3/botocore/auth.py
@@ -15,19 +15,32 @@ import base64
import calendar
import datetime
import functools
-from email.utils import formatdate
-from hashlib import sha1, sha256
import hmac
import logging
-from operator import itemgetter
import time
+from email.utils import formatdate
+from hashlib import sha1, sha256
+from operator import itemgetter
from botocore.compat import (
- encodebytes, ensure_unicode, HTTPHeaders, json, parse_qs, quote,
- six, unquote, urlsplit, urlunsplit, HAS_CRT
+ HAS_CRT,
+ HTTPHeaders,
+ encodebytes,
+ ensure_unicode,
+ json,
+ parse_qs,
+ quote,
+ six,
+ unquote,
+ urlsplit,
+ urlunsplit,
)
from botocore.exceptions import NoCredentialsError
-from botocore.utils import is_valid_ipv6_endpoint_url, normalize_url_path, percent_encode_sequence
+from botocore.utils import (
+ is_valid_ipv6_endpoint_url,
+ normalize_url_path,
+ percent_encode_sequence,
+)
# Imports for backwards compatibility
from botocore.compat import MD5_AVAILABLE # noqa
@@ -50,6 +63,7 @@ SIGNED_HEADERS_BLACKLIST = [
'x-amzn-trace-id',
]
UNSIGNED_PAYLOAD = 'UNSIGNED-PAYLOAD'
+STREAMING_UNSIGNED_PAYLOAD_TRAILER = 'STREAMING-UNSIGNED-PAYLOAD-TRAILER'
def _host_from_url(url):
@@ -286,8 +300,15 @@ class SigV4Auth(BaseSigner):
)
return ';'.join(headers)
+ def _is_streaming_checksum_payload(self, request):
+ checksum_context = request.context.get('checksum', {})
+ algorithm = checksum_context.get('request_algorithm')
+ return isinstance(algorithm, dict) and algorithm.get('in') == 'trailer'
+
def payload(self, request):
- if not self._should_sha256_sign_payload(request):
+ if self._is_streaming_checksum_payload(request):
+ return STREAMING_UNSIGNED_PAYLOAD_TRAILER
+ elif 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
@@ -459,12 +480,17 @@ class S3SigV4Auth(SigV4Auth):
if sign_payload is not None:
return sign_payload
- # We require that both content-md5 be present and https be enabled
+ # We require that both a checksum 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
+ # a checksum is sufficiently secure and durable for us to be
# confident in the request without body signing.
+ checksum_header = 'Content-MD5'
+ checksum_context = request.context.get('checksum', {})
+ algorithm = checksum_context.get('request_algorithm')
+ if isinstance(algorithm, dict) and algorithm.get('in') == 'header':
+ checksum_header = algorithm['name']
if not request.url.startswith('https') or \
- 'Content-MD5' not in request.headers:
+ checksum_header not in request.headers:
return True
# If the input is streaming we disable body signing by default.
diff --git a/contrib/python/botocore/py3/botocore/awsrequest.py b/contrib/python/botocore/py3/botocore/awsrequest.py
index 50ec62a23e..92ad0b7a2b 100644
--- a/contrib/python/botocore/py3/botocore/awsrequest.py
+++ b/contrib/python/botocore/py3/botocore/awsrequest.py
@@ -11,25 +11,26 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-import io
-import logging
import functools
+import logging
import urllib3.util
-from urllib3.connection import VerifiedHTTPSConnection
-from urllib3.connection import HTTPConnection
-from urllib3.connectionpool import HTTPConnectionPool
-from urllib3.connectionpool import HTTPSConnectionPool
+from urllib3.connection import HTTPConnection, VerifiedHTTPSConnection
+from urllib3.connectionpool import HTTPConnectionPool, HTTPSConnectionPool
import botocore.utils
-from botocore.compat import six
from botocore.compat import (
- HTTPHeaders, HTTPResponse, urlunsplit, urlsplit,
- urlencode, urlparse, MutableMapping
+ HTTPHeaders,
+ HTTPResponse,
+ MutableMapping,
+ six,
+ urlencode,
+ urlparse,
+ urlsplit,
+ urlunsplit,
)
from botocore.exceptions import UnseekableStreamError
-
logger = logging.getLogger(__name__)
@@ -397,32 +398,7 @@ class AWSRequestPreparer(object):
return body
def _determine_content_length(self, body):
- # No body, content length of 0
- if not body:
- return 0
-
- # Try asking the body for it's length
- try:
- return len(body)
- except (AttributeError, TypeError):
- pass
-
- # Try getting the length from a seekable stream
- if hasattr(body, 'seek') and hasattr(body, 'tell'):
- try:
- orig_pos = body.tell()
- body.seek(0, 2)
- end_file_pos = body.tell()
- body.seek(orig_pos)
- return end_file_pos - orig_pos
- except io.UnsupportedOperation:
- # in case when body is, for example, io.BufferedIOBase object
- # it has "seek" method which throws "UnsupportedOperation"
- # exception in such case we want to fall back to "chunked"
- # encoding
- pass
- # Failed to determine the length
- return None
+ return botocore.utils.determine_content_length(body)
class AWSRequest(object):
diff --git a/contrib/python/botocore/py3/botocore/client.py b/contrib/python/botocore/py3/botocore/client.py
index c96a513a17..a8a2944a48 100644
--- a/contrib/python/botocore/py3/botocore/client.py
+++ b/contrib/python/botocore/py3/botocore/client.py
@@ -16,27 +16,37 @@ from botocore import waiter, xform_name
from botocore.args import ClientArgsCreator
from botocore.auth import AUTH_TYPE_MAPS
from botocore.awsrequest import prepare_request_dict
-from botocore.docs.docstring import ClientMethodDocstring
-from botocore.docs.docstring import PaginatorDocstring
+from botocore.discovery import (
+ EndpointDiscoveryHandler,
+ EndpointDiscoveryManager,
+ block_endpoint_discovery_required_operations,
+)
+from botocore.docs.docstring import ClientMethodDocstring, PaginatorDocstring
from botocore.exceptions import (
- DataNotFoundError, OperationNotPageableError, UnknownSignatureVersionError,
- InvalidEndpointDiscoveryConfigurationError
+ DataNotFoundError,
+ InvalidEndpointDiscoveryConfigurationError,
+ OperationNotPageableError,
+ UnknownSignatureVersionError,
)
+from botocore.history import get_global_history_recorder
from botocore.hooks import first_non_none_response
+from botocore.httpchecksum import (
+ apply_request_checksum,
+ resolve_checksum_context,
+)
from botocore.model import ServiceModel
from botocore.paginate import Paginator
+from botocore.retries import adaptive, standard
from botocore.utils import (
- CachedProperty, get_service_module_name, S3RegionRedirector,
- S3ArnParamHandler, S3EndpointSetter, ensure_boolean,
- S3ControlArnParamHandler, S3ControlEndpointSetter,
-)
-from botocore.history import get_global_history_recorder
-from botocore.discovery import (
- EndpointDiscoveryHandler, EndpointDiscoveryManager,
- block_endpoint_discovery_required_operations
+ CachedProperty,
+ S3ArnParamHandler,
+ S3ControlArnParamHandler,
+ S3ControlEndpointSetter,
+ S3EndpointSetter,
+ S3RegionRedirector,
+ ensure_boolean,
+ get_service_module_name,
)
-from botocore.retries import standard
-from botocore.retries import adaptive
# Keep these imported. There's pre-existing code that uses:
# "from botocore.client import Config"
@@ -690,6 +700,7 @@ class BaseClient(object):
}
request_dict = self._convert_to_request_dict(
api_params, operation_model, context=request_context)
+ resolve_checksum_context(request_dict, operation_model, api_params)
service_id = self._service_model.service_id.hyphenize()
handler, event_response = self.meta.events.emit_until_response(
@@ -702,6 +713,7 @@ class BaseClient(object):
if event_response is not None:
http, parsed_response = event_response
else:
+ apply_request_checksum(request_dict)
http, parsed_response = self._make_request(
operation_model, request_dict, request_context)
diff --git a/contrib/python/botocore/py3/botocore/config.py b/contrib/python/botocore/py3/botocore/config.py
index 996464c582..dea544c19f 100644
--- a/contrib/python/botocore/py3/botocore/config.py
+++ b/contrib/python/botocore/py3/botocore/config.py
@@ -11,13 +11,15 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import copy
-from botocore.compat import OrderedDict
+from botocore.compat import OrderedDict
from botocore.endpoint import DEFAULT_TIMEOUT, MAX_POOL_CONNECTIONS
-from botocore.exceptions import InvalidS3AddressingStyleError
-from botocore.exceptions import InvalidRetryConfigurationError
-from botocore.exceptions import InvalidMaxRetryAttemptsError
-from botocore.exceptions import InvalidRetryModeError
+from botocore.exceptions import (
+ InvalidMaxRetryAttemptsError,
+ InvalidRetryConfigurationError,
+ InvalidRetryModeError,
+ InvalidS3AddressingStyleError,
+)
class Config(object):
diff --git a/contrib/python/botocore/py3/botocore/configloader.py b/contrib/python/botocore/py3/botocore/configloader.py
index f516ea111a..7adfcb5b6e 100644
--- a/contrib/python/botocore/py3/botocore/configloader.py
+++ b/contrib/python/botocore/py3/botocore/configloader.py
@@ -11,14 +11,13 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
+import copy
import os
import shlex
-import copy
import sys
-from botocore.compat import six
-
import botocore.exceptions
+from botocore.compat import six
def multi_file_load_config(*filenames):
diff --git a/contrib/python/botocore/py3/botocore/configprovider.py b/contrib/python/botocore/py3/botocore/configprovider.py
index 41cbd8afaf..e822ff2ec0 100644
--- a/contrib/python/botocore/py3/botocore/configprovider.py
+++ b/contrib/python/botocore/py3/botocore/configprovider.py
@@ -13,13 +13,12 @@
"""This module contains the inteface for controlling how configuration
is loaded.
"""
+import copy
import logging
import os
-import copy
from botocore import utils
-
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/credentials.py b/contrib/python/botocore/py3/botocore/credentials.py
index a8fc99eb7c..ca504b40f4 100644
--- a/contrib/python/botocore/py3/botocore/credentials.py
+++ b/contrib/python/botocore/py3/botocore/credentials.py
@@ -11,14 +11,14 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-import time
import datetime
-import logging
-import os
import getpass
-import threading
import json
+import logging
+import os
import subprocess
+import threading
+import time
from collections import namedtuple
from copy import deepcopy
from hashlib import sha1
@@ -27,27 +27,30 @@ from pathlib import Path
from dateutil.parser import parse
from dateutil.tz import tzlocal, tzutc
-import botocore.configloader
import botocore.compat
+import botocore.configloader
from botocore import UNSIGNED
-from botocore.compat import total_seconds
-from botocore.compat import compat_shell_split
+from botocore.compat import compat_shell_split, total_seconds
from botocore.config import Config
-from botocore.exceptions import UnknownCredentialError
-from botocore.exceptions import PartialCredentialsError
-from botocore.exceptions import ConfigNotFound
-from botocore.exceptions import InvalidConfigError
-from botocore.exceptions import InfiniteLoopConfigError
-from botocore.exceptions import RefreshWithMFAUnsupportedError
-from botocore.exceptions import MetadataRetrievalError
-from botocore.exceptions import CredentialRetrievalError
-from botocore.exceptions import UnauthorizedSSOTokenError
-from botocore.utils import InstanceMetadataFetcher, parse_key_val_file
-from botocore.utils import ContainerMetadataFetcher
-from botocore.utils import FileWebIdentityTokenLoader
-from botocore.utils import SSOTokenLoader
-from botocore.utils import resolve_imds_endpoint_mode
-
+from botocore.exceptions import (
+ ConfigNotFound,
+ CredentialRetrievalError,
+ InfiniteLoopConfigError,
+ InvalidConfigError,
+ MetadataRetrievalError,
+ PartialCredentialsError,
+ RefreshWithMFAUnsupportedError,
+ UnauthorizedSSOTokenError,
+ UnknownCredentialError,
+)
+from botocore.utils import (
+ ContainerMetadataFetcher,
+ FileWebIdentityTokenLoader,
+ InstanceMetadataFetcher,
+ SSOTokenLoader,
+ parse_key_val_file,
+ resolve_imds_endpoint_mode,
+)
logger = logging.getLogger(__name__)
ReadOnlyCredentials = namedtuple('ReadOnlyCredentials',
diff --git a/contrib/python/botocore/py3/botocore/crt/auth.py b/contrib/python/botocore/py3/botocore/crt/auth.py
index b45dd30677..a776bc1e66 100644
--- a/contrib/python/botocore/py3/botocore/crt/auth.py
+++ b/contrib/python/botocore/py3/botocore/crt/auth.py
@@ -2,12 +2,16 @@ import datetime
from io import BytesIO
from botocore.auth import (
- _host_from_url, _get_body_as_dict, BaseSigner,
- SIGNED_HEADERS_BLACKLIST, UNSIGNED_PAYLOAD
+ SIGNED_HEADERS_BLACKLIST,
+ STREAMING_UNSIGNED_PAYLOAD_TRAILER,
+ UNSIGNED_PAYLOAD,
+ BaseSigner,
+ _get_body_as_dict,
+ _host_from_url,
)
-from botocore.compat import awscrt, HTTPHeaders, parse_qs, urlsplit, urlunsplit
-from botocore.utils import percent_encode_sequence
+from botocore.compat import HTTPHeaders, awscrt, parse_qs, urlsplit, urlunsplit
from botocore.exceptions import NoCredentialsError
+from botocore.utils import percent_encode_sequence
class CrtSigV4Auth(BaseSigner):
@@ -28,6 +32,11 @@ class CrtSigV4Auth(BaseSigner):
self._region_name = region_name
self._expiration_in_seconds = None
+ def _is_streaming_checksum_payload(self, request):
+ checksum_context = request.context.get('checksum', {})
+ algorithm = checksum_context.get('request_algorithm')
+ return isinstance(algorithm, dict) and algorithm.get('in') == 'trailer'
+
def add_auth(self, request):
if self.credentials is None:
raise NoCredentialsError()
@@ -47,7 +56,9 @@ class CrtSigV4Auth(BaseSigner):
secret_access_key=self.credentials.secret_key,
session_token=self.credentials.token)
- if self._should_sha256_sign_payload(request):
+ if self._is_streaming_checksum_payload(request):
+ explicit_payload = STREAMING_UNSIGNED_PAYLOAD_TRAILER
+ elif self._should_sha256_sign_payload(request):
if existing_sha256:
explicit_payload = existing_sha256
else:
@@ -172,12 +183,17 @@ class CrtS3SigV4Auth(CrtSigV4Auth):
if sign_payload is not None:
return sign_payload
- # We require that both content-md5 be present and https be enabled
+ # We require that both a checksum 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
+ # a checksum is sufficiently secure and durable for us to be
# confident in the request without body signing.
+ checksum_header = 'Content-MD5'
+ checksum_context = request.context.get('checksum', {})
+ algorithm = checksum_context.get('request_algorithm')
+ if isinstance(algorithm, dict) and algorithm.get('in') == 'header':
+ checksum_header = algorithm['name']
if not request.url.startswith('https') or \
- 'Content-MD5' not in request.headers:
+ checksum_header not in request.headers:
return True
# If the input is streaming we disable body signing by default.
@@ -230,7 +246,9 @@ class CrtSigV4AsymAuth(BaseSigner):
secret_access_key=self.credentials.secret_key,
session_token=self.credentials.token)
- if self._should_sha256_sign_payload(request):
+ if self._is_streaming_checksum_payload(request):
+ explicit_payload = STREAMING_UNSIGNED_PAYLOAD_TRAILER
+ elif self._should_sha256_sign_payload(request):
if existing_sha256:
explicit_payload = existing_sha256
else:
@@ -313,6 +331,11 @@ class CrtSigV4AsymAuth(BaseSigner):
def _get_existing_sha256(self, request):
return request.headers.get('X-Amz-Content-SHA256')
+ def _is_streaming_checksum_payload(self, request):
+ checksum_context = request.context.get('checksum', {})
+ algorithm = checksum_context.get('request_algorithm')
+ return isinstance(algorithm, dict) and algorithm.get('in') == 'trailer'
+
def _should_sha256_sign_payload(self, request):
# Payloads will always be signed over insecure connections.
if not request.url.startswith('https'):
diff --git a/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json b/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json
index 6553776609..7099e26ae9 100644
--- a/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json
@@ -27,7 +27,7 @@
{"shape":"InvalidTagException"},
{"shape":"LimitExceededException"}
],
- "documentation":"<p>Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.</p> <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption\">Encrypting Your CRLs</a>.</p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html\">Configure Access to ACM Private CA</a>.</p> </note>",
+ "documentation":"<p>Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.</p> <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption\">Encrypting Your CRLs</a>.</p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies\">Access policies for CRLs in Amazon S3</a>.</p> </note>",
"idempotent":true
},
"CreateCertificateAuthorityAuditReport":{
@@ -46,7 +46,7 @@
{"shape":"InvalidArgsException"},
{"shape":"InvalidStateException"}
],
- "documentation":"<p>Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html\">IssueCertificate</a> and <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html\">RevokeCertificate</a> actions use the private key. </p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html\">Configure Access to ACM Private CA</a>.</p> </note> <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption\">Encrypting Your Audit Reports</a>.</p>",
+ "documentation":"<p>Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html\">IssueCertificate</a> and <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html\">RevokeCertificate</a> actions use the private key. </p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies\">Access policies for CRLs in Amazon S3</a>.</p> </note> <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption\">Encrypting Your Audit Reports</a>.</p> <note> <p>You can generate a maximum of one report every 30 minutes.</p> </note>",
"idempotent":true
},
"CreatePermission":{
@@ -64,7 +64,7 @@
{"shape":"InvalidStateException"},
{"shape":"RequestFailedException"}
],
- "documentation":"<p>Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.</p> <p>You can list current permissions with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html\">ListPermissions</a> action and revoke them with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html\">DeletePermission</a> action.</p> <p class=\"title\"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> </ul>"
+ "documentation":"<p>Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (<code>acm.amazonaws.com</code>). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.</p> <p>You can list current permissions with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html\">ListPermissions</a> action and revoke them with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html\">DeletePermission</a> action.</p> <p class=\"title\"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> </ul>"
},
"DeleteCertificateAuthority":{
"name":"DeleteCertificateAuthority",
@@ -94,7 +94,7 @@
{"shape":"InvalidStateException"},
{"shape":"RequestFailedException"}
],
- "documentation":"<p>Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). </p> <p>These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.</p> <p>Permissions can be granted with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html\">CreatePermission</a> action and listed with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html\">ListPermissions</a> action. </p> <p class=\"title\"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> </ul>"
+ "documentation":"<p>Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). </p> <p>These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.</p> <p>Permissions can be granted with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html\">CreatePermission</a> action and listed with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html\">ListPermissions</a> action. </p> <p class=\"title\"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> </ul>"
},
"DeletePolicy":{
"name":"DeletePolicy",
@@ -111,7 +111,7 @@
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"}
],
- "documentation":"<p>Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.</p> <p>If you delete a policy that was applied through AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included. </p> <p>The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. </p> <p>The current policy can be shown with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html\">GetPolicy</a> and updated with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html\">PutPolicy</a>.</p> <p class=\"title\"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> <li> <p>A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html\">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>"
+ "documentation":"<p>Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.</p> <p>If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included. </p> <p>The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. </p> <p>The current policy can be shown with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html\">GetPolicy</a> and updated with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html\">PutPolicy</a>.</p> <p class=\"title\"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> <li> <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html\">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>"
},
"DescribeCertificateAuthority":{
"name":"DescribeCertificateAuthority",
@@ -125,7 +125,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
],
- "documentation":"<p>Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <code>CREATING</code> - ACM Private CA is creating your private certificate authority.</p> </li> <li> <p> <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p> </li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> <li> <p> <code>DELETED</code> - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.</p> </li> </ul>"
+ "documentation":"<p>Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <code>CREATING</code> - ACM Private CA is creating your private certificate authority.</p> </li> <li> <p> <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p> </li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> <li> <p> <code>DELETED</code> - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.</p> </li> </ul>"
},
"DescribeCertificateAuthorityAuditReport":{
"name":"DescribeCertificateAuthorityAuditReport",
@@ -205,7 +205,7 @@
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"}
],
- "documentation":"<p>Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>. </p> <p>The policy can be attached or updated with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html\">PutPolicy</a> and removed with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html\">DeletePolicy</a>.</p> <p class=\"title\"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> <li> <p>A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html\">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>"
+ "documentation":"<p>Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a <code>ResourceNotFoundException</code>. </p> <p>The policy can be attached or updated with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html\">PutPolicy</a> and removed with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html\">DeletePolicy</a>.</p> <p class=\"title\"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> <li> <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html\">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>"
},
"ImportCertificateAuthorityCertificate":{
"name":"ImportCertificateAuthorityCertificate",
@@ -274,7 +274,7 @@
{"shape":"InvalidStateException"},
{"shape":"RequestFailedException"}
],
- "documentation":"<p>List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). </p> <p>These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA. </p> <p>Permissions can be granted with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html\">CreatePermission</a> action and revoked with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html\">DeletePermission</a> action.</p> <p class=\"title\"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> </ul>"
+ "documentation":"<p>List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). </p> <p>These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. </p> <p>Permissions can be granted with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html\">CreatePermission</a> action and revoked with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html\">DeletePermission</a> action.</p> <p class=\"title\"> <b>About Permissions</b> </p> <ul> <li> <p>If the private CA and the certificates it issues reside in the same account, you can use <code>CreatePermission</code> to grant permissions for ACM to carry out automatic certificate renewals.</p> </li> <li> <p>For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.</p> </li> <li> <p>If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> </ul>"
},
"ListTags":{
"name":"ListTags",
@@ -307,7 +307,7 @@
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"}
],
- "documentation":"<p>Attaches a resource-based policy to a private CA. </p> <p>A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM). For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> <p>The policy can be displayed with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html\">GetPolicy</a> and removed with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html\">DeletePolicy</a>.</p> <p class=\"title\"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> <li> <p>A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html\">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>"
+ "documentation":"<p>Attaches a resource-based policy to a private CA. </p> <p>A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> <p>The policy can be displayed with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html\">GetPolicy</a> and removed with <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html\">DeletePolicy</a>.</p> <p class=\"title\"> <b>About Policies</b> </p> <ul> <li> <p>A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-rbp.html\">Using a Resource Based Policy with ACM Private CA</a>.</p> </li> <li> <p>A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.</p> </li> <li> <p>For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html\">Using a Service Linked Role with ACM</a>.</p> </li> <li> <p>Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html\">Attach a Policy for Cross-Account Access</a>.</p> </li> </ul>"
},
"RestoreCertificateAuthority":{
"name":"RestoreCertificateAuthority",
@@ -341,7 +341,7 @@
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"}
],
- "documentation":"<p>Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html\">Supported CloudWatch Metrics</a>.</p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html\">Configure Access to ACM Private CA</a>.</p> </note> <p>ACM Private CA also writes revocation information to the audit report. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html\">CreateCertificateAuthorityAuditReport</a>.</p> <note> <p>You cannot revoke a root CA self-signed certificate.</p> </note>"
+ "documentation":"<p>Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics <code>CRLGenerated</code> and <code>MisconfiguredCRLBucket</code>. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html\">Supported CloudWatch Metrics</a>.</p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies\">Access policies for CRLs in Amazon S3</a>.</p> </note> <p>ACM Private CA also writes revocation information to the audit report. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html\">CreateCertificateAuthorityAuditReport</a>.</p> <note> <p>You cannot revoke a root CA self-signed certificate.</p> </note>"
},
"TagCertificateAuthority":{
"name":"TagCertificateAuthority",
@@ -357,7 +357,7 @@
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"}
],
- "documentation":"<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html\">UntagCertificateAuthority</a> action. Call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListTags.html\">ListTags</a> action to see what tags are associated with your CA. </p>"
+ "documentation":"<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html\">UntagCertificateAuthority</a> action. Call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListTags.html\">ListTags</a> action to see what tags are associated with your CA. </p>"
},
"UntagCertificateAuthority":{
"name":"UntagCertificateAuthority",
@@ -389,7 +389,7 @@
{"shape":"InvalidStateException"},
{"shape":"InvalidPolicyException"}
],
- "documentation":"<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or make a CA that is in the <code>DISABLED</code> state active again.</p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html\">Configure Access to ACM Private CA</a>.</p> </note>"
+ "documentation":"<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or make a CA that is in the <code>DISABLED</code> state active again.</p> <note> <p>Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html#s3-policies\">Access policies for CRLs in Amazon S3</a>.</p> </note>"
}
},
"shapes":{
@@ -457,6 +457,10 @@
"GenerationQualifier":{
"shape":"String3",
"documentation":"<p>Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.</p>"
+ },
+ "CustomAttributes":{
+ "shape":"CustomAttributeList",
+ "documentation":"<p/> <p>Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of <a href=\"https://csrc.nist.gov/glossary/term/Object_Identifier\">Object Identifier (OID)</a>.</p> <note> <p>Custom attributes cannot be used in combination with standard attributes.</p> </note>"
}
},
"documentation":"<p>Contains information about the certificate subject. The <code>Subject</code> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <code>Subject </code>must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.</p>"
@@ -483,7 +487,7 @@
"documentation":"<p>The location of <code>AccessDescription</code> information.</p>"
}
},
- "documentation":"<p>Provides access information used by the <code>authorityInfoAccess</code> and <code>subjectInfoAccess</code> extensions described in <a href=\"https://tools.ietf.org/html/rfc5280\">RFC 5280</a>.</p>",
+ "documentation":"<p>Provides access information used by the <code>authorityInfoAccess</code> and <code>subjectInfoAccess</code> extensions described in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280\">RFC 5280</a>.</p>",
"box":true
},
"AccessDescriptionList":{
@@ -570,6 +574,12 @@
"FAILED"
]
},
+ "Base64String1To4096":{
+ "type":"string",
+ "max":4096,
+ "min":1,
+ "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
+ },
"Boolean":{"type":"boolean"},
"CertificateAuthorities":{
"type":"list",
@@ -584,7 +594,7 @@
},
"OwnerAccount":{
"shape":"AccountId",
- "documentation":"<p>The AWS account ID that owns the certificate authority.</p>"
+ "documentation":"<p>The Amazon Web Services account ID that owns the certificate authority.</p>"
},
"CreatedAt":{
"shape":"TStamp",
@@ -632,10 +642,10 @@
},
"KeyStorageSecurityStandard":{
"shape":"KeyStorageSecurityStandard",
- "documentation":"<p>Defines a cryptographic key management compliance standard used for handling CA keys. </p> <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p> <p>Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an <code>InvalidArgsException</code> with the message \"A certificate authority cannot be created in this region with the specified security standard.\"</p>"
+ "documentation":"<p>Defines a cryptographic key management compliance standard used for handling CA keys. </p> <p>Default: FIPS_140_2_LEVEL_3_OR_HIGHER</p> <p>Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an <code>InvalidArgsException</code> with the message \"A certificate authority cannot be created in this region with the specified security standard.\"</p>"
}
},
- "documentation":"<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html\">CreateCertificateAuthority</a> action to create your private CA. You must then call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCertificate.html\">GetCertificateAuthorityCertificate</a> action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html\">ImportCertificateAuthorityCertificate</a> action to import the signed certificate into AWS Certificate Manager (ACM). </p>"
+ "documentation":"<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html\">CreateCertificateAuthority</a> action to create your private CA. You must then call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCertificate.html\">GetCertificateAuthorityCertificate</a> action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html\">ImportCertificateAuthorityCertificate</a> action to import the signed certificate into Certificate Manager (ACM). </p>"
},
"CertificateAuthorityConfiguration":{
"type":"structure",
@@ -814,7 +824,7 @@
},
"Principal":{
"shape":"Principal",
- "documentation":"<p>The AWS service or identity that receives the permission. At this time, the only valid principal is <code>acm.amazonaws.com</code>.</p>"
+ "documentation":"<p>The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is <code>acm.amazonaws.com</code>.</p>"
},
"SourceAccount":{
"shape":"AccountId",
@@ -822,7 +832,7 @@
},
"Actions":{
"shape":"ActionList",
- "documentation":"<p>The actions that the specified AWS service principal can use. These include <code>IssueCertificate</code>, <code>GetCertificate</code>, and <code>ListPermissions</code>.</p>"
+ "documentation":"<p>The actions that the specified Amazon Web Services service principal can use. These include <code>IssueCertificate</code>, <code>GetCertificate</code>, and <code>ListPermissions</code>.</p>"
}
}
},
@@ -853,7 +863,7 @@
"documentation":"<p>Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access. </p> <p>If no value is specified, the default is <code>PUBLIC_READ</code>.</p> <p> <i>Note:</i> This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as <code>BUCKET_OWNER_FULL_CONTROL</code>, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either <code>BUCKET_OWNER_FULL_CONTROL</code> or <code>PUBLIC_READ</code> as the value.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa\">Blocking public access to the S3 bucket</a>.</p>"
}
},
- "documentation":"<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA. </p> <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption\">Encrypting Your CRLs</a>.</p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.</p> <p>A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.</p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html\">Planning a certificate revocation list (CRL)</a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i> </p>"
+ "documentation":"<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA. </p> <p>ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption\">Encrypting Your CRLs</a>.</p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.</p> <p>A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.</p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html\">Planning a certificate revocation list (CRL)</a> in the <i>Certificate Manager Private Certificate Authority (PCA) User Guide</i> </p>"
},
"CsrBlob":{
"type":"blob",
@@ -870,11 +880,64 @@
},
"SubjectInformationAccess":{
"shape":"AccessDescriptionList",
- "documentation":"<p>For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see <a href=\"https://tools.ietf.org/html/rfc5280#section-4.2.2.2\">Subject Information Access</a> in RFC 5280.</p>"
+ "documentation":"<p>For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2\">Subject Information Access</a> in RFC 5280.</p>"
}
},
"documentation":"<p>Describes the certificate extensions to be added to the certificate signing request (CSR).</p>"
},
+ "CustomAttribute":{
+ "type":"structure",
+ "required":[
+ "ObjectIdentifier",
+ "Value"
+ ],
+ "members":{
+ "ObjectIdentifier":{
+ "shape":"CustomObjectIdentifier",
+ "documentation":"<p>Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).</p>"
+ },
+ "Value":{
+ "shape":"String1To256",
+ "documentation":"<p/> <p>Specifies the attribute value of relative distinguished name (RDN).</p>"
+ }
+ },
+ "documentation":"<p>Defines the X.500 relative distinguished name (RDN).</p>"
+ },
+ "CustomAttributeList":{
+ "type":"list",
+ "member":{"shape":"CustomAttribute"},
+ "max":30,
+ "min":1
+ },
+ "CustomExtension":{
+ "type":"structure",
+ "required":[
+ "ObjectIdentifier",
+ "Value"
+ ],
+ "members":{
+ "ObjectIdentifier":{
+ "shape":"CustomObjectIdentifier",
+ "documentation":"<p/> <p>Specifies the object identifier (OID) of the X.509 extension. For more information, see the <a href=\"https://oidref.com/2.5.29\">Global OID reference database.</a> </p>"
+ },
+ "Value":{
+ "shape":"Base64String1To4096",
+ "documentation":"<p/> <p>Specifies the base64-encoded value of the X.509 extension.</p>"
+ },
+ "Critical":{
+ "shape":"Boolean",
+ "documentation":"<p/> <p>Specifies the critical flag of the X.509 extension.</p>",
+ "box":true
+ }
+ },
+ "documentation":"<p/> <p>Specifies the X.509 extension information for a certificate.</p> <p>Extensions present in <code>CustomExtensions</code> follow the <code>ApiPassthrough</code> <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html#template-order-of-operations\">template rules</a>. </p>"
+ },
+ "CustomExtensionList":{
+ "type":"list",
+ "member":{"shape":"CustomExtension"},
+ "max":20,
+ "min":1
+ },
"CustomObjectIdentifier":{
"type":"string",
"max":64,
@@ -908,11 +971,11 @@
},
"Principal":{
"shape":"Principal",
- "documentation":"<p>The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is <code>acm.amazonaws.com</code> </p>"
+ "documentation":"<p>The Amazon Web Services service or identity that will have its CA permissions revoked. At this time, the only valid service principal is <code>acm.amazonaws.com</code> </p>"
},
"SourceAccount":{
"shape":"AccountId",
- "documentation":"<p>The AWS account that calls this action.</p>"
+ "documentation":"<p>The Amazon Web Services account that calls this action.</p>"
}
}
},
@@ -996,14 +1059,14 @@
"documentation":"<p>Specifies the name assigner.</p>"
}
},
- "documentation":"<p>Describes an Electronic Data Interchange (EDI) entity as described in as defined in <a href=\"https://tools.ietf.org/html/rfc5280\">Subject Alternative Name</a> in RFC 5280.</p>"
+ "documentation":"<p>Describes an Electronic Data Interchange (EDI) entity as described in as defined in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280\">Subject Alternative Name</a> in RFC 5280.</p>"
},
"ExtendedKeyUsage":{
"type":"structure",
"members":{
"ExtendedKeyUsageType":{
"shape":"ExtendedKeyUsageType",
- "documentation":"<p>Specifies a standard <code>ExtendedKeyUsage</code> as defined as in <a href=\"https://tools.ietf.org/html/rfc5280#section-4.2.1.12\">RFC 5280</a>.</p>"
+ "documentation":"<p>Specifies a standard <code>ExtendedKeyUsage</code> as defined as in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12\">RFC 5280</a>.</p>"
},
"ExtendedKeyUsageObjectIdentifier":{
"shape":"CustomObjectIdentifier",
@@ -1047,6 +1110,10 @@
"SubjectAlternativeNames":{
"shape":"GeneralNameList",
"documentation":"<p>The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.</p>"
+ },
+ "CustomExtensions":{
+ "shape":"CustomExtensionList",
+ "documentation":"<p/> <p>Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the <a href=\"https://oidref.com/2.5.29\">Global OID reference database.</a> </p> <note> <p>The OID value of a <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CustomExtension.html\">CustomExtension</a> must not match the OID of a predefined extension.</p> </note>"
}
},
"documentation":"<p>Contains X.509 extension information for a certificate.</p>"
@@ -1068,7 +1135,7 @@
},
"Rfc822Name":{
"shape":"String256",
- "documentation":"<p>Represents <code>GeneralName</code> as an <a href=\"https://tools.ietf.org/html/rfc822\">RFC 822</a> email address.</p>"
+ "documentation":"<p>Represents <code>GeneralName</code> as an <a href=\"https://datatracker.ietf.org/doc/html/rfc822\">RFC 822</a> email address.</p>"
},
"DnsName":{
"shape":"String253",
@@ -1092,7 +1159,7 @@
"documentation":"<p> Represents <code>GeneralName</code> as an object identifier (OID).</p>"
}
},
- "documentation":"<p>Describes an ASN.1 X.400 <code>GeneralName</code> as defined in <a href=\"https://tools.ietf.org/html/rfc5280\">RFC 5280</a>. Only one of the following naming options should be provided. Providing more than one option results in an <code>InvalidArgsException</code> error.</p>"
+ "documentation":"<p>Describes an ASN.1 X.400 <code>GeneralName</code> as defined in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280\">RFC 5280</a>. Only one of the following naming options should be provided. Providing more than one option results in an <code>InvalidArgsException</code> error.</p>"
},
"GeneralNameList":{
"type":"list",
@@ -1298,11 +1365,11 @@
},
"Csr":{
"shape":"CsrBlob",
- "documentation":"<p>The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key. </p> <p> <code>openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>If you have a configuration file, you can then use the following OpenSSL command. The <code>usr_cert</code> block in the configuration file contains your X509 version 3 extensions. </p> <p> <code>openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>Note: A CSR must provide either a <i>subject name</i> or a <i>subject alternative name</i> or the request will be rejected. </p>"
+ "documentation":"<p>The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key. </p> <p> <code>openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>If you have a configuration file, you can then use the following OpenSSL command. The <code>usr_cert</code> block in the configuration file contains your X509 version 3 extensions. </p> <p> <code>openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>Note: A CSR must provide either a <i>subject name</i> or a <i>subject alternative name</i> or the request will be rejected. </p>"
},
"SigningAlgorithm":{
"shape":"SigningAlgorithm",
- "documentation":"<p>The name of the algorithm that will be used to sign the certificate to be issued. </p> <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p>"
+ "documentation":"<p>The name of the algorithm that will be used to sign the certificate to be issued. </p> <p>This parameter should not be confused with the <code>SigningAlgorithm</code> parameter used to sign a CSR in the <code>CreateCertificateAuthority</code> action.</p> <note> <p>The specified signing algorithm family (RSA or ECDSA) much match the algorithm family of the CA's secret key.</p> </note>"
},
"TemplateArn":{
"shape":"Arn",
@@ -1310,11 +1377,11 @@
},
"Validity":{
"shape":"Validity",
- "documentation":"<p>Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.</p> <p>Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see <a href=\"https://tools.ietf.org/html/rfc5280#section-4.1.2.5\">Validity</a> in RFC 5280. </p> <p>This value is unaffected when <code>ValidityNotBefore</code> is also specified. For example, if <code>Validity</code> is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the <code>ValidityNotBefore</code> value.</p> <p>The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.</p>"
+ "documentation":"<p>Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.</p> <p>Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5\">Validity</a> in RFC 5280. </p> <p>This value is unaffected when <code>ValidityNotBefore</code> is also specified. For example, if <code>Validity</code> is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the <code>ValidityNotBefore</code> value.</p> <p>The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.</p>"
},
"ValidityNotBefore":{
"shape":"Validity",
- "documentation":"<p>Information describing the start of the validity period of the certificate. This parameter sets the “Not Before\" date for the certificate.</p> <p>By default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The <code>ValidityNotBefore</code> parameter can be used to customize the “Not Before” value. </p> <p>Unlike the <code>Validity</code> parameter, the <code>ValidityNotBefore</code> parameter is optional.</p> <p>The <code>ValidityNotBefore</code> value is expressed as an explicit date and time, using the <code>Validity</code> type value <code>ABSOLUTE</code>. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html\">Validity</a> in this API reference and <a href=\"https://tools.ietf.org/html/rfc5280#section-4.1.2.5\">Validity</a> in RFC 5280.</p>"
+ "documentation":"<p>Information describing the start of the validity period of the certificate. This parameter sets the “Not Before\" date for the certificate.</p> <p>By default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The <code>ValidityNotBefore</code> parameter can be used to customize the “Not Before” value. </p> <p>Unlike the <code>Validity</code> parameter, the <code>ValidityNotBefore</code> parameter is optional.</p> <p>The <code>ValidityNotBefore</code> value is expressed as an explicit date and time, using the <code>Validity</code> type value <code>ABSOLUTE</code>. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html\">Validity</a> in this API reference and <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5\">Validity</a> in RFC 5280.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
@@ -1534,7 +1601,7 @@
},
"OcspCustomCname":{
"shape":"String253",
- "documentation":"<p>By default, ACM Private CA injects an AWS domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.</p> <p>Note: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html\">Customizing Online Certificate Status Protocol (OCSP) </a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i>.</p>"
+ "documentation":"<p>By default, ACM Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.</p> <p>Note: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/ocsp-customize.html\">Customizing Online Certificate Status Protocol (OCSP) </a> in the <i>Certificate Manager Private Certificate Authority (PCA) User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.</p> <p>When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.</p>"
@@ -1575,7 +1642,7 @@
},
"Principal":{
"shape":"Principal",
- "documentation":"<p>The AWS service or entity that holds the permission. At this time, the only valid principal is <code>acm.amazonaws.com</code>.</p>"
+ "documentation":"<p>The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is <code>acm.amazonaws.com</code>.</p>"
},
"SourceAccount":{
"shape":"AccountId",
@@ -1583,14 +1650,14 @@
},
"Actions":{
"shape":"ActionList",
- "documentation":"<p>The private CA actions that can be performed by the designated AWS service.</p>"
+ "documentation":"<p>The private CA actions that can be performed by the designated Amazon Web Services service.</p>"
},
"Policy":{
"shape":"AWSPolicy",
"documentation":"<p>The name of the policy that is associated with the permission.</p>"
}
},
- "documentation":"<p>Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (<code>IssueCertificate</code>, <code>GetCertificate</code>, and <code>ListPermissions</code>). Permissions can be assigned with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html\">CreatePermission</a> action, removed with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html\">DeletePermission</a> action, and listed with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html\">ListPermissions</a> action.</p>"
+ "documentation":"<p>Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (<code>IssueCertificate</code>, <code>GetCertificate</code>, and <code>ListPermissions</code>). Permissions can be assigned with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html\">CreatePermission</a> action, removed with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html\">DeletePermission</a> action, and listed with the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html\">ListPermissions</a> action.</p>"
},
"PermissionAlreadyExistsException":{
"type":"structure",
@@ -1684,7 +1751,7 @@
"documentation":"<p>Contains a pointer to a certification practice statement (CPS) published by the CA.</p>"
}
},
- "documentation":"<p>Defines a <code>PolicyInformation</code> qualifier. ACM Private CA supports the <a href=\"https://tools.ietf.org/html/rfc5280#section-4.2.1.4\">certification practice statement (CPS) qualifier</a> defined in RFC 5280. </p>"
+ "documentation":"<p>Defines a <code>PolicyInformation</code> qualifier. ACM Private CA supports the <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4\">certification practice statement (CPS) qualifier</a> defined in RFC 5280. </p>"
},
"RequestAlreadyProcessedException":{
"type":"structure",
@@ -1747,7 +1814,7 @@
"documentation":"<p>Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.</p>"
}
},
- "documentation":"<p>Certificate revocation information used by the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html\">CreateCertificateAuthority</a> and <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html\">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html\">RevokeCertificate</a> and <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html\">Setting up a certificate revocation method</a> in the <i>AWS Certificate Manager Private Certificate Authority (PCA) User Guide</i>.</p>"
+ "documentation":"<p>Certificate revocation information used by the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html\">CreateCertificateAuthority</a> and <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html\">UpdateCertificateAuthority</a> actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html\">RevokeCertificate</a> and <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/revocation-setup.html\">Setting up a certificate revocation method</a> in the <i>Certificate Manager Private Certificate Authority (PCA) User Guide</i>.</p>"
},
"RevocationReason":{
"type":"string",
@@ -1776,7 +1843,7 @@
},
"CertificateSerial":{
"shape":"String128",
- "documentation":"<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html\">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html\">DescribeCertificate</a> action in the <i>AWS Certificate Manager API Reference</i>. </p>"
+ "documentation":"<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html\">GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html\">DescribeCertificate</a> action in the <i>Certificate Manager API Reference</i>. </p>"
},
"RevocationReason":{
"shape":"RevocationReason",
@@ -1822,6 +1889,11 @@
"max":16,
"min":0
},
+ "String1To256":{
+ "type":"string",
+ "max":256,
+ "min":1
+ },
"String253":{
"type":"string",
"max":253,
@@ -1973,7 +2045,7 @@
"documentation":"<p>Determines how <i>ACM Private CA</i> interprets the <code>Value</code> parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output. </p> <p> <code>END_DATE</code>: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.</p> <ul> <li> <p>Sample input value: 491231235959 (UTCTime format)</p> </li> <li> <p>Output expiration date/time: 12/31/2049 23:59:59</p> </li> </ul> <p> <code>ABSOLUTE</code>: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch. </p> <ul> <li> <p>Sample input value: 2524608000</p> </li> <li> <p>Output expiration date/time: 01/01/2050 00:00:00</p> </li> </ul> <p> <code>DAYS</code>, <code>MONTHS</code>, <code>YEARS</code>: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years. </p> <p>Example if <code>DAYS</code>, issued on 10/12/2020 at 12:34:54 UTC:</p> <ul> <li> <p>Sample input value: 90</p> </li> <li> <p>Output expiration date: 01/10/2020 12:34:54 UTC</p> </li> </ul> <p>The minimum validity duration for a certificate using relative time (<code>DAYS</code>) is one day. The minimum validity for a certificate using absolute time (<code>ABSOLUTE</code> or <code>END_DATE</code>) is one second.</p>"
}
},
- "documentation":"<p>Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see <a href=\"https://tools.ietf.org/html/rfc5280#section-4.1.2.5\">Validity</a> in RFC 5280.</p> <p>ACM Private CA API consumes the <code>Validity</code> data type differently in two distinct parameters of the <code>IssueCertificate</code> action. The required parameter <code>IssueCertificate</code>:<code>Validity</code> specifies the end of a certificate's validity period. The optional parameter <code>IssueCertificate</code>:<code>ValidityNotBefore</code> specifies a customized starting time for the validity period.</p>"
+ "documentation":"<p>Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5\">Validity</a> in RFC 5280.</p> <p>ACM Private CA API consumes the <code>Validity</code> data type differently in two distinct parameters of the <code>IssueCertificate</code> action. The required parameter <code>IssueCertificate</code>:<code>Validity</code> specifies the end of a certificate's validity period. The optional parameter <code>IssueCertificate</code>:<code>ValidityNotBefore</code> specifies a customized starting time for the validity period.</p>"
},
"ValidityPeriodType":{
"type":"string",
@@ -1986,5 +2058,5 @@
]
}
},
- "documentation":"<p>This is the <i>ACM Private CA API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.</p> <p>The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"https://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>Each ACM Private CA API operation has a quota that determines the number of times the operation can be called per second. ACM Private CA throttles API requests at different rates depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, ACM Private CA returns a <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html\">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase, log into your AWS account and visit the <a href=\"https://console.aws.amazon.com/servicequotas/\">Service Quotas</a> console.</p>"
+ "documentation":"<p>This is the <i>Certificate Manager Private Certificate Authority (PCA) API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href=\"https://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p> <p>Each ACM Private CA API operation has a quota that determines the number of times the operation can be called per second. ACM Private CA throttles API requests at different rates depending on the operation. Throttling means that ACM Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, ACM Private CA returns a <a href=\"https://docs.aws.amazon.com/acm-pca/latest/APIReference/CommonErrors.html\">ThrottlingException</a> error. ACM Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your ACM Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href=\"https://console.aws.amazon.com/servicequotas/\">Service Quotas</a> console.</p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json
index ed3e0c9026..65b0b2252e 100644
--- a/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json
@@ -627,6 +627,7 @@
"type":"string",
"max":255,
"min":1,
+ "pattern":"(?s).+",
"sensitive":true
},
"ActiveJobId":{
@@ -672,7 +673,7 @@
},
"repository":{
"shape":"Repository",
- "documentation":"<p> The repository for the Amplify app. </p>"
+ "documentation":"<p> The Git repository for the Amplify app. </p>"
},
"platform":{
"shape":"Platform",
@@ -741,6 +742,10 @@
"autoBranchCreationConfig":{
"shape":"AutoBranchCreationConfig",
"documentation":"<p> Describes the automated branch creation configuration for the Amplify app. </p>"
+ },
+ "repositoryCloneMethod":{
+ "shape":"RepositoryCloneMethod",
+ "documentation":"<p>The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify <code>TOKEN</code>. For an Amazon Web Services CodeCommit repository, specify <code>SIGV4</code>. For GitLab and Bitbucket repositories, specify <code>SSH</code>.</p>"
}
},
"documentation":"<p> Represents the different branches of a repository for building, deploying, and hosting an Amplify app. </p>"
@@ -783,7 +788,8 @@
},
"ArtifactId":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"ArtifactUrl":{
"type":"string",
@@ -855,7 +861,8 @@
"AutoBranchCreationPattern":{
"type":"string",
"max":2048,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"AutoBranchCreationPatterns":{
"type":"list",
@@ -864,7 +871,8 @@
"AutoSubDomainCreationPattern":{
"type":"string",
"max":2048,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"AutoSubDomainCreationPatterns":{
"type":"list",
@@ -914,7 +922,8 @@
"BackendEnvironmentArn":{
"type":"string",
"max":1000,
- "min":1
+ "min":0,
+ "pattern":"(?s).*"
},
"BackendEnvironments":{
"type":"list",
@@ -932,6 +941,7 @@
"BasicAuthCredentials":{
"type":"string",
"max":2000,
+ "pattern":"(?s).*",
"sensitive":true
},
"Branch":{
@@ -1069,12 +1079,14 @@
},
"BranchArn":{
"type":"string",
- "max":1000
+ "max":1000,
+ "pattern":"(?s).*"
},
"BranchName":{
"type":"string",
"max":255,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"Branches":{
"type":"list",
@@ -1085,7 +1097,9 @@
"type":"string",
"documentation":"<p> The build specification (build spec) file for an Amplify app build. </p>",
"max":25000,
- "min":1
+ "min":1,
+ "pattern":"(?s).+",
+ "sensitive":true
},
"CertificateVerificationDNSRecord":{
"type":"string",
@@ -1094,17 +1108,20 @@
"Code":{"type":"string"},
"CommitId":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"CommitMessage":{
"type":"string",
- "max":10000
+ "max":10000,
+ "pattern":"(?s).*"
},
"CommitTime":{"type":"timestamp"},
"Condition":{
"type":"string",
"max":2048,
- "min":1
+ "min":0,
+ "pattern":"(?s).*"
},
"Context":{"type":"string"},
"CreateAppRequest":{
@@ -1475,7 +1492,8 @@
"CustomHeaders":{
"type":"string",
"max":25000,
- "min":1
+ "min":0,
+ "pattern":"(?s).*"
},
"CustomRule":{
"type":"structure",
@@ -1705,15 +1723,18 @@
"DeploymentArtifacts":{
"type":"string",
"max":1000,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"Description":{
"type":"string",
- "max":1000
+ "max":1000,
+ "pattern":"(?s).*"
},
"DisplayName":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"DomainAssociation":{
"type":"structure",
@@ -1776,11 +1797,13 @@
},
"DomainName":{
"type":"string",
- "max":255
+ "max":64,
+ "pattern":"^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$"
},
"DomainPrefix":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"DomainStatus":{
"type":"string",
@@ -1807,16 +1830,19 @@
"EndTime":{"type":"timestamp"},
"EnvKey":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"EnvValue":{
"type":"string",
- "max":1000
+ "max":5500,
+ "pattern":"(?s).*"
},
"EnvironmentName":{
"type":"string",
"max":255,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"EnvironmentVariables":{
"type":"map",
@@ -1834,7 +1860,8 @@
},
"FileName":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"FileUploadUrls":{
"type":"map",
@@ -1843,7 +1870,8 @@
},
"Framework":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"GenerateAccessLogsRequest":{
"type":"structure",
@@ -2123,11 +2151,13 @@
},
"JobId":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"[0-9]+"
},
"JobReason":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"JobStatus":{
"type":"string",
@@ -2550,7 +2580,8 @@
},
"MD5Hash":{
"type":"string",
- "max":32
+ "max":32,
+ "pattern":"(?s).*"
},
"MaxResults":{
"type":"integer",
@@ -2560,11 +2591,13 @@
"Name":{
"type":"string",
"max":255,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"NextToken":{
"type":"string",
- "max":2000
+ "max":2000,
+ "pattern":"(?s).*"
},
"NotFoundException":{
"type":"structure",
@@ -2578,11 +2611,15 @@
"OauthToken":{
"type":"string",
"max":1000,
+ "pattern":"(?s).*",
"sensitive":true
},
"Platform":{
"type":"string",
- "enum":["WEB"]
+ "enum":[
+ "WEB",
+ "WEB_DYNAMIC"
+ ]
},
"ProductionBranch":{
"type":"structure",
@@ -2608,14 +2645,26 @@
},
"PullRequestEnvironmentName":{
"type":"string",
- "max":20
+ "max":20,
+ "pattern":"(?s).*"
},
"Repository":{
"type":"string",
- "max":1000
+ "max":1000,
+ "pattern":"(?s).*"
+ },
+ "RepositoryCloneMethod":{
+ "type":"string",
+ "enum":[
+ "SSH",
+ "TOKEN",
+ "SIGV4"
+ ]
},
"ResourceArn":{
"type":"string",
+ "max":2048,
+ "min":0,
"pattern":"^arn:aws:amplify:.*"
},
"ResourceNotFoundException":{
@@ -2640,21 +2689,25 @@
"ServiceRoleArn":{
"type":"string",
"max":1000,
- "min":1
+ "min":0,
+ "pattern":"(?s).*"
},
"Source":{
"type":"string",
"max":2048,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"SourceUrl":{
"type":"string",
- "max":1000
+ "max":3000,
+ "pattern":"(?s).*"
},
"StackName":{
"type":"string",
"max":255,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"Stage":{
"type":"string",
@@ -2769,7 +2822,8 @@
"Status":{
"type":"string",
"max":7,
- "min":3
+ "min":3,
+ "pattern":".{3,7}"
},
"StatusReason":{
"type":"string",
@@ -2932,7 +2986,10 @@
},
"TTL":{
"type":"string",
- "documentation":"<p> The content Time to Live (TTL) for the website in seconds. </p>"
+ "documentation":"<p> The content Time to Live (TTL) for the website in seconds. </p>",
+ "max":32,
+ "min":0,
+ "pattern":"\\d*"
},
"TagKey":{
"type":"string",
@@ -2951,7 +3008,7 @@
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50,
- "min":1
+ "min":0
},
"TagResourceRequest":{
"type":"structure",
@@ -2981,12 +3038,14 @@
},
"TagValue":{
"type":"string",
- "max":256
+ "max":256,
+ "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"Target":{
"type":"string",
"max":2048,
- "min":1
+ "min":1,
+ "pattern":"(?s).+"
},
"TestArtifactsUrl":{
"type":"string",
@@ -3239,8 +3298,7 @@
"type":"structure",
"required":[
"appId",
- "domainName",
- "subDomainSettings"
+ "domainName"
],
"members":{
"appId":{
@@ -3372,7 +3430,8 @@
},
"WebhookId":{
"type":"string",
- "max":255
+ "max":255,
+ "pattern":"(?s).*"
},
"WebhookUrl":{
"type":"string",
diff --git a/contrib/python/botocore/py3/botocore/data/amplifybackend/2020-08-11/service-2.json b/contrib/python/botocore/py3/botocore/data/amplifybackend/2020-08-11/service-2.json
index f5824a85ee..af875286ad 100644
--- a/contrib/python/botocore/py3/botocore/data/amplifybackend/2020-08-11/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/amplifybackend/2020-08-11/service-2.json
@@ -1753,20 +1753,20 @@
"DeliveryMethod": {
"shape": "DeliveryMethod",
"locationName": "deliveryMethod",
- "documentation": "<p>Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>"
},
"EmailSettings": {
"shape": "EmailSettings",
"locationName": "emailSettings",
- "documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>"
},
"SmsSettings": {
"shape": "SmsSettings",
"locationName": "smsSettings",
- "documentation": "<p>The configuration for the SMS message sent when an app user forgets their password.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an app user forgets their password.</p>"
}
},
- "documentation": "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>",
+ "documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>",
"required": [
"DeliveryMethod"
]
@@ -2001,7 +2001,7 @@
"ForgotPassword": {
"shape": "CreateBackendAuthForgotPasswordConfig",
"locationName": "forgotPassword",
- "documentation": "<p>Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
},
"Mfa": {
"shape": "CreateBackendAuthMFAConfig",
@@ -2032,6 +2032,11 @@
"shape": "__string",
"locationName": "userPoolName",
"documentation": "<p>The Amazon Cognito user pool name.</p>"
+ },
+ "VerificationMessage": {
+ "shape": "CreateBackendAuthVerificationMessageConfig",
+ "locationName": "verificationMessage",
+ "documentation": "<p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
}
},
"documentation": "<p>Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.</p>",
@@ -2041,6 +2046,30 @@
"UserPoolName"
]
},
+ "CreateBackendAuthVerificationMessageConfig": {
+ "type": "structure",
+ "members": {
+ "DeliveryMethod": {
+ "shape": "DeliveryMethod",
+ "locationName": "deliveryMethod",
+ "documentation": "<p>The type of verification message to send.</p>"
+ },
+ "EmailSettings": {
+ "shape": "EmailSettings",
+ "locationName": "emailSettings",
+ "documentation": "<p>The settings for the email message.</p>"
+ },
+ "SmsSettings": {
+ "shape": "SmsSettings",
+ "locationName": "smsSettings",
+ "documentation": "<p>The settings for the SMS message.</p>"
+ }
+ },
+ "documentation": "<p>Creates an email or SMS verification message for the auth resource configured for your Amplify project.</p>",
+ "required": [
+ "DeliveryMethod"
+ ]
+ },
"CreateBackendConfigReqObj": {
"type": "structure",
"members": {
@@ -2147,7 +2176,7 @@
"ResourceConfig": {
"shape": "ResourceConfig",
"locationName": "resourceConfig",
- "documentation": "<p>The resource configuration for creating backend storage.</p>"
+ "documentation": "<p>The resource configuration for creating a backend.</p>"
},
"ResourceName": {
"shape": "__string",
@@ -2183,7 +2212,7 @@
"ResourceConfig": {
"shape": "ResourceConfig",
"locationName": "resourceConfig",
- "documentation": "<p>The resource configuration for creating backend storage.</p>"
+ "documentation": "<p>The resource configuration for creating a backend.</p>"
},
"ResourceName": {
"shape": "__string",
@@ -2786,6 +2815,7 @@
},
"DeliveryMethod": {
"type": "string",
+ "documentation": "<p>The type of verification message to send.</p>",
"enum": [
"EMAIL",
"SMS"
@@ -2797,12 +2827,12 @@
"EmailMessage": {
"shape": "__string",
"locationName": "emailMessage",
- "documentation": "<p>The body of the email.</p>"
+ "documentation": "<p>The contents of the email message.</p>"
},
"EmailSubject": {
"shape": "__string",
"locationName": "emailSubject",
- "documentation": "<p>The subject of the email.</p>"
+ "documentation": "<p>The contents of the subject line of the email message.</p>"
}
},
"documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>"
@@ -4229,7 +4259,7 @@
"SmsMessage": {
"shape": "__string",
"locationName": "smsMessage",
- "documentation": "<p>The body of the SMS message.</p>"
+ "documentation": "<p>The contents of the SMS message.</p>"
}
},
"documentation": "<p>SMS settings for authentication.</p>"
@@ -4353,20 +4383,20 @@
"DeliveryMethod": {
"shape": "DeliveryMethod",
"locationName": "deliveryMethod",
- "documentation": "<p>Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
},
"EmailSettings": {
"shape": "EmailSettings",
"locationName": "emailSettings",
- "documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>"
},
"SmsSettings": {
"shape": "SmsSettings",
"locationName": "smsSettings",
- "documentation": "<p>The configuration for the SMS message sent when an Amplify app user forgets their password.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an Amplify app user forgets their password.</p>"
}
},
- "documentation": "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>"
},
"UpdateBackendAuthIdentityPoolConfig": {
"type": "structure",
@@ -4572,7 +4602,7 @@
"ForgotPassword": {
"shape": "UpdateBackendAuthForgotPasswordConfig",
"locationName": "forgotPassword",
- "documentation": "<p>Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
+ "documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
},
"Mfa": {
"shape": "UpdateBackendAuthMFAConfig",
@@ -4588,10 +4618,39 @@
"shape": "UpdateBackendAuthPasswordPolicyConfig",
"locationName": "passwordPolicy",
"documentation": "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
+ },
+ "VerificationMessage": {
+ "shape": "UpdateBackendAuthVerificationMessageConfig",
+ "locationName": "verificationMessage",
+ "documentation": "<p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
}
},
"documentation": "<p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>"
},
+ "UpdateBackendAuthVerificationMessageConfig": {
+ "type": "structure",
+ "members": {
+ "DeliveryMethod": {
+ "shape": "DeliveryMethod",
+ "locationName": "deliveryMethod",
+ "documentation": "<p>The type of verification message to send.</p>"
+ },
+ "EmailSettings": {
+ "shape": "EmailSettings",
+ "locationName": "emailSettings",
+ "documentation": "<p>The settings for the email message.</p>"
+ },
+ "SmsSettings": {
+ "shape": "SmsSettings",
+ "locationName": "smsSettings",
+ "documentation": "<p>The settings for the SMS message.</p>"
+ }
+ },
+ "documentation": "<p>Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.</p>",
+ "required": [
+ "DeliveryMethod"
+ ]
+ },
"UpdateBackendConfigReqObj": {
"type": "structure",
"members": {
diff --git a/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/paginators-1.json b/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/paginators-1.json
index 7cb8a4b8a8..a962404840 100644
--- a/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/paginators-1.json
@@ -11,6 +11,16 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "entities"
+ },
+ "ExportComponents": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "result_key": "entities"
+ },
+ "ExportThemes": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "result_key": "entities"
}
}
}
diff --git a/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/service-2.json b/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/service-2.json
index 341b149796..c6ef0a47ff 100644
--- a/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/amplifyuibuilder/2021-08-11/service-2.json
@@ -236,6 +236,48 @@
}
},
"shapes":{
+ "ActionParameters":{
+ "type":"structure",
+ "members":{
+ "anchor":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>The HTML anchor link to the location to open. Specify this value for a navigation action.</p>"
+ },
+ "fields":{
+ "shape":"ComponentProperties",
+ "documentation":"<p>A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.</p>"
+ },
+ "global":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.</p>"
+ },
+ "id":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>The unique ID of the component that the <code>ActionParameters</code> apply to.</p>"
+ },
+ "model":{
+ "shape":"String",
+ "documentation":"<p>The name of the data model. Use when the action performs an operation on an Amplify DataStore model.</p>"
+ },
+ "state":{
+ "shape":"MutationActionSetStateParameter",
+ "documentation":"<p>A key-value pair that specifies the state property name and its initial value.</p>"
+ },
+ "target":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>The element within the same component to modify when the action occurs.</p>"
+ },
+ "type":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>. This value is required for a navigation action.</p>"
+ },
+ "url":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>The URL to the location to open. Specify this value for a navigation action.</p>"
+ }
+ },
+ "documentation":"<p>Represents the event action configuration for an element of a <code>Component</code> or <code>ComponentChild</code>. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. <code>ActionParameters</code> defines the action that is performed when an event occurs on the component.</p>"
+ },
"Boolean":{
"type":"boolean",
"box":true
@@ -261,7 +303,7 @@
},
"bindingProperties":{
"shape":"ComponentBindingProperties",
- "documentation":"<p>The information to connect a component's properties to data at runtime.</p>"
+ "documentation":"<p>The information to connect a component's properties to data at runtime. You can't specify <code>tags</code> as a valid property for <code>bindingProperties</code>.</p> <p/>"
},
"children":{
"shape":"ComponentChildList",
@@ -269,7 +311,7 @@
},
"collectionProperties":{
"shape":"ComponentCollectionProperties",
- "documentation":"<p>The data binding configuration for the component's properties. Use this for a collection component.</p>"
+ "documentation":"<p>The data binding configuration for the component's properties. Use this for a collection component. You can't specify <code>tags</code> as a valid property for <code>collectionProperties</code>.</p>"
},
"componentType":{
"shape":"ComponentType",
@@ -283,6 +325,10 @@
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>"
},
+ "events":{
+ "shape":"ComponentEvents",
+ "documentation":"<p>Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"
+ },
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component.</p>"
@@ -297,11 +343,15 @@
},
"overrides":{
"shape":"ComponentOverrides",
- "documentation":"<p>Describes the component's properties that can be overriden in a customized instance of the component.</p>"
+ "documentation":"<p>Describes the component's properties that can be overriden in a customized instance of the component. You can't specify <code>tags</code> as a valid property for <code>overrides</code>.</p>"
},
"properties":{
"shape":"ComponentProperties",
- "documentation":"<p>Describes the component's properties.</p>"
+ "documentation":"<p>Describes the component's properties. You can't specify <code>tags</code> as a valid property for <code>properties</code>.</p>"
+ },
+ "schemaVersion":{
+ "shape":"String",
+ "documentation":"<p>The schema version of the component when it was imported.</p>"
},
"sourceId":{
"shape":"String",
@@ -391,13 +441,17 @@
"shape":"String",
"documentation":"<p>The type of the child component. </p>"
},
+ "events":{
+ "shape":"ComponentEvents",
+ "documentation":"<p>Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"
+ },
"name":{
"shape":"String",
"documentation":"<p>The name of the child component.</p>"
},
"properties":{
"shape":"ComponentProperties",
- "documentation":"<p>Describes the properties of the child component.</p>"
+ "documentation":"<p>Describes the properties of the child component. You can't specify <code>tags</code> as a valid property for <code>properties</code>.</p>"
}
},
"documentation":"<p>A nested UI configuration within a parent <code>Component</code>.</p>"
@@ -426,6 +480,10 @@
"shape":"String",
"documentation":"<p>The value of the property to evaluate.</p>"
},
+ "operandType":{
+ "shape":"String",
+ "documentation":"<p>The type of the property to evaluate.</p>"
+ },
"operator":{
"shape":"String",
"documentation":"<p>The operator to use to perform the evaluation, such as <code>eq</code> to represent equals.</p>"
@@ -464,6 +522,25 @@
},
"documentation":"<p>Describes the configuration for binding a component's properties to data.</p>"
},
+ "ComponentEvent":{
+ "type":"structure",
+ "members":{
+ "action":{
+ "shape":"String",
+ "documentation":"<p>The action to perform when a specific event is raised.</p>"
+ },
+ "parameters":{
+ "shape":"ActionParameters",
+ "documentation":"<p>Describes information about the action.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration of an event. You can bind an event and a corresponding action to a <code>Component</code> or a <code>ComponentChild</code>. A button click is an example of an event. </p>"
+ },
+ "ComponentEvents":{
+ "type":"map",
+ "key":{"shape":"String"},
+ "value":{"shape":"ComponentEvent"}
+ },
"ComponentList":{
"type":"list",
"member":{"shape":"Component"}
@@ -503,13 +580,17 @@
"shape":"ComponentPropertyBindingProperties",
"documentation":"<p>The information to bind the component property to data at runtime. Use this for collection components.</p>"
},
+ "componentName":{
+ "shape":"String",
+ "documentation":"<p>The name of the component that is affected by an event.</p>"
+ },
"concat":{
"shape":"ComponentPropertyList",
"documentation":"<p>A list of component properties to concatenate to create the value to assign to this component property.</p>"
},
"condition":{
"shape":"ComponentConditionProperty",
- "documentation":"<p>The conditional expression to use to assign a value to the component property..</p>"
+ "documentation":"<p>The conditional expression to use to assign a value to the component property.</p>"
},
"configured":{
"shape":"Boolean",
@@ -525,12 +606,16 @@
},
"importedValue":{
"shape":"String",
- "documentation":"<p>The default value assigned to property when the component is imported into an app.</p>"
+ "documentation":"<p>The default value assigned to the property when the component is imported into an app.</p>"
},
"model":{
"shape":"String",
"documentation":"<p>The data model to use to assign a value to the component property.</p>"
},
+ "property":{
+ "shape":"String",
+ "documentation":"<p>The name of the component's property that is affected by an event.</p>"
+ },
"type":{
"shape":"String",
"documentation":"<p>The component type.</p>"
@@ -612,11 +697,11 @@
"members":{
"overrides":{
"shape":"ComponentOverrides",
- "documentation":"<p>The properties of the component variant that can be overriden when customizing an instance of the component.</p>"
+ "documentation":"<p>The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify <code>tags</code> as a valid property for <code>overrides</code>.</p>"
},
"variantValues":{
"shape":"ComponentVariantValues",
- "documentation":"<p>The combination of variants that comprise this variant.</p>"
+ "documentation":"<p>The combination of variants that comprise this variant. You can't specify <code>tags</code> as a valid property for <code>variantValues</code>.</p>"
}
},
"documentation":"<p>Describes the style configuration of a unique variation of a main component.</p>"
@@ -657,6 +742,10 @@
"shape":"ComponentType",
"documentation":"<p>The component type. This can be an Amplify custom UI component or another custom component.</p>"
},
+ "events":{
+ "shape":"ComponentEvents",
+ "documentation":"<p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"
+ },
"name":{
"shape":"ComponentName",
"documentation":"<p>The name of the component</p>"
@@ -669,6 +758,10 @@
"shape":"ComponentProperties",
"documentation":"<p>Describes the component's properties.</p>"
},
+ "schemaVersion":{
+ "shape":"String",
+ "documentation":"<p>The schema version of the component when it was imported.</p>"
+ },
"sourceId":{
"shape":"String",
"documentation":"<p>The unique ID of the component in its original source system, such as Figma.</p>"
@@ -932,6 +1025,12 @@
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
+ },
+ "nextToken":{
+ "shape":"String",
+ "documentation":"<p>The token to request the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"nextToken"
}
}
},
@@ -942,6 +1041,10 @@
"entities":{
"shape":"ComponentList",
"documentation":"<p>Represents the configuration of the exported components.</p>"
+ },
+ "nextToken":{
+ "shape":"String",
+ "documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
@@ -963,6 +1066,12 @@
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
+ },
+ "nextToken":{
+ "shape":"String",
+ "documentation":"<p>The token to request the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"nextToken"
}
}
},
@@ -973,6 +1082,10 @@
"entities":{
"shape":"ThemeList",
"documentation":"<p>Represents the configuration of the exported themes.</p>"
+ },
+ "nextToken":{
+ "shape":"String",
+ "documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
@@ -1209,6 +1322,29 @@
}
}
},
+ "MutationActionSetStateParameter":{
+ "type":"structure",
+ "required":[
+ "componentName",
+ "property",
+ "set"
+ ],
+ "members":{
+ "componentName":{
+ "shape":"String",
+ "documentation":"<p>The name of the component that is being modified.</p>"
+ },
+ "property":{
+ "shape":"String",
+ "documentation":"<p>The name of the component property to apply the state configuration to.</p>"
+ },
+ "set":{
+ "shape":"ComponentProperty",
+ "documentation":"<p>The state configuration to assign to the property.</p>"
+ }
+ },
+ "documentation":"<p>Represents the state configuration when an action modifies a property of another element within the same component.</p>"
+ },
"Predicate":{
"type":"structure",
"members":{
@@ -1535,6 +1671,10 @@
"shape":"ComponentType",
"documentation":"<p>The type of the component. This can be an Amplify custom UI component or another custom component.</p>"
},
+ "events":{
+ "shape":"ComponentEvents",
+ "documentation":"<p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"
+ },
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component to update.</p>"
@@ -1551,6 +1691,10 @@
"shape":"ComponentProperties",
"documentation":"<p>Describes the component's properties.</p>"
},
+ "schemaVersion":{
+ "shape":"String",
+ "documentation":"<p>The schema version of the component when it was imported.</p>"
+ },
"sourceId":{
"shape":"String",
"documentation":"<p>The unique ID of the component in its original source system, such as Figma.</p>"
@@ -1689,5 +1833,5 @@
},
"Uuid":{"type":"string"}
},
- "documentation":"<p>The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.</p> <p>You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see <a href=\"https://docs.amplify.aws/console/adminui/intro\">Introduction</a> in the <i>Amplify Docs</i>.</p> <p>The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework</a>. For more information about deploying an Amplify application to Amazon Web Services, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify Console User Guide</a>.</p>"
+ "documentation":"<p>The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.</p> <p>You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see <a href=\"https://docs.amplify.aws/console/adminui/intro\">Introduction</a> in the <i>Amplify Docs</i>.</p> <p>The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework</a>. For more information about deploying an Amplify application to Amazon Web Services, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify User Guide</a>.</p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/appflow/2020-08-23/service-2.json b/contrib/python/botocore/py3/botocore/data/appflow/2020-08-23/service-2.json
index 5997af0c30..3348c04059 100644
--- a/contrib/python/botocore/py3/botocore/data/appflow/2020-08-23/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/appflow/2020-08-23/service-2.json
@@ -2176,9 +2176,17 @@
"shape":"ZendeskDestinationProperties",
"documentation":"<p>The properties required to query Zendesk.</p>"
},
+ "Marketo":{
+ "shape":"MarketoDestinationProperties",
+ "documentation":"<p>The properties required to query Marketo.</p>"
+ },
"CustomConnector":{
"shape":"CustomConnectorDestinationProperties",
"documentation":"<p>The properties that are required to query the custom Connector.</p>"
+ },
+ "SAPOData":{
+ "shape":"SAPODataDestinationProperties",
+ "documentation":"<p>The properties required to query SAPOData.</p>"
}
},
"documentation":"<p> This stores the information that is required to query a particular connector. </p>"
@@ -3060,6 +3068,18 @@
},
"documentation":"<p> The connector-specific profile properties required when using Marketo. </p>"
},
+ "MarketoDestinationProperties":{
+ "type":"structure",
+ "required":["object"],
+ "members":{
+ "object":{
+ "shape":"Object",
+ "documentation":"<p>The object specified in the Marketo flow destination.</p>"
+ },
+ "errorHandlingConfig":{"shape":"ErrorHandlingConfig"}
+ },
+ "documentation":"<p>The properties that Amazon AppFlow applies when you use Marketo as a flow destination.</p>"
+ },
"MarketoMetadata":{
"type":"structure",
"members":{
@@ -3762,6 +3782,24 @@
},
"documentation":"<p> The connector-specific profile properties required when using SAPOData. </p>"
},
+ "SAPODataDestinationProperties":{
+ "type":"structure",
+ "required":["objectPath"],
+ "members":{
+ "objectPath":{
+ "shape":"Object",
+ "documentation":"<p>The object path specified in the SAPOData flow destination.</p>"
+ },
+ "successResponseHandlingConfig":{
+ "shape":"SuccessResponseHandlingConfig",
+ "documentation":"<p>Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.</p> <p>For example, this setting would determine where to write the response from a destination connector upon a successful insert operation.</p>"
+ },
+ "idFieldNames":{"shape":"IdFieldNameList"},
+ "errorHandlingConfig":{"shape":"ErrorHandlingConfig"},
+ "writeOperationType":{"shape":"WriteOperationType"}
+ },
+ "documentation":"<p>The properties that are applied when using SAPOData as a flow destination</p>"
+ },
"SAPODataMetadata":{
"type":"structure",
"members":{
@@ -4444,6 +4482,20 @@
"max":2048,
"pattern":".*"
},
+ "SuccessResponseHandlingConfig":{
+ "type":"structure",
+ "members":{
+ "bucketPrefix":{
+ "shape":"BucketPrefix",
+ "documentation":"<p>The Amazon S3 bucket prefix.</p>"
+ },
+ "bucketName":{
+ "shape":"BucketName",
+ "documentation":"<p>The name of the Amazon S3 bucket.</p>"
+ }
+ },
+ "documentation":"<p>Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.</p> <p>For example, this setting would determine where to write the response from the destination connector upon a successful insert operation.</p>"
+ },
"SupportedApiVersion":{
"type":"string",
"max":256,
@@ -4568,6 +4620,7 @@
"Map_all",
"Mask",
"Merge",
+ "Passthrough",
"Truncate",
"Validate"
]
diff --git a/contrib/python/botocore/py3/botocore/data/apprunner/2020-05-15/service-2.json b/contrib/python/botocore/py3/botocore/data/apprunner/2020-05-15/service-2.json
index b579aa78af..64a9470bf6 100644
--- a/contrib/python/botocore/py3/botocore/data/apprunner/2020-05-15/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/apprunner/2020-05-15/service-2.json
@@ -1732,7 +1732,10 @@
"type":"string",
"enum":[
"PYTHON_3",
- "NODEJS_12"
+ "NODEJS_12",
+ "NODEJS_14",
+ "CORRETTO_8",
+ "CORRETTO_11"
]
},
"RuntimeEnvironmentVariables":{
diff --git a/contrib/python/botocore/py3/botocore/data/athena/2017-05-18/service-2.json b/contrib/python/botocore/py3/botocore/data/athena/2017-05-18/service-2.json
index 8e5b3fc347..c8820e8d35 100644
--- a/contrib/python/botocore/py3/botocore/data/athena/2017-05-18/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/athena/2017-05-18/service-2.json
@@ -240,7 +240,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
- "documentation":"<p>Streams the results of a single query execution specified by <code>QueryExecutionId</code> from the Athena query results location in Amazon S3. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p> <p>If the original query execution ran using an <a>ResultConfiguration$ExpectedBucketOwner</a> setting, the setting also applies to Amazon S3 read operations when <code>GetQueryResults</code> is called. If an expected bucket owner has been specified and the query results are in an Amazon S3 bucket whose owner account ID is different from the expected bucket owner, the <code>GetQueryResults</code> call fails with an Amazon S3 permissions error.</p> <p>To stream query results successfully, the IAM principal with permission to call <code>GetQueryResults</code> also must have permissions to the Amazon S3 <code>GetObject</code> action for the Athena query results location.</p> <important> <p>IAM principals with permission to the Amazon S3 <code>GetObject</code> action for the query results location are able to retrieve query results from Amazon S3 even if permission to the <code>GetQueryResults</code> action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.</p> </important>"
+ "documentation":"<p>Streams the results of a single query execution specified by <code>QueryExecutionId</code> from the Athena query results location in Amazon S3. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p> <p>To stream query results successfully, the IAM principal with permission to call <code>GetQueryResults</code> also must have permissions to the Amazon S3 <code>GetObject</code> action for the Athena query results location.</p> <important> <p>IAM principals with permission to the Amazon S3 <code>GetObject</code> action for the query results location are able to retrieve query results from Amazon S3 even if permission to the <code>GetQueryResults</code> action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.</p> </important>"
},
"GetTableMetadata":{
"name":"GetTableMetadata",
@@ -475,6 +475,21 @@
],
"documentation":"<p>Updates the data catalog that has the specified name.</p>"
},
+ "UpdateNamedQuery":{
+ "name":"UpdateNamedQuery",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"UpdateNamedQueryInput"},
+ "output":{"shape":"UpdateNamedQueryOutput"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"InvalidRequestException"}
+ ],
+ "documentation":"<p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be updated.</p>",
+ "idempotent":true
+ },
"UpdatePreparedStatement":{
"name":"UpdatePreparedStatement",
"http":{
@@ -506,6 +521,17 @@
}
},
"shapes":{
+ "AclConfiguration":{
+ "type":"structure",
+ "required":["S3AclOption"],
+ "members":{
+ "S3AclOption":{
+ "shape":"S3AclOption",
+ "documentation":"<p>The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl\">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ }
+ },
+ "documentation":"<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the <code>x-amz-acl</code> request header. For more information about S3 Object Ownership, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview\">Object Ownership settings</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
"AmazonResourceName":{
"type":"string",
"max":1011,
@@ -516,10 +542,14 @@
"members":{
"ErrorCategory":{
"shape":"ErrorCategory",
- "documentation":"<p>An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.</p> <p> <b>1</b> - System</p> <p> <b>2</b> - User</p> <p> <b>3</b> - Unknown</p>"
+ "documentation":"<p>An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.</p> <p> <b>1</b> - System</p> <p> <b>2</b> - User</p> <p> <b>3</b> - Other</p>"
+ },
+ "ErrorType":{
+ "shape":"ErrorType",
+ "documentation":"<p>An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the <a href=\"https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference\">Error Type Reference</a> in the <i>Amazon Athena User Guide</i>.</p>"
}
},
- "documentation":"<p>Provides information about an Athena query error. The <code>AthenaError</code> feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies whether the cause of the failed query is due to system error, user error, or unknown error.</p>"
+ "documentation":"<p>Provides information about an Athena query error. The <code>AthenaError</code> feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies whether the cause of the failed query is due to system error, user error, or other error.</p>"
},
"BatchGetNamedQueryInput":{
"type":"structure",
@@ -1030,6 +1060,12 @@
"min":1
},
"ErrorMessage":{"type":"string"},
+ "ErrorType":{
+ "type":"integer",
+ "box":true,
+ "max":9999,
+ "min":0
+ },
"ExpressionString":{
"type":"string",
"max":256,
@@ -1627,7 +1663,7 @@
},
"QueryString":{
"shape":"QueryString",
- "documentation":"<p>The SQL query statements that comprise the query.</p>"
+ "documentation":"<p>The SQL statements that make up the query.</p>"
},
"NamedQueryId":{
"shape":"NamedQueryId",
@@ -1638,7 +1674,12 @@
"documentation":"<p>The name of the workgroup that contains the named query.</p>"
}
},
- "documentation":"<p>A query, where <code>QueryString</code> is the list of SQL query statements that comprise the query.</p>"
+ "documentation":"<p>A query, where <code>QueryString</code> contains the SQL statements that make up the query.</p>"
+ },
+ "NamedQueryDescriptionString":{
+ "type":"string",
+ "max":1024,
+ "min":0
},
"NamedQueryId":{"type":"string"},
"NamedQueryIdList":{
@@ -1871,6 +1912,10 @@
"ExpectedBucketOwner":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>. If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it makes Amazon S3 calls to your specified output location. If the <code>ExpectedBucketOwner</code> Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.</p> <p>This is a client-side setting. If workgroup settings override client-side settings, then the query uses the <code>ExpectedBucketOwner</code> setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
+ },
+ "AclConfiguration":{
+ "shape":"AclConfiguration",
+ "documentation":"<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is <code>BUCKET_OWNER_FULL_CONTROL</code>. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.</p>"
@@ -1884,7 +1929,7 @@
},
"RemoveOutputLocation":{
"shape":"BoxedBoolean",
- "documentation":"<p>If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the <code>OutputLocation</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>OutputLocation</code> in the workgroup's <code>ResultConfiguration</code> is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
+ "documentation":"<p>If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the <code>OutputLocation</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>OutputLocation</code> in the workgroup's <code>ResultConfiguration</code> will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
@@ -1892,7 +1937,7 @@
},
"RemoveEncryptionConfiguration":{
"shape":"BoxedBoolean",
- "documentation":"<p>If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the <code>EncryptionConfiguration</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>EncryptionConfiguration</code> in the workgroup's <code>ResultConfiguration</code> is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
+ "documentation":"<p>If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the <code>EncryptionConfiguration</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>EncryptionConfiguration</code> in the workgroup's <code>ResultConfiguration</code> will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"ExpectedBucketOwner":{
"shape":"String",
@@ -1901,6 +1946,14 @@
"RemoveExpectedBucketOwner":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to \"true\", removes the Amazon Web Services account ID previously specified for <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to \"false\" or not set, and a value is present in the <code>ExpectedBucketOwner</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>ExpectedBucketOwner</code> in the workgroup's <code>ResultConfiguration</code> is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
+ },
+ "AclConfiguration":{
+ "shape":"AclConfiguration",
+ "documentation":"<p>The ACL configuration for the query results.</p>"
+ },
+ "RemoveAclConfiguration":{
+ "shape":"BoxedBoolean",
+ "documentation":"<p>If set to <code>true</code>, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to <code>false</code> or not set, and a value is present in the <code>AclConfiguration</code> of <code>ResultConfigurationUpdates</code>, the <code>AclConfiguration</code> in the workgroup's <code>ResultConfiguration</code> is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The information about the updates in the query results, such as output location and encryption configuration for the query results.</p>"
@@ -1917,7 +1970,7 @@
"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. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>"
+ "documentation":"<p>The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>"
},
"ResultSetMetadata":{
"type":"structure",
@@ -1937,12 +1990,16 @@
"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>"
+ "documentation":"<p>The rows that make up a query result table.</p>"
},
"RowList":{
"type":"list",
"member":{"shape":"Row"}
},
+ "S3AclOption":{
+ "type":"string",
+ "enum":["BUCKET_OWNER_FULL_CONTROL"]
+ },
"StartQueryExecutionInput":{
"type":"structure",
"required":["QueryString"],
@@ -2229,6 +2286,37 @@
"members":{
}
},
+ "UpdateNamedQueryInput":{
+ "type":"structure",
+ "required":[
+ "NamedQueryId",
+ "Name",
+ "QueryString"
+ ],
+ "members":{
+ "NamedQueryId":{
+ "shape":"NamedQueryId",
+ "documentation":"<p>The unique identifier (UUID) of the query.</p>"
+ },
+ "Name":{
+ "shape":"NameString",
+ "documentation":"<p>The name of the query.</p>"
+ },
+ "Description":{
+ "shape":"NamedQueryDescriptionString",
+ "documentation":"<p>The query description.</p>"
+ },
+ "QueryString":{
+ "shape":"QueryString",
+ "documentation":"<p>The contents of the query with all query statements.</p>"
+ }
+ }
+ },
+ "UpdateNamedQueryOutput":{
+ "type":"structure",
+ "members":{
+ }
+ },
"UpdatePreparedStatementInput":{
"type":"structure",
"required":[
diff --git a/contrib/python/botocore/py3/botocore/data/auditmanager/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/auditmanager/2017-07-25/service-2.json
index a867ca6eee..c7fd62b070 100644
--- a/contrib/python/botocore/py3/botocore/data/auditmanager/2017-07-25/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/auditmanager/2017-07-25/service-2.json
@@ -4447,8 +4447,8 @@
"SnsArn":{
"type":"string",
"max":2048,
- "min":20,
- "pattern":"^arn:.*:sns:.*"
+ "min":4,
+ "pattern":"^arn:.*:sns:.*|NONE"
},
"SourceDescription":{
"type":"string",
diff --git a/contrib/python/botocore/py3/botocore/data/autoscaling/2011-01-01/service-2.json b/contrib/python/botocore/py3/botocore/data/autoscaling/2011-01-01/service-2.json
index df94cd899b..61005c8ab8 100644
--- a/contrib/python/botocore/py3/botocore/data/autoscaling/2011-01-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/autoscaling/2011-01-01/service-2.json
@@ -124,7 +124,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
- "documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, send a callback by using the <a>CompleteLifecycleAction</a> API call.</b> </p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
+ "documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.</p> </li> <li> <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, send a callback by using the <a>CompleteLifecycleAction</a> API call.</b> </p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CreateAutoScalingGroup":{
"name":"CreateAutoScalingGroup",
@@ -757,7 +757,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
- "documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p> <p>A lifecycle hook enables an Auto Scaling group to be aware of events in the Auto Scaling instance lifecycle, and then perform a custom action when the corresponding lifecycle event occurs.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using the <a>RecordLifecycleActionHeartbeat</a> API call.</p> </li> <li> <p>If you finish before the timeout period ends, send a callback by using the <a>CompleteLifecycleAction</a> API call.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.</p> <p>You can view the lifecycle hooks for an Auto Scaling group using the <a>DescribeLifecycleHooks</a> API call. If you are no longer using a lifecycle hook, you can delete it by calling the <a>DeleteLifecycleHook</a> API.</p>"
+ "documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p> <p>Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.</p> </li> <li> <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the <a>RecordLifecycleActionHeartbeat</a> API call.</p> </li> <li> <p>If you finish before the timeout period ends, send a callback by using the <a>CompleteLifecycleAction</a> API call.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.</p> <p>You can view the lifecycle hooks for an Auto Scaling group using the <a>DescribeLifecycleHooks</a> API call. If you are no longer using a lifecycle hook, you can delete it by calling the <a>DeleteLifecycleHook</a> API.</p>"
},
"PutNotificationConfiguration":{
"name":"PutNotificationConfiguration",
@@ -836,7 +836,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
- "documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the <a>PutLifecycleHook</a> API call.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, send a callback by using the <a>CompleteLifecycleAction</a> API call.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
+ "documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the <a>PutLifecycleHook</a> API call.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.</p> </li> <li> <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, send a callback by using the <a>CompleteLifecycleAction</a> API call.</p> </li> </ol> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ResumeProcesses":{
"name":"ResumeProcesses",
@@ -1812,7 +1812,7 @@
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
- "documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. The default value is <code>0</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: Required if you are adding an <code>ELB</code> health check.</p>"
+ "documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. The default value is <code>0</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Required if you are adding an <code>ELB</code> health check.</p>"
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
@@ -3089,11 +3089,11 @@
},
"SpotMaxPricePercentageOverLowestPrice":{
"shape":"NullablePositiveInteger",
- "documentation":"<p>The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as <code>999999</code>. </p> <p>Default: <code>100</code> </p>"
+ "documentation":"<p>The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as <code>999999</code>. </p> <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price. </p> <p>Default: <code>100</code> </p>"
},
"OnDemandMaxPricePercentageOverLowestPrice":{
"shape":"NullablePositiveInteger",
- "documentation":"<p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as <code>999999</code>. </p> <p>Default: <code>20</code> </p>"
+ "documentation":"<p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as <code>999999</code>. </p> <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price. </p> <p>Default: <code>20</code> </p>"
},
"BareMetal":{
"shape":"BareMetal",
@@ -3150,6 +3150,16 @@
},
"documentation":"<p>When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.</p> <p>Represents requirements for the types of instances that can be launched. You must specify <code>VCpuCount</code> and <code>MemoryMiB</code>, but all other parameters are optional. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html\">Creating an Auto Scaling group using attribute-based instance type selection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
+ "InstanceReusePolicy":{
+ "type":"structure",
+ "members":{
+ "ReuseOnScaleIn":{
+ "shape":"ReuseOnScaleIn",
+ "documentation":"<p>Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in. </p>"
+ }
+ },
+ "documentation":"<p>Describes an instance reuse policy for a warm pool. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html\">Warm pools for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
+ },
"Instances":{
"type":"list",
"member":{"shape":"Instance"}
@@ -3379,11 +3389,11 @@
},
"WeightedCapacity":{
"shape":"XmlStringMaxLen32",
- "documentation":"<p>The number of capacity units provided by the instance type specified in <code>InstanceType</code> in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a <code>WeightedCapacity</code> of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see <a href=\"https://docs.aws.amazon.com/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html\">Instance weighting for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the range of 1–999.</p>"
+ "documentation":"<p>The number of capacity units provided by the instance type specified in <code>InstanceType</code> in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a <code>WeightedCapacity</code> of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html\">Configuring instance weighting for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the range of 1–999.</p>"
},
"LaunchTemplateSpecification":{
"shape":"LaunchTemplateSpecification",
- "documentation":"<p>Provides the launch template to be used when launching the instance type specified in <code>InstanceType</code>. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances policy. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html\">Specifying a different launch template for an instance type</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>"
+ "documentation":"<p>Provides a launch template for the specified instance type or instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances policy. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html\">Specifying a different launch template for an instance type</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>"
},
"InstanceRequirements":{
"shape":"InstanceRequirements",
@@ -3437,7 +3447,7 @@
},
"RoleARN":{
"shape":"XmlStringMaxLen255",
- "documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>"
+ "documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).</p>"
},
"NotificationMetadata":{
"shape":"XmlStringMaxLen1023",
@@ -3456,7 +3466,7 @@
"documentation":"<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are <code>CONTINUE</code> and <code>ABANDON</code>.</p>"
}
},
- "documentation":"<p>Describes a lifecycle hook, which enables an Auto Scaling group to be aware of events in the Auto Scaling instance lifecycle, and then perform a custom action when the corresponding lifecycle event occurs.</p>"
+ "documentation":"<p>Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.</p>"
},
"LifecycleHookNames":{
"type":"list",
@@ -3496,7 +3506,7 @@
},
"RoleARN":{
"shape":"XmlStringMaxLen255",
- "documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p>"
+ "documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p> <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.</p>"
}
},
"documentation":"<p>Describes information used to specify a lifecycle hook for an Auto Scaling group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling lifecycle hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
@@ -3533,7 +3543,8 @@
"Warmed:Terminating:Proceed",
"Warmed:Terminated",
"Warmed:Stopped",
- "Warmed:Running"
+ "Warmed:Running",
+ "Warmed:Hibernated"
]
},
"LifecycleTransition":{"type":"string"},
@@ -3980,7 +3991,7 @@
"members":{
"PredefinedMetricType":{
"shape":"MetricType",
- "documentation":"<p>The metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - Average number of bytes received on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed per target in an Application Load Balancer target group.</p> </li> </ul>"
+ "documentation":"<p>The metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - Average number of bytes received (per instance per minute) for the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of bytes sent out (per instance per minute) for the Auto Scaling group.</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count (per target per minute) for your Auto Scaling group.</p> </li> </ul>"
},
"ResourceLabel":{
"shape":"XmlStringMaxLen1023",
@@ -4230,7 +4241,7 @@
},
"RoleARN":{
"shape":"XmlStringMaxLen255",
- "documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p> <p>Required for new lifecycle hooks, but optional when updating existing hooks.</p>"
+ "documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p> <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.</p>"
},
"NotificationTargetARN":{
"shape":"NotificationTargetResourceName",
@@ -4410,6 +4421,10 @@
"PoolState":{
"shape":"WarmPoolState",
"documentation":"<p>Sets the instance state to transition to after the lifecycle actions are complete. Default is <code>Stopped</code>.</p>"
+ },
+ "InstanceReusePolicy":{
+ "shape":"InstanceReusePolicy",
+ "documentation":"<p>Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.</p>"
}
}
},
@@ -4516,6 +4531,7 @@
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"ReturnData":{"type":"boolean"},
+ "ReuseOnScaleIn":{"type":"boolean"},
"ScalingActivityInProgressFault":{
"type":"structure",
"members":{
@@ -5023,7 +5039,7 @@
},
"TargetValue":{
"shape":"MetricScale",
- "documentation":"<p>The target value for the metric.</p>"
+ "documentation":"<p>The target value for the metric.</p> <note> <p>Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval. </p> </note>"
},
"DisableScaleIn":{
"shape":"DisableScaleIn",
@@ -5114,7 +5130,7 @@
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
- "documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. The default value is <code>0</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: Required if you are adding an <code>ELB</code> health check.</p>"
+ "documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. The default value is <code>0</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Required if you are adding an <code>ELB</code> health check.</p>"
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
@@ -5191,6 +5207,10 @@
"Status":{
"shape":"WarmPoolStatus",
"documentation":"<p>The status of a warm pool that is marked for deletion.</p>"
+ },
+ "InstanceReusePolicy":{
+ "shape":"InstanceReusePolicy",
+ "documentation":"<p>The instance reuse policy.</p>"
}
},
"documentation":"<p>Describes a warm pool configuration. </p>"
@@ -5204,7 +5224,8 @@
"type":"string",
"enum":[
"Stopped",
- "Running"
+ "Running",
+ "Hibernated"
]
},
"WarmPoolStatus":{
diff --git a/contrib/python/botocore/py3/botocore/data/backup/2018-11-15/service-2.json b/contrib/python/botocore/py3/botocore/data/backup/2018-11-15/service-2.json
index 1cf39da43a..3a9bc05d89 100644
--- a/contrib/python/botocore/py3/botocore/data/backup/2018-11-15/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/backup/2018-11-15/service-2.json
@@ -44,7 +44,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
- "documentation":"<p>Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see <a href=\"https://docs.aws.amazon.com/assigning-resources.html#assigning-resources-json\">Assigning resources programmatically</a>. </p>",
+ "documentation":"<p>Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json\">Assigning resources programmatically</a>. </p>",
"idempotent":true
},
"CreateBackupVault":{
@@ -825,7 +825,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
- "documentation":"<p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.</p> <note> <p> <code>ListTags</code> are currently only supported with Amazon EFS backups.</p> </note>",
+ "documentation":"<p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.</p> <p> <code>ListTags</code> only works for resource types that support full Backup management of their backups. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table.</p>",
"idempotent":true
},
"PutBackupVaultAccessPolicy":{
@@ -1065,7 +1065,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
- "documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p> <p>Does not support continuous backups.</p>",
+ "documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p> <p>This operation does not support continuous backups.</p>",
"idempotent":true
},
"UpdateRegionSettings":{
@@ -1408,7 +1408,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"RecoveryPointTags":{
"shape":"Tags",
@@ -1458,7 +1458,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"RecoveryPointTags":{
"shape":"Tags",
@@ -1576,7 +1576,9 @@
"COPY_JOB_FAILED",
"RECOVERY_POINT_MODIFIED",
"BACKUP_PLAN_CREATED",
- "BACKUP_PLAN_MODIFIED"
+ "BACKUP_PLAN_MODIFIED",
+ "S3_BACKUP_OBJECT_FAILED",
+ "S3_RESTORE_OBJECT_FAILED"
]
},
"BackupVaultEvents":{
@@ -1604,7 +1606,7 @@
},
"EncryptionKeyArn":{
"shape":"ARN",
- "documentation":"<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
+ "documentation":"<p>A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.</p> <p>To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html\"> Encryption for backups in Backup</a> </p>"
},
"CreatorRequestId":{
"shape":"string",
@@ -1650,7 +1652,7 @@
"documentation":"<p>A timestamp that specifies when to delete a recovery point.</p>"
}
},
- "documentation":"<p>Contains <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps, which are used to specify a lifecycle for a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>Contains <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps, which are used to specify a lifecycle for a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"ComplianceResourceIdList":{
"type":"list",
@@ -1668,7 +1670,7 @@
"members":{
"ConditionType":{
"shape":"ConditionType",
- "documentation":"<p>An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports <code>StringEquals</code>. For more flexible assignment options, incluidng <code>StringLike</code> and the ability to exclude resources from your backup plan, use <code>Conditions</code> (with an \"s\" on the end) for your <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html\"> <code>BackupSelection</code> </a>.</p>"
+ "documentation":"<p>An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports <code>StringEquals</code>. For more flexible assignment options, including <code>StringLike</code> and the ability to exclude resources from your backup plan, use <code>Conditions</code> (with an \"s\" on the end) for your <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html\"> <code>BackupSelection</code> </a>.</p>"
},
"ConditionKey":{
"shape":"ConditionKey",
@@ -2611,7 +2613,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
@@ -2645,7 +2647,7 @@
},
"ResourceTypeManagementPreference":{
"shape":"ResourceTypeManagementPreference",
- "documentation":"<p>Returns whether a DynamoDB recovery point was taken using <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html\"> Backup's advanced DynamoDB backup features</a>. </p>"
+ "documentation":"<p>Returns whether Backup fully manages the backups for a resource type.</p> <p>For the benefits of full Backup management, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management\"> Full Backup management</a>.</p> <p>For a list of resource types and whether each supports full Backup management, see the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table.</p> <p>If <code>\"DynamoDB\":false</code>, you can enable full Backup management for DynamoDB backup by enabling <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli\"> Backup's advanced DynamoDB backup features</a>.</p>"
}
}
},
@@ -3125,7 +3127,7 @@
"members":{
"ResourceTypes":{
"shape":"ResourceTypes",
- "documentation":"<p>Contains a string with the supported Amazon Web Services resource types:</p> <ul> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>FSX</code> for Amazon FSx</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> </ul>"
+ "documentation":"<p>Contains a string with the supported Amazon Web Services resource types:</p> <ul> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>FSX</code> for Amazon FSx</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> <li> <p> <code>DocDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li> <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li> </ul>"
}
}
},
@@ -3202,7 +3204,7 @@
"documentation":"<p>Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus <code>MoveToColdStorageAfterDays</code>.</p>"
}
},
- "documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"LimitExceededException":{
"type":"structure",
@@ -3268,7 +3270,7 @@
},
"ByResourceType":{
"shape":"ResourceType",
- "documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> </ul>",
+ "documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>FSx</code> for Amazon FSx</p> </li> <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> <li> <p> <code>S3</code> for Amazon S3</p> </li> <li> <p> <code>VirtualMachine</code> for virtual machines</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
@@ -3504,7 +3506,7 @@
},
"ByResourceType":{
"shape":"ResourceType",
- "documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> </ul>",
+ "documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>FSx</code> for Amazon FSx</p> </li> <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> <li> <p> <code>S3</code> for Amazon S3</p> </li> <li> <p> <code>VirtualMachine</code> for virtual machines</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
@@ -3966,11 +3968,11 @@
},
"MinRetentionDays":{
"shape":"Long",
- "documentation":"<p>The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).</p> <p>If this parameter is not specified, Vault Lock will not enforce a minimum retention period.</p> <p>If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.</p>"
+ "documentation":"<p>The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).</p> <p>If this parameter is not specified, Vault Lock will not enforce a minimum retention period.</p> <p>If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.</p>"
},
"MaxRetentionDays":{
"shape":"Long",
- "documentation":"<p>The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).</p> <p>If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.</p> <p>If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.</p>"
+ "documentation":"<p>The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).</p> <p>If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.</p> <p>If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.</p>"
},
"ChangeableForDays":{
"shape":"Long",
@@ -3998,7 +4000,7 @@
},
"BackupVaultEvents":{
"shape":"BackupVaultEvents",
- "documentation":"<p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p> <p>For common use cases and code samples, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html\">Using Amazon SNS to track Backup events</a>.</p> <p>The following events are supported:</p> <ul> <li> <p> <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code> </p> </li> <li> <p> <code>COPY_JOB_STARTED</code> | <code>COPY_JOB_SUCCESSFUL</code> | <code>COPY_JOB_FAILED</code> </p> </li> <li> <p> <code>RESTORE_JOB_STARTED</code> | <code>RESTORE_JOB_COMPLETED</code> | <code>RECOVERY_POINT_MODIFIED</code> </p> </li> </ul> <note> <p>Ignore the list below because it includes deprecated events. Refer to the list above.</p> </note>"
+ "documentation":"<p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p> <p>For common use cases and code samples, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html\">Using Amazon SNS to track Backup events</a>.</p> <p>The following events are supported:</p> <ul> <li> <p> <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code> </p> </li> <li> <p> <code>COPY_JOB_STARTED</code> | <code>COPY_JOB_SUCCESSFUL</code> | <code>COPY_JOB_FAILED</code> </p> </li> <li> <p> <code>RESTORE_JOB_STARTED</code> | <code>RESTORE_JOB_COMPLETED</code> | <code>RECOVERY_POINT_MODIFIED</code> </p> </li> <li> <p> <code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code> </p> </li> </ul> <note> <p>Ignore the list below because it includes deprecated events. Refer to the list above.</p> </note>"
}
}
},
@@ -4063,7 +4065,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
@@ -4470,11 +4472,11 @@
},
"CompleteWindowMinutes":{
"shape":"WindowMinutes",
- "documentation":"<p>A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for <code>StartWindowMinutes</code>, or if the backup started later than scheduled.</p>"
+ "documentation":"<p>A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for <code>StartWindowMinutes</code>, or if the backup started later than scheduled.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"RecoveryPointTags":{
"shape":"Tags",
@@ -4600,7 +4602,7 @@
},
"ResourceType":{
"shape":"ResourceType",
- "documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> </ul>"
+ "documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>Aurora</code> for Amazon Aurora</p> </li> <li> <p> <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p> </li> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>FSx</code> for Amazon FSx</p> </li> <li> <p> <code>Neptune</code> for Amazon Neptune</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for Storage Gateway</p> </li> <li> <p> <code>S3</code> for Amazon S3</p> </li> <li> <p> <code>VirtualMachine</code> for virtual machines</p> </li> </ul>"
}
}
},
@@ -4800,7 +4802,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
}
}
},
@@ -4817,7 +4819,7 @@
},
"Lifecycle":{
"shape":"Lifecycle",
- "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
+ "documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the \"Full Backup management\" section of the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource\"> Feature availability by resource</a> table. Backup ignores this expression for other resource types.</p>"
},
"CalculatedLifecycle":{
"shape":"CalculatedLifecycle",
@@ -4834,7 +4836,7 @@
},
"ResourceTypeManagementPreference":{
"shape":"ResourceTypeManagementPreference",
- "documentation":"<p>Enables or disables <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html\"> Backup's advanced DynamoDB backup features</a> for the Region.</p>"
+ "documentation":"<p>Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html\"> Backup's advanced DynamoDB backup features</a>, follow the procedure to <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli\"> enable advanced DynamoDB backup programmatically</a>.</p>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json b/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json
index bc1067a69c..402c9f9d6d 100644
--- a/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json
@@ -262,7 +262,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
- "documentation":"<p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a> override parameters defined in the job definition. vCPU and memory requirements that are specified in the <code>resourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition parameters in a <code>ResourceRequirements</code> object that's included in the <code>containerOverrides</code> parameter.</p> <note> <p>Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time. </p> </note> <important> <p>Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.</p> </important>"
+ "documentation":"<p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a> override parameters defined in the job definition. vCPU and memory requirements that are specified in the <code>resourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition parameters in a <code>resourceRequirements</code> object that's included in the <code>containerOverrides</code> parameter.</p> <note> <p>Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time. </p> </note> <important> <p>Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.</p> </important>"
},
"TagResource":{
"name":"TagResource",
@@ -743,7 +743,7 @@
},
"memory":{
"shape":"Integer",
- "documentation":"<p>For jobs run on EC2 resources that didn't specify memory requirements using <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see <code>resourceRequirements</code>.</p>"
+ "documentation":"<p>For jobs running on EC2 resources that didn't specify memory requirements using <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see <code>resourceRequirements</code>.</p>"
},
"command":{
"shape":"StringList",
@@ -845,13 +845,13 @@
"members":{
"vcpus":{
"shape":"Integer",
- "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to override the <code>vcpus</code> parameter that's set in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the <code>vcpus</code> parameter set in the job definition, but doesn't override any vCPU requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override vCPU requirements that are specified in the <code>resourceRequirements</code> structure in the job definition, <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code> set to <code>VCPU</code> and <code>value</code> set to the new value. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements\">Can't override job definition resource requirements</a> in the <i>Batch User Guide</i>.</p>",
+ "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to override the <code>vcpus</code> parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the <code>vcpus</code> parameter set in the job definition, but doesn't override any vCPU requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override vCPU requirements that are specified in the <code>resourceRequirements</code> structure in the job definition, <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code> set to <code>VCPU</code> and <code>value</code> set to the new value. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements\">Can't override job definition resource requirements</a> in the <i>Batch User Guide</i>.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
"memory":{
"shape":"Integer",
- "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to override the memory requirements specified in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the <code>memory</code> parameter set in the job definition, but doesn't override any memory requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override memory requirements that are specified in the <code>resourceRequirements</code> structure in the job definition, <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code> set to <code>MEMORY</code> and <code>value</code> set to the new value. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements\">Can't override job definition resource requirements</a> in the <i>Batch User Guide</i>.</p>",
+ "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the <code>memory</code> parameter set in the job definition, but doesn't override any memory requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override memory requirements that are specified in the <code>resourceRequirements</code> structure in the job definition, <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code> set to <code>MEMORY</code> and <code>value</code> set to the new value. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements\">Can't override job definition resource requirements</a> in the <i>Batch User Guide</i>.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
@@ -879,17 +879,17 @@
"members":{
"image":{
"shape":"String",
- "documentation":"<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.</p> </note> <ul> <li> <p>Images in Amazon ECR repositories use the full registry and repository URI (for example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;</code>).</p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
+ "documentation":"<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.</p> </note> <ul> <li> <p>Images in Amazon ECR Public repositories use the full <code>registry/repository[:tag]</code> or <code>registry/repository[@digest]</code> naming conventions. For example, <code>public.ecr.aws/<i>registry_alias</i>/<i>my-web-app</i>:<i>latest</i> </code>.</p> </li> <li> <p>Images in Amazon ECR repositories use the full registry and repository URI (for example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;</code>).</p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
},
"vcpus":{
"shape":"Integer",
- "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.</p> <p>Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.</p>",
+ "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.</p> <p>Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
"memory":{
"shape":"Integer",
- "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.</p>",
+ "documentation":"<p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
@@ -999,7 +999,7 @@
},
"unmanagedvCpus":{
"shape":"Integer",
- "documentation":"<p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p> <note> <p>This parameter is only supported when the <code>type</code> parameter is set to <code>UNMANAGED</code>/</p> </note>"
+ "documentation":"<p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p> <note> <p>This parameter is only supported when the <code>type</code> parameter is set to <code>UNMANAGED</code>.</p> </note>"
},
"computeResources":{
"shape":"ComputeResource",
diff --git a/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/paginators-1.json b/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/paginators-1.json
new file mode 100644
index 0000000000..ec00d52fdc
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/paginators-1.json
@@ -0,0 +1,74 @@
+{
+ "pagination": {
+ "ListAccountAssociations": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "result_key": "LinkedAccounts"
+ },
+ "ListBillingGroupCostReports": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "BillingGroupCostReports"
+ },
+ "ListBillingGroups": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "BillingGroups"
+ },
+ "ListCustomLineItems": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "CustomLineItems"
+ },
+ "ListPricingPlans": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "BillingPeriod"
+ ],
+ "output_token": "NextToken",
+ "result_key": "PricingPlans"
+ },
+ "ListPricingPlansAssociatedWithPricingRule": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "BillingPeriod",
+ "PricingRuleArn"
+ ],
+ "output_token": "NextToken",
+ "result_key": "PricingPlanArns"
+ },
+ "ListPricingRules": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "BillingPeriod"
+ ],
+ "output_token": "NextToken",
+ "result_key": "PricingRules"
+ },
+ "ListPricingRulesAssociatedToPricingPlan": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "BillingPeriod",
+ "PricingPlanArn"
+ ],
+ "output_token": "NextToken",
+ "result_key": "PricingRuleArns"
+ },
+ "ListResourcesAssociatedToCustomLineItem": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "Arn"
+ ],
+ "output_token": "NextToken",
+ "result_key": "AssociatedResources"
+ }
+ }
+}
diff --git a/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/service-2.json b/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/service-2.json
new file mode 100644
index 0000000000..7341b58557
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/service-2.json
@@ -0,0 +1,2779 @@
+{
+ "version":"2.0",
+ "metadata":{
+ "apiVersion":"2021-07-30",
+ "endpointPrefix":"billingconductor",
+ "jsonVersion":"1.1",
+ "protocol":"rest-json",
+ "serviceFullName":"AWSBillingConductor",
+ "serviceId":"billingconductor",
+ "signatureVersion":"v4",
+ "signingName":"billingconductor",
+ "uid":"billingconductor-2021-07-30"
+ },
+ "operations":{
+ "AssociateAccounts":{
+ "name":"AssociateAccounts",
+ "http":{
+ "method":"POST",
+ "requestUri":"/associate-accounts",
+ "responseCode":200
+ },
+ "input":{"shape":"AssociateAccountsInput"},
+ "output":{"shape":"AssociateAccountsOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30. </p>",
+ "idempotent":true
+ },
+ "AssociatePricingRules":{
+ "name":"AssociatePricingRules",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/associate-pricing-rules",
+ "responseCode":200
+ },
+ "input":{"shape":"AssociatePricingRulesInput"},
+ "output":{"shape":"AssociatePricingRulesOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Connects an array of <code>PricingRuleArns</code> to a defined <code>PricingPlan</code>. The maximum number <code>PricingRuleArn</code> that can be associated in one call is 30. </p>",
+ "idempotent":true
+ },
+ "BatchAssociateResourcesToCustomLineItem":{
+ "name":"BatchAssociateResourcesToCustomLineItem",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/batch-associate-resources-to-custom-line-item",
+ "responseCode":200
+ },
+ "input":{"shape":"BatchAssociateResourcesToCustomLineItemInput"},
+ "output":{"shape":"BatchAssociateResourcesToCustomLineItemOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Associates a batch of resources to a percentage custom line item. </p>",
+ "idempotent":true
+ },
+ "BatchDisassociateResourcesFromCustomLineItem":{
+ "name":"BatchDisassociateResourcesFromCustomLineItem",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/batch-disassociate-resources-from-custom-line-item",
+ "responseCode":200
+ },
+ "input":{"shape":"BatchDisassociateResourcesFromCustomLineItemInput"},
+ "output":{"shape":"BatchDisassociateResourcesFromCustomLineItemOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Disassociates a batch of resources from a percentage custom line item. </p>",
+ "idempotent":true
+ },
+ "CreateBillingGroup":{
+ "name":"CreateBillingGroup",
+ "http":{
+ "method":"POST",
+ "requestUri":"/create-billing-group",
+ "responseCode":200
+ },
+ "input":{"shape":"CreateBillingGroupInput"},
+ "output":{"shape":"CreateBillingGroupOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation. </p>",
+ "idempotent":true
+ },
+ "CreateCustomLineItem":{
+ "name":"CreateCustomLineItem",
+ "http":{
+ "method":"POST",
+ "requestUri":"/create-custom-line-item",
+ "responseCode":200
+ },
+ "input":{"shape":"CreateCustomLineItemInput"},
+ "output":{"shape":"CreateCustomLineItemOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount. </p>"
+ },
+ "CreatePricingPlan":{
+ "name":"CreatePricingPlan",
+ "http":{
+ "method":"POST",
+ "requestUri":"/create-pricing-plan",
+ "responseCode":200
+ },
+ "input":{"shape":"CreatePricingPlanInput"},
+ "output":{"shape":"CreatePricingPlanOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups. </p>",
+ "idempotent":true
+ },
+ "CreatePricingRule":{
+ "name":"CreatePricingRule",
+ "http":{
+ "method":"POST",
+ "requestUri":"/create-pricing-rule",
+ "responseCode":200
+ },
+ "input":{"shape":"CreatePricingRuleInput"},
+ "output":{"shape":"CreatePricingRuleOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"ServiceLimitExceededException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans. </p>",
+ "idempotent":true
+ },
+ "DeleteBillingGroup":{
+ "name":"DeleteBillingGroup",
+ "http":{
+ "method":"POST",
+ "requestUri":"/delete-billing-group",
+ "responseCode":200
+ },
+ "input":{"shape":"DeleteBillingGroupInput"},
+ "output":{"shape":"DeleteBillingGroupOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Deletes a billing group. </p>",
+ "idempotent":true
+ },
+ "DeleteCustomLineItem":{
+ "name":"DeleteCustomLineItem",
+ "http":{
+ "method":"POST",
+ "requestUri":"/delete-custom-line-item",
+ "responseCode":200
+ },
+ "input":{"shape":"DeleteCustomLineItemInput"},
+ "output":{"shape":"DeleteCustomLineItemOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Deletes the custom line item identified by the given ARN in the current, or previous billing period. </p>",
+ "idempotent":true
+ },
+ "DeletePricingPlan":{
+ "name":"DeletePricingPlan",
+ "http":{
+ "method":"POST",
+ "requestUri":"/delete-pricing-plan",
+ "responseCode":200
+ },
+ "input":{"shape":"DeletePricingPlanInput"},
+ "output":{"shape":"DeletePricingPlanOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.</p>",
+ "idempotent":true
+ },
+ "DeletePricingRule":{
+ "name":"DeletePricingRule",
+ "http":{
+ "method":"POST",
+ "requestUri":"/delete-pricing-rule",
+ "responseCode":200
+ },
+ "input":{"shape":"DeletePricingRuleInput"},
+ "output":{"shape":"DeletePricingRuleOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Deletes the pricing rule identified by the input Amazon Resource Name (ARN). </p>",
+ "idempotent":true
+ },
+ "DisassociateAccounts":{
+ "name":"DisassociateAccounts",
+ "http":{
+ "method":"POST",
+ "requestUri":"/disassociate-accounts",
+ "responseCode":200
+ },
+ "input":{"shape":"DisassociateAccountsInput"},
+ "output":{"shape":"DisassociateAccountsOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Removes the specified list of account IDs from the given billing group. </p>",
+ "idempotent":true
+ },
+ "DisassociatePricingRules":{
+ "name":"DisassociatePricingRules",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/disassociate-pricing-rules",
+ "responseCode":200
+ },
+ "input":{"shape":"DisassociatePricingRulesInput"},
+ "output":{"shape":"DisassociatePricingRulesOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Disassociates a list of pricing rules from a pricing plan. </p>",
+ "idempotent":true
+ },
+ "ListAccountAssociations":{
+ "name":"ListAccountAssociations",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-account-associations",
+ "responseCode":200
+ },
+ "input":{"shape":"ListAccountAssociationsInput"},
+ "output":{"shape":"ListAccountAssociationsOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> <i> <b>Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i> </p> <p> This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group associated with the linked account.</p>"
+ },
+ "ListBillingGroupCostReports":{
+ "name":"ListBillingGroupCostReports",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-billing-group-cost-reports",
+ "responseCode":200
+ },
+ "input":{"shape":"ListBillingGroupCostReportsInput"},
+ "output":{"shape":"ListBillingGroupCostReportsOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.</p>"
+ },
+ "ListBillingGroups":{
+ "name":"ListBillingGroups",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-billing-groups",
+ "responseCode":200
+ },
+ "input":{"shape":"ListBillingGroupsInput"},
+ "output":{"shape":"ListBillingGroupsOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.</p>"
+ },
+ "ListCustomLineItems":{
+ "name":"ListCustomLineItems",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-custom-line-items",
+ "responseCode":200
+ },
+ "input":{"shape":"ListCustomLineItemsInput"},
+ "output":{"shape":"ListCustomLineItemsOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used. </p>"
+ },
+ "ListPricingPlans":{
+ "name":"ListPricingPlans",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-pricing-plans",
+ "responseCode":200
+ },
+ "input":{"shape":"ListPricingPlansInput"},
+ "output":{"shape":"ListPricingPlansOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used. </p>"
+ },
+ "ListPricingPlansAssociatedWithPricingRule":{
+ "name":"ListPricingPlansAssociatedWithPricingRule",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-pricing-plans-associated-with-pricing-rule",
+ "responseCode":200
+ },
+ "input":{"shape":"ListPricingPlansAssociatedWithPricingRuleInput"},
+ "output":{"shape":"ListPricingPlansAssociatedWithPricingRuleOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> A list of the pricing plans associated with a pricing rule. </p>"
+ },
+ "ListPricingRules":{
+ "name":"ListPricingRules",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-pricing-rules",
+ "responseCode":200
+ },
+ "input":{"shape":"ListPricingRulesInput"},
+ "output":{"shape":"ListPricingRulesOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans. </p>"
+ },
+ "ListPricingRulesAssociatedToPricingPlan":{
+ "name":"ListPricingRulesAssociatedToPricingPlan",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-pricing-rules-associated-to-pricing-plan",
+ "responseCode":200
+ },
+ "input":{"shape":"ListPricingRulesAssociatedToPricingPlanInput"},
+ "output":{"shape":"ListPricingRulesAssociatedToPricingPlanOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Lists the pricing rules associated with a pricing plan. </p>"
+ },
+ "ListResourcesAssociatedToCustomLineItem":{
+ "name":"ListResourcesAssociatedToCustomLineItem",
+ "http":{
+ "method":"POST",
+ "requestUri":"/list-resources-associated-to-custom-line-item",
+ "responseCode":200
+ },
+ "input":{"shape":"ListResourcesAssociatedToCustomLineItemInput"},
+ "output":{"shape":"ListResourcesAssociatedToCustomLineItemOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> List the resources associated to a custom line item. </p>"
+ },
+ "ListTagsForResource":{
+ "name":"ListTagsForResource",
+ "http":{
+ "method":"GET",
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":204
+ },
+ "input":{"shape":"ListTagsForResourceRequest"},
+ "output":{"shape":"ListTagsForResourceResponse"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> A list the tags for a resource. </p>"
+ },
+ "TagResource":{
+ "name":"TagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":204
+ },
+ "input":{"shape":"TagResourceRequest"},
+ "output":{"shape":"TagResourceResponse"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. </p>"
+ },
+ "UntagResource":{
+ "name":"UntagResource",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":204
+ },
+ "input":{"shape":"UntagResourceRequest"},
+ "output":{"shape":"UntagResourceResponse"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Deletes specified tags from a resource. </p>"
+ },
+ "UpdateBillingGroup":{
+ "name":"UpdateBillingGroup",
+ "http":{
+ "method":"POST",
+ "requestUri":"/update-billing-group",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateBillingGroupInput"},
+ "output":{"shape":"UpdateBillingGroupOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>This updates an existing billing group. </p>",
+ "idempotent":true
+ },
+ "UpdateCustomLineItem":{
+ "name":"UpdateCustomLineItem",
+ "http":{
+ "method":"POST",
+ "requestUri":"/update-custom-line-item",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateCustomLineItemInput"},
+ "output":{"shape":"UpdateCustomLineItemOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Update an existing custom line item in the current or previous billing period. </p>",
+ "idempotent":true
+ },
+ "UpdatePricingPlan":{
+ "name":"UpdatePricingPlan",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/update-pricing-plan",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdatePricingPlanInput"},
+ "output":{"shape":"UpdatePricingPlanOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>This updates an existing pricing plan. </p>",
+ "idempotent":true
+ },
+ "UpdatePricingRule":{
+ "name":"UpdatePricingRule",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/update-pricing-rule",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdatePricingRuleInput"},
+ "output":{"shape":"UpdatePricingRuleOutput"},
+ "errors":[
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p> Updates an existing pricing rule. </p>",
+ "idempotent":true
+ }
+ },
+ "shapes":{
+ "AWSCost":{"type":"string"},
+ "AccessDeniedException":{
+ "type":"structure",
+ "required":["Message"],
+ "members":{
+ "Message":{"shape":"String"}
+ },
+ "documentation":"<p>You do not have sufficient access to perform this action. </p>",
+ "error":{
+ "httpStatusCode":403,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "AccountAssociationsList":{
+ "type":"list",
+ "member":{"shape":"AccountAssociationsListElement"}
+ },
+ "AccountAssociationsListElement":{
+ "type":"structure",
+ "members":{
+ "AccountId":{
+ "shape":"AccountId",
+ "documentation":"<p> The associating array of account IDs. </p>"
+ },
+ "BillingGroupArn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p> The Billing Group Arn that the linked account is associated to. </p>"
+ },
+ "AccountName":{
+ "shape":"AccountName",
+ "documentation":"<p> The Amazon Web Services account name. </p>"
+ },
+ "AccountEmail":{
+ "shape":"AccountEmail",
+ "documentation":"<p> The Amazon Web Services account email. </p>"
+ }
+ },
+ "documentation":"<p> <i> <b>Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i> </p> <p> A representation of a linked account. </p>"
+ },
+ "AccountEmail":{
+ "type":"string",
+ "sensitive":true
+ },
+ "AccountGrouping":{
+ "type":"structure",
+ "required":["LinkedAccountIds"],
+ "members":{
+ "LinkedAccountIds":{
+ "shape":"AccountIdList",
+ "documentation":"<p> The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group. </p>"
+ }
+ },
+ "documentation":"<p> The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family. </p>"
+ },
+ "AccountId":{
+ "type":"string",
+ "pattern":"[0-9]{12}"
+ },
+ "AccountIdList":{
+ "type":"list",
+ "member":{"shape":"AccountId"},
+ "max":30,
+ "min":1
+ },
+ "AccountName":{
+ "type":"string",
+ "sensitive":true
+ },
+ "Arn":{
+ "type":"string",
+ "max":100,
+ "min":0,
+ "pattern":"arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}$|^(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}"
+ },
+ "AssociateAccountsInput":{
+ "type":"structure",
+ "required":[
+ "Arn",
+ "AccountIds"
+ ],
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. </p>"
+ },
+ "AccountIds":{
+ "shape":"AccountIdList",
+ "documentation":"<p> The associating array of account IDs. </p>"
+ }
+ }
+ },
+ "AssociateAccountsOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. </p>"
+ }
+ }
+ },
+ "AssociatePricingRulesInput":{
+ "type":"structure",
+ "required":[
+ "Arn",
+ "PricingRuleArns"
+ ],
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The <code>PricingPlanArn</code> that the <code>PricingRuleArns</code> are associated with. </p>"
+ },
+ "PricingRuleArns":{
+ "shape":"PricingRuleArnsNonEmptyInput",
+ "documentation":"<p> The <code>PricingRuleArns</code> that are associated with the Pricing Plan. </p>"
+ }
+ }
+ },
+ "AssociatePricingRulesOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The <code>PricingPlanArn</code> that the <code>PricingRuleArns</code> are associated with. </p>"
+ }
+ }
+ },
+ "AssociateResourceError":{
+ "type":"structure",
+ "members":{
+ "Message":{
+ "shape":"String",
+ "documentation":"<p> The reason the resource association failed. </p>"
+ },
+ "Reason":{
+ "shape":"AssociateResourceErrorReason",
+ "documentation":"<p> A static error code that used to classify the type of failure. </p>"
+ }
+ },
+ "documentation":"<p> A representation of a resource association error. </p>"
+ },
+ "AssociateResourceErrorReason":{
+ "type":"string",
+ "enum":[
+ "INVALID_ARN",
+ "SERVICE_LIMIT_EXCEEDED",
+ "ILLEGAL_CUSTOMLINEITEM",
+ "INTERNAL_SERVER_EXCEPTION"
+ ]
+ },
+ "AssociateResourceResponseElement":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The resource ARN that was associated to the custom line item. </p>"
+ },
+ "Error":{
+ "shape":"AssociateResourceError",
+ "documentation":"<p> An <code>AssociateResourceError</code> that will populate if the resource association fails. </p>"
+ }
+ },
+ "documentation":"<p> A resource association result for a percentage custom line item. </p>"
+ },
+ "AssociateResourcesResponseList":{
+ "type":"list",
+ "member":{"shape":"AssociateResourceResponseElement"}
+ },
+ "Association":{
+ "type":"string",
+ "pattern":"((arn:aws:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}|MONITORED|UNMONITORED)"
+ },
+ "BatchAssociateResourcesToCustomLineItemInput":{
+ "type":"structure",
+ "required":[
+ "TargetArn",
+ "ResourceArns"
+ ],
+ "members":{
+ "TargetArn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> A percentage custom line item ARN to associate the resources to. </p>"
+ },
+ "ResourceArns":{
+ "shape":"CustomLineItemBatchAssociationsList",
+ "documentation":"<p> A list containing the ARNs of the resources to be associated. </p>"
+ },
+ "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"}
+ }
+ },
+ "BatchAssociateResourcesToCustomLineItemOutput":{
+ "type":"structure",
+ "members":{
+ "SuccessfullyAssociatedResources":{
+ "shape":"AssociateResourcesResponseList",
+ "documentation":"<p> A list of <code>AssociateResourceResponseElement</code> for each resource that's been associated to a percentage custom line item successfully. </p>"
+ },
+ "FailedAssociatedResources":{
+ "shape":"AssociateResourcesResponseList",
+ "documentation":"<p> A list of <code>AssociateResourceResponseElement</code> for each resource that failed association to a percentage custom line item. </p>"
+ }
+ }
+ },
+ "BatchDisassociateResourcesFromCustomLineItemInput":{
+ "type":"structure",
+ "required":[
+ "TargetArn",
+ "ResourceArns"
+ ],
+ "members":{
+ "TargetArn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> A percentage custom line item ARN to disassociate the resources from. </p>"
+ },
+ "ResourceArns":{
+ "shape":"CustomLineItemBatchDisassociationsList",
+ "documentation":"<p> A list containing the ARNs of resources to be disassociated. </p>"
+ },
+ "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"}
+ }
+ },
+ "BatchDisassociateResourcesFromCustomLineItemOutput":{
+ "type":"structure",
+ "members":{
+ "SuccessfullyDisassociatedResources":{
+ "shape":"DisassociateResourcesResponseList",
+ "documentation":"<p> A list of <code>DisassociateResourceResponseElement</code> for each resource that's been disassociated from a percentage custom line item successfully. </p>"
+ },
+ "FailedDisassociatedResources":{
+ "shape":"DisassociateResourcesResponseList",
+ "documentation":"<p> A list of <code>DisassociateResourceResponseElement</code> for each resource that failed disassociation from a percentage custom line item. </p>"
+ }
+ }
+ },
+ "BillingGroupArn":{
+ "type":"string",
+ "pattern":"(arn:aws:billingconductor::[0-9]{12}:billinggroup/)?[0-9]{12}"
+ },
+ "BillingGroupArnList":{
+ "type":"list",
+ "member":{"shape":"BillingGroupArn"},
+ "max":100,
+ "min":1
+ },
+ "BillingGroupCostReportElement":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of a billing group. </p>"
+ },
+ "AWSCost":{
+ "shape":"AWSCost",
+ "documentation":"<p>The actual Amazon Web Services charges for the billing group. </p>"
+ },
+ "ProformaCost":{
+ "shape":"ProformaCost",
+ "documentation":"<p>The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group. </p>"
+ },
+ "Margin":{
+ "shape":"Margin",
+ "documentation":"<p> The billing group margin. </p>"
+ },
+ "MarginPercentage":{
+ "shape":"MarginPercentage",
+ "documentation":"<p> The percentage of billing group margin. </p>"
+ },
+ "Currency":{
+ "shape":"Currency",
+ "documentation":"<p>The displayed currency. </p>"
+ }
+ },
+ "documentation":"<p>A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group. </p>"
+ },
+ "BillingGroupCostReportList":{
+ "type":"list",
+ "member":{"shape":"BillingGroupCostReportElement"}
+ },
+ "BillingGroupDescription":{
+ "type":"string",
+ "max":1024,
+ "min":0,
+ "sensitive":true
+ },
+ "BillingGroupFullArn":{
+ "type":"string",
+ "pattern":"arn:aws:billingconductor::[0-9]{12}:billinggroup/[0-9]{12}"
+ },
+ "BillingGroupList":{
+ "type":"list",
+ "member":{"shape":"BillingGroupListElement"}
+ },
+ "BillingGroupListElement":{
+ "type":"structure",
+ "members":{
+ "Name":{
+ "shape":"BillingGroupName",
+ "documentation":"<p>The billing group's name. </p>"
+ },
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group. </p>"
+ },
+ "Description":{
+ "shape":"BillingGroupDescription",
+ "documentation":"<p>The billing group description. </p>"
+ },
+ "PrimaryAccountId":{
+ "shape":"AccountId",
+ "documentation":"<p>The account ID that serves as the main account in a billing group. </p>"
+ },
+ "ComputationPreference":{"shape":"ComputationPreference"},
+ "Size":{
+ "shape":"NumberOfAccounts",
+ "documentation":"<p>The number of accounts in the particular billing group. </p>"
+ },
+ "CreationTime":{
+ "shape":"Instant",
+ "documentation":"<p> The time the billing group was created. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the billing group was modified. </p>"
+ },
+ "Status":{
+ "shape":"BillingGroupStatus",
+ "documentation":"<p>The billing group status. Only one of the valid values can be used. </p>"
+ },
+ "StatusReason":{
+ "shape":"BillingGroupStatusReason",
+ "documentation":"<p>The reason why the billing group is in its current status. </p>"
+ }
+ },
+ "documentation":"<p>A representation of a billing group. </p>"
+ },
+ "BillingGroupName":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+",
+ "sensitive":true
+ },
+ "BillingGroupStatus":{
+ "type":"string",
+ "enum":[
+ "ACTIVE",
+ "PRIMARY_ACCOUNT_MISSING"
+ ]
+ },
+ "BillingGroupStatusReason":{"type":"string"},
+ "BillingPeriod":{
+ "type":"string",
+ "pattern":"\\d{4}-(0?[1-9]|1[012])"
+ },
+ "ClientToken":{
+ "type":"string",
+ "max":64,
+ "min":1,
+ "pattern":"[a-zA-Z0-9-]+"
+ },
+ "ComputationPreference":{
+ "type":"structure",
+ "required":["PricingPlanArn"],
+ "members":{
+ "PricingPlanArn":{
+ "shape":"PricingPlanFullArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group. </p>"
+ }
+ },
+ "documentation":"<p> The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. </p>"
+ },
+ "ConflictException":{
+ "type":"structure",
+ "required":[
+ "Message",
+ "ResourceId",
+ "ResourceType"
+ ],
+ "members":{
+ "Message":{"shape":"String"},
+ "ResourceId":{
+ "shape":"String",
+ "documentation":"<p>Identifier of the resource in use. </p>"
+ },
+ "ResourceType":{
+ "shape":"String",
+ "documentation":"<p>Type of the resource in use. </p>"
+ }
+ },
+ "documentation":"<p>You can cause an inconsistent state by updating or deleting a resource. </p>",
+ "error":{
+ "httpStatusCode":409,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "CreateBillingGroupInput":{
+ "type":"structure",
+ "required":[
+ "Name",
+ "AccountGrouping",
+ "ComputationPreference"
+ ],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. </p>",
+ "idempotencyToken":true,
+ "location":"header",
+ "locationName":"X-Amzn-Client-Token"
+ },
+ "Name":{
+ "shape":"BillingGroupName",
+ "documentation":"<p> The billing group name. The names must be unique. </p>"
+ },
+ "AccountGrouping":{
+ "shape":"AccountGrouping",
+ "documentation":"<p> The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family. </p>"
+ },
+ "ComputationPreference":{
+ "shape":"ComputationPreference",
+ "documentation":"<p> The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. </p>"
+ },
+ "PrimaryAccountId":{
+ "shape":"AccountId",
+ "documentation":"<p> The account ID that serves as the main account in a billing group. </p>"
+ },
+ "Description":{
+ "shape":"BillingGroupDescription",
+ "documentation":"<p>The billing group description. </p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p> A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta. </p>"
+ }
+ }
+ },
+ "CreateBillingGroupOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the created billing group. </p>"
+ }
+ }
+ },
+ "CreateCustomLineItemInput":{
+ "type":"structure",
+ "required":[
+ "Name",
+ "Description",
+ "BillingGroupArn",
+ "ChargeDetails"
+ ],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. </p>",
+ "idempotencyToken":true,
+ "location":"header",
+ "locationName":"X-Amzn-Client-Token"
+ },
+ "Name":{
+ "shape":"CustomLineItemName",
+ "documentation":"<p> The name of the custom line item. </p>"
+ },
+ "Description":{
+ "shape":"CustomLineItemDescription",
+ "documentation":"<p> The description of the custom line item. This is shown on the Bills page in association with the charge value. </p>"
+ },
+ "BillingGroupArn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. </p>"
+ },
+ "BillingPeriodRange":{
+ "shape":"CustomLineItemBillingPeriodRange",
+ "documentation":"<p> A time range for which the custom line item is effective. </p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p> A map that contains tag keys and tag values that are attached to a custom line item. </p>"
+ },
+ "ChargeDetails":{
+ "shape":"CustomLineItemChargeDetails",
+ "documentation":"<p> A <code>CustomLineItemChargeDetails</code> that describes the charge details for a custom line item. </p>"
+ }
+ }
+ },
+ "CreateCustomLineItemOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the created custom line item. </p>"
+ }
+ }
+ },
+ "CreatePricingPlanInput":{
+ "type":"structure",
+ "required":["Name"],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. </p>",
+ "idempotencyToken":true,
+ "location":"header",
+ "locationName":"X-Amzn-Client-Token"
+ },
+ "Name":{
+ "shape":"PricingPlanName",
+ "documentation":"<p>The pricing plan name. The names must be unique to each pricing plan. </p>"
+ },
+ "Description":{
+ "shape":"PricingPlanDescription",
+ "documentation":"<p>The pricing plan description. </p>"
+ },
+ "PricingRuleArns":{
+ "shape":"PricingRuleArnsInput",
+ "documentation":"<p> A list of Amazon Resource Names (ARNs) that define the pricing plan parameters. </p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p> A map that contains tag keys and tag values that are attached to a pricing plan. </p>"
+ }
+ }
+ },
+ "CreatePricingPlanOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the created pricing plan.</p>"
+ }
+ }
+ },
+ "CreatePricingRuleInput":{
+ "type":"structure",
+ "required":[
+ "Name",
+ "Scope",
+ "Type",
+ "ModifierPercentage"
+ ],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update. </p>",
+ "idempotencyToken":true,
+ "location":"header",
+ "locationName":"X-Amzn-Client-Token"
+ },
+ "Name":{
+ "shape":"PricingRuleName",
+ "documentation":"<p> The pricing rule name. The names must be unique to each pricing rule. </p>"
+ },
+ "Description":{
+ "shape":"PricingRuleDescription",
+ "documentation":"<p> The pricing rule description. </p>"
+ },
+ "Scope":{
+ "shape":"PricingRuleScope",
+ "documentation":"<p> The scope of pricing rule that indicates if it is globally applicable, or is service-specific. </p>"
+ },
+ "Type":{
+ "shape":"PricingRuleType",
+ "documentation":"<p> The type of pricing rule. </p>"
+ },
+ "ModifierPercentage":{
+ "shape":"ModifierPercentage",
+ "documentation":"<p> A percentage modifier applied on the public pricing rates. </p>"
+ },
+ "Service":{
+ "shape":"Service",
+ "documentation":"<p> If the <code>Scope</code> attribute is set to <code>SERVICE</code>, the attribute indicates which service the <code>PricingRule</code> is applicable for. </p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p> A map that contains tag keys and tag values that are attached to a pricing rule. </p>"
+ }
+ }
+ },
+ "CreatePricingRuleOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the created pricing rule. </p>"
+ }
+ }
+ },
+ "Currency":{"type":"string"},
+ "CurrencyCode":{
+ "type":"string",
+ "enum":[
+ "USD",
+ "CNY"
+ ]
+ },
+ "CustomLineItemArn":{
+ "type":"string",
+ "pattern":"(arn:aws:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}"
+ },
+ "CustomLineItemArns":{
+ "type":"list",
+ "member":{"shape":"CustomLineItemArn"},
+ "max":100,
+ "min":1
+ },
+ "CustomLineItemAssociationElement":{
+ "type":"string",
+ "pattern":"(arn:aws:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}"
+ },
+ "CustomLineItemAssociationsList":{
+ "type":"list",
+ "member":{"shape":"CustomLineItemAssociationElement"},
+ "max":5,
+ "min":0
+ },
+ "CustomLineItemBatchAssociationsList":{
+ "type":"list",
+ "member":{"shape":"CustomLineItemAssociationElement"},
+ "max":30,
+ "min":1
+ },
+ "CustomLineItemBatchDisassociationsList":{
+ "type":"list",
+ "member":{"shape":"CustomLineItemAssociationElement"},
+ "max":30,
+ "min":1
+ },
+ "CustomLineItemBillingPeriodRange":{
+ "type":"structure",
+ "required":[
+ "InclusiveStartBillingPeriod",
+ "ExclusiveEndBillingPeriod"
+ ],
+ "members":{
+ "InclusiveStartBillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The inclusive start billing period that defines a billing period range where a custom line is applied. </p>"
+ },
+ "ExclusiveEndBillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The inclusive end billing period that defines a billing period range where a custom line is applied. </p>"
+ }
+ },
+ "documentation":"<p> The billing period range in which the custom line item request will be applied. </p>"
+ },
+ "CustomLineItemChargeDetails":{
+ "type":"structure",
+ "required":["Type"],
+ "members":{
+ "Flat":{
+ "shape":"CustomLineItemFlatChargeDetails",
+ "documentation":"<p> A <code>CustomLineItemFlatChargeDetails</code> that describes the charge details of a flat custom line item. </p>"
+ },
+ "Percentage":{
+ "shape":"CustomLineItemPercentageChargeDetails",
+ "documentation":"<p> A <code>CustomLineItemPercentageChargeDetails</code> that describes the charge details of a percentage custom line item. </p>"
+ },
+ "Type":{
+ "shape":"CustomLineItemType",
+ "documentation":"<p> The type of the custom line item that indicates whether the charge is a fee or credit. </p>"
+ }
+ },
+ "documentation":"<p> The charge details of a custom line item. It should contain only one of <code>Flat</code> or <code>Percentage</code>. </p>"
+ },
+ "CustomLineItemChargeValue":{
+ "type":"double",
+ "box":true,
+ "max":1000000,
+ "min":0
+ },
+ "CustomLineItemDescription":{
+ "type":"string",
+ "max":255,
+ "min":1,
+ "sensitive":true
+ },
+ "CustomLineItemFlatChargeDetails":{
+ "type":"structure",
+ "required":["ChargeValue"],
+ "members":{
+ "ChargeValue":{
+ "shape":"CustomLineItemChargeValue",
+ "documentation":"<p> The custom line item's fixed charge value in USD. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the charge details associated with a flat custom line item. </p>"
+ },
+ "CustomLineItemList":{
+ "type":"list",
+ "member":{"shape":"CustomLineItemListElement"}
+ },
+ "CustomLineItemListElement":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The Amazon Resource Names (ARNs) for custom line items. </p>"
+ },
+ "Name":{
+ "shape":"CustomLineItemName",
+ "documentation":"<p> The custom line item's name. </p>"
+ },
+ "ChargeDetails":{
+ "shape":"ListCustomLineItemChargeDetails",
+ "documentation":"<p> A <code>ListCustomLineItemChargeDetails</code> that describes the charge details of a custom line item. </p>"
+ },
+ "CurrencyCode":{
+ "shape":"CurrencyCode",
+ "documentation":"<p> The custom line item's charge value currency. Only one of the valid values can be used. </p>"
+ },
+ "Description":{
+ "shape":"CustomLineItemDescription",
+ "documentation":"<p> The custom line item's description. This is shown on the Bills page in association with the charge value. </p>"
+ },
+ "ProductCode":{
+ "shape":"CustomLineItemProductCode",
+ "documentation":"<p> The product code associated with the custom line item. </p>"
+ },
+ "BillingGroupArn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. </p>"
+ },
+ "CreationTime":{
+ "shape":"Instant",
+ "documentation":"<p> The time created. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the custom line item was modified. </p>"
+ },
+ "AssociationSize":{
+ "shape":"NumberOfAssociations",
+ "documentation":"<p> The number of resources that are associated to the custom line item. </p>"
+ }
+ },
+ "documentation":"<p> A representation of a custom line item. </p>"
+ },
+ "CustomLineItemName":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+",
+ "sensitive":true
+ },
+ "CustomLineItemNameList":{
+ "type":"list",
+ "member":{"shape":"CustomLineItemName"},
+ "max":100,
+ "min":1
+ },
+ "CustomLineItemPercentageChargeDetails":{
+ "type":"structure",
+ "required":["PercentageValue"],
+ "members":{
+ "PercentageValue":{
+ "shape":"CustomLineItemPercentageChargeValue",
+ "documentation":"<p> The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. </p>"
+ },
+ "AssociatedValues":{
+ "shape":"CustomLineItemAssociationsList",
+ "documentation":"<p> A list of resource ARNs to associate to the percentage custom line item. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the charge details associated with a percentage custom line item. </p>"
+ },
+ "CustomLineItemPercentageChargeValue":{
+ "type":"double",
+ "box":true,
+ "max":10000,
+ "min":0
+ },
+ "CustomLineItemProductCode":{
+ "type":"string",
+ "max":29,
+ "min":1
+ },
+ "CustomLineItemRelationship":{
+ "type":"string",
+ "enum":[
+ "PARENT",
+ "CHILD"
+ ]
+ },
+ "CustomLineItemType":{
+ "type":"string",
+ "enum":[
+ "CREDIT",
+ "FEE"
+ ]
+ },
+ "DeleteBillingGroupInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the billing group you're deleting.</p>"
+ }
+ }
+ },
+ "DeleteBillingGroupOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the deleted billing group.</p>"
+ }
+ }
+ },
+ "DeleteCustomLineItemInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The ARN of the custom line item to be deleted. </p>"
+ },
+ "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"}
+ }
+ },
+ "DeleteCustomLineItemOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> Then ARN of the deleted custom line item. </p>"
+ }
+ }
+ },
+ "DeletePricingPlanInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the pricing plan you're deleting. </p>"
+ }
+ }
+ },
+ "DeletePricingPlanOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the deleted pricing plan. </p>"
+ }
+ }
+ },
+ "DeletePricingRuleInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing rule you are deleting. </p>"
+ }
+ }
+ },
+ "DeletePricingRuleOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the deleted pricing rule. </p>"
+ }
+ }
+ },
+ "DisassociateAccountsInput":{
+ "type":"structure",
+ "required":[
+ "Arn",
+ "AccountIds"
+ ],
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from. </p>"
+ },
+ "AccountIds":{
+ "shape":"AccountIdList",
+ "documentation":"<p>The array of account IDs to disassociate. </p>"
+ }
+ }
+ },
+ "DisassociateAccountsOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from. </p>"
+ }
+ }
+ },
+ "DisassociatePricingRulesInput":{
+ "type":"structure",
+ "required":[
+ "Arn",
+ "PricingRuleArns"
+ ],
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from. </p>"
+ },
+ "PricingRuleArns":{
+ "shape":"PricingRuleArnsNonEmptyInput",
+ "documentation":"<p> A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated. </p>"
+ }
+ }
+ },
+ "DisassociatePricingRulesOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from. </p>"
+ }
+ }
+ },
+ "DisassociateResourceResponseElement":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The resource ARN that was disassociated from the custom line item. </p>"
+ },
+ "Error":{
+ "shape":"AssociateResourceError",
+ "documentation":"<p> An <code>AssociateResourceError</code> shown if the resource disassociation fails. </p>"
+ }
+ },
+ "documentation":"<p> A resource disassociation result for a percentage custom line item. </p>"
+ },
+ "DisassociateResourcesResponseList":{
+ "type":"list",
+ "member":{"shape":"DisassociateResourceResponseElement"}
+ },
+ "Instant":{"type":"long"},
+ "InternalServerException":{
+ "type":"structure",
+ "required":["Message"],
+ "members":{
+ "Message":{"shape":"String"},
+ "RetryAfterSeconds":{
+ "shape":"RetryAfterSeconds",
+ "documentation":"<p>Number of seconds you can retry after the call. </p>",
+ "location":"header",
+ "locationName":"Retry-After"
+ }
+ },
+ "documentation":"<p>An unexpected error occurred while processing a request. </p>",
+ "error":{"httpStatusCode":500},
+ "exception":true,
+ "fault":true
+ },
+ "ListAccountAssociationsFilter":{
+ "type":"structure",
+ "members":{
+ "Association":{
+ "shape":"Association",
+ "documentation":"<p> <code>MONITORED</code>: linked accounts that are associated to billing groups.</p> <p> <code>UNMONITORED</code>: linked accounts that are not associated to billing groups.</p> <p> <code>Billing Group Arn</code>: linked accounts that are associated to the provided Billing Group Arn. </p>"
+ },
+ "AccountId":{
+ "shape":"AccountId",
+ "documentation":"<p> The Amazon Web Services account ID to filter on. </p>"
+ }
+ },
+ "documentation":"<p>The filter on the account ID of the linked account, or any of the following:</p> <p> <code>MONITORED</code>: linked accounts that are associated to billing groups.</p> <p> <code>UNMONITORED</code>: linked accounts that are not associated to billing groups.</p> <p> <code>Billing Group Arn</code>: linked accounts that are associated to the provided Billing Group Arn. </p>"
+ },
+ "ListAccountAssociationsInput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The preferred billing period to get account associations. </p>"
+ },
+ "Filters":{
+ "shape":"ListAccountAssociationsFilter",
+ "documentation":"<p>The filter on the account ID of the linked account, or any of the following:</p> <p> <code>MONITORED</code>: linked accounts that are associated to billing groups.</p> <p> <code>UNMONITORED</code>: linked accounts that are not associated to billing groups.</p> <p> <code>Billing Group Arn</code>: linked accounts that are associated to the provided billing group Arn. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token used on subsequent calls to retrieve accounts. </p>"
+ }
+ }
+ },
+ "ListAccountAssociationsOutput":{
+ "type":"structure",
+ "members":{
+ "LinkedAccounts":{
+ "shape":"AccountAssociationsList",
+ "documentation":"<p> The list of linked accounts in the payer account. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token used on subsequent calls to get accounts. </p>"
+ }
+ }
+ },
+ "ListBillingGroupCostReportsFilter":{
+ "type":"structure",
+ "members":{
+ "BillingGroupArns":{
+ "shape":"BillingGroupArnList",
+ "documentation":"<p>The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports. </p>"
+ }
+ },
+ "documentation":"<p>The filter used to retrieve specific <code>BillingGroupCostReportElements</code>. </p>"
+ },
+ "ListBillingGroupCostReportsInput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p>The preferred billing period for your report. </p>"
+ },
+ "MaxResults":{
+ "shape":"MaxBillingGroupResults",
+ "documentation":"<p>The maximum number of reports to retrieve. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>The pagination token used on subsequent calls to get reports. </p>"
+ },
+ "Filters":{
+ "shape":"ListBillingGroupCostReportsFilter",
+ "documentation":"<p>A <code>ListBillingGroupCostReportsFilter</code> to specify billing groups to retrieve reports from. </p>"
+ }
+ }
+ },
+ "ListBillingGroupCostReportsOutput":{
+ "type":"structure",
+ "members":{
+ "BillingGroupCostReports":{
+ "shape":"BillingGroupCostReportList",
+ "documentation":"<p>A list of <code>BillingGroupCostReportElement</code> retrieved. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>The pagination token used on subsequent calls to get reports. </p>"
+ }
+ }
+ },
+ "ListBillingGroupsFilter":{
+ "type":"structure",
+ "members":{
+ "Arns":{
+ "shape":"BillingGroupArnList",
+ "documentation":"<p>The list of billing group Amazon Resource Names (ARNs) to retrieve information. </p>"
+ },
+ "PricingPlan":{
+ "shape":"PricingPlanFullArn",
+ "documentation":"<p>The pricing plan Amazon Resource Names (ARNs) to retrieve information. </p>"
+ }
+ },
+ "documentation":"<p>The filter that specifies the billing groups and pricing plans to retrieve billing group information. </p>"
+ },
+ "ListBillingGroupsInput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p>The preferred billing period to get billing groups. </p>"
+ },
+ "MaxResults":{
+ "shape":"MaxBillingGroupResults",
+ "documentation":"<p>The maximum number of billing groups to retrieve. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>The pagination token used on subsequent calls to get billing groups. </p>"
+ },
+ "Filters":{
+ "shape":"ListBillingGroupsFilter",
+ "documentation":"<p>A <code>ListBillingGroupsFilter</code> that specifies the billing group and pricing plan to retrieve billing group information. </p>"
+ }
+ }
+ },
+ "ListBillingGroupsOutput":{
+ "type":"structure",
+ "members":{
+ "BillingGroups":{
+ "shape":"BillingGroupList",
+ "documentation":"<p>A list of <code>BillingGroupListElement</code> retrieved. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>The pagination token used on subsequent calls to get billing groups. </p>"
+ }
+ }
+ },
+ "ListCustomLineItemChargeDetails":{
+ "type":"structure",
+ "required":["Type"],
+ "members":{
+ "Flat":{
+ "shape":"ListCustomLineItemFlatChargeDetails",
+ "documentation":"<p> A <code>ListCustomLineItemFlatChargeDetails</code> that describes the charge details of a flat custom line item. </p>"
+ },
+ "Percentage":{
+ "shape":"ListCustomLineItemPercentageChargeDetails",
+ "documentation":"<p> A <code>ListCustomLineItemPercentageChargeDetails</code> that describes the charge details of a percentage custom line item. </p>"
+ },
+ "Type":{
+ "shape":"CustomLineItemType",
+ "documentation":"<p> The type of the custom line item that indicates whether the charge is a <code>fee</code> or <code>credit</code>. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the charge details of a custom line item. </p>"
+ },
+ "ListCustomLineItemFlatChargeDetails":{
+ "type":"structure",
+ "required":["ChargeValue"],
+ "members":{
+ "ChargeValue":{
+ "shape":"CustomLineItemChargeValue",
+ "documentation":"<p> The custom line item's fixed charge value in USD. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the charge details associated with a flat custom line item. </p>"
+ },
+ "ListCustomLineItemPercentageChargeDetails":{
+ "type":"structure",
+ "required":["PercentageValue"],
+ "members":{
+ "PercentageValue":{
+ "shape":"CustomLineItemPercentageChargeValue",
+ "documentation":"<p> The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the charge details associated with a percentage custom line item. </p>"
+ },
+ "ListCustomLineItemsFilter":{
+ "type":"structure",
+ "members":{
+ "Names":{
+ "shape":"CustomLineItemNameList",
+ "documentation":"<p> A list of custom line items to retrieve information. </p>"
+ },
+ "BillingGroups":{
+ "shape":"BillingGroupArnList",
+ "documentation":"<p> The billing group Amazon Resource Names (ARNs) to retrieve information. </p>"
+ },
+ "Arns":{
+ "shape":"CustomLineItemArns",
+ "documentation":"<p> A list of custom line item ARNs to retrieve information. </p>"
+ }
+ },
+ "documentation":"<p> A filter that specifies the custom line items and billing groups to retrieve FFLI information. </p>"
+ },
+ "ListCustomLineItemsInput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The preferred billing period to get custom line items (FFLIs). </p>"
+ },
+ "MaxResults":{
+ "shape":"MaxBillingGroupResults",
+ "documentation":"<p> The maximum number of billing groups to retrieve. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token used on subsequent calls to get custom line items (FFLIs). </p>"
+ },
+ "Filters":{
+ "shape":"ListCustomLineItemsFilter",
+ "documentation":"<p>A <code>ListCustomLineItemsFilter</code> that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.</p>"
+ }
+ }
+ },
+ "ListCustomLineItemsOutput":{
+ "type":"structure",
+ "members":{
+ "CustomLineItems":{
+ "shape":"CustomLineItemList",
+ "documentation":"<p> A list of <code>FreeFormLineItemListElements</code> received. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token used on subsequent calls to get custom line items (FFLIs). </p>"
+ }
+ }
+ },
+ "ListPricingPlansAssociatedWithPricingRuleInput":{
+ "type":"structure",
+ "required":["PricingRuleArn"],
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The pricing plan billing period for which associations will be listed. </p>"
+ },
+ "PricingRuleArn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The pricing rule Amazon Resource Name (ARN) for which associations will be listed. </p>"
+ },
+ "MaxResults":{
+ "shape":"MaxPricingRuleResults",
+ "documentation":"<p> The optional maximum number of pricing rule associations to retrieve. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The optional pagination token returned by a previous call. </p>"
+ }
+ }
+ },
+ "ListPricingPlansAssociatedWithPricingRuleOutput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The pricing plan billing period for which associations will be listed. </p>"
+ },
+ "PricingRuleArn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The pricing rule Amazon Resource Name (ARN) for which associations will be listed. </p>"
+ },
+ "PricingPlanArns":{
+ "shape":"PricingPlanArns",
+ "documentation":"<p> The list containing pricing plans associated with the requested pricing rule. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token to be used on subsequent calls. </p>"
+ }
+ }
+ },
+ "ListPricingPlansFilter":{
+ "type":"structure",
+ "members":{
+ "Arns":{
+ "shape":"PricingPlanArns",
+ "documentation":"<p>A list of pricing plan Amazon Resource Names (ARNs) to retrieve information. </p>"
+ }
+ },
+ "documentation":"<p>The filter that specifies the Amazon Resource Names (ARNs) of pricing plans, to retrieve pricing plan information. </p>"
+ },
+ "ListPricingPlansInput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p>The preferred billing period to get pricing plan. </p>"
+ },
+ "Filters":{
+ "shape":"ListPricingPlansFilter",
+ "documentation":"<p>A <code>ListPricingPlansFilter</code> that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.</p>"
+ },
+ "MaxResults":{
+ "shape":"MaxPricingPlanResults",
+ "documentation":"<p>The maximum number of pricing plans to retrieve.</p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>The pagination token used on subsequent call to get pricing plans. </p>"
+ }
+ }
+ },
+ "ListPricingPlansOutput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The billing period for which the described pricing plans are applicable. </p>"
+ },
+ "PricingPlans":{
+ "shape":"PricingPlanList",
+ "documentation":"<p>A list of <code>PricingPlanListElement</code> retrieved. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>The pagination token used on subsequent calls to get pricing plans. </p>"
+ }
+ }
+ },
+ "ListPricingRulesAssociatedToPricingPlanInput":{
+ "type":"structure",
+ "required":["PricingPlanArn"],
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The billing period for which the pricing rule associations are to be listed. </p>"
+ },
+ "PricingPlanArn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed.</p>"
+ },
+ "MaxResults":{
+ "shape":"MaxPricingPlanResults",
+ "documentation":"<p>The optional maximum number of pricing rule associations to retrieve.</p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The optional pagination token returned by a previous call. </p>"
+ }
+ }
+ },
+ "ListPricingRulesAssociatedToPricingPlanOutput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The billing period for which the pricing rule associations are listed. </p>"
+ },
+ "PricingPlanArn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing plan for which associations are listed.</p>"
+ },
+ "PricingRuleArns":{
+ "shape":"PricingRuleArns",
+ "documentation":"<p> A list containing pricing rules associated with the requested pricing plan. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token to be used on subsequent calls. </p>"
+ }
+ }
+ },
+ "ListPricingRulesFilter":{
+ "type":"structure",
+ "members":{
+ "Arns":{
+ "shape":"PricingRuleArns",
+ "documentation":"<p> A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response. </p>"
+ }
+ },
+ "documentation":"<p> The filter that specifies criteria that the pricing rules returned by the <code>ListPricingRules</code> API will adhere to. </p>"
+ },
+ "ListPricingRulesInput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The preferred billing period to get the pricing plan. </p>"
+ },
+ "Filters":{
+ "shape":"ListPricingRulesFilter",
+ "documentation":"<p> A <code>DescribePricingRuleFilter</code> that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information. </p>"
+ },
+ "MaxResults":{
+ "shape":"MaxPricingRuleResults",
+ "documentation":"<p> The maximum number of pricing rules to retrieve. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token used on subsequent call to get pricing rules. </p>"
+ }
+ }
+ },
+ "ListPricingRulesOutput":{
+ "type":"structure",
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The billing period for which the described pricing rules are applicable. </p>"
+ },
+ "PricingRules":{
+ "shape":"PricingRuleList",
+ "documentation":"<p> A list containing the described pricing rules. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token used on subsequent calls to get pricing rules. </p>"
+ }
+ }
+ },
+ "ListResourcesAssociatedToCustomLineItemFilter":{
+ "type":"structure",
+ "members":{
+ "Relationship":{
+ "shape":"CustomLineItemRelationship",
+ "documentation":"<p> The type of relationship between the custom line item and the associated resource. </p>"
+ }
+ },
+ "documentation":"<p> A filter that specifies the type of resource associations that should be retrieved for a custom line item. </p>"
+ },
+ "ListResourcesAssociatedToCustomLineItemInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "BillingPeriod":{
+ "shape":"BillingPeriod",
+ "documentation":"<p> The billing period for which the resource associations will be listed. </p>"
+ },
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The ARN of the custom line item for which the resource associations will be listed. </p>"
+ },
+ "MaxResults":{
+ "shape":"MaxCustomLineItemResults",
+ "documentation":"<p> (Optional) The maximum number of resource associations to be retrieved. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> (Optional) The pagination token returned by a previous request. </p>"
+ },
+ "Filters":{
+ "shape":"ListResourcesAssociatedToCustomLineItemFilter",
+ "documentation":"<p> (Optional) A <code>ListResourcesAssociatedToCustomLineItemFilter</code> that can specify the types of resources that should be retrieved. </p>"
+ }
+ }
+ },
+ "ListResourcesAssociatedToCustomLineItemOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The custom line item ARN for which the resource associations are listed. </p>"
+ },
+ "AssociatedResources":{
+ "shape":"ListResourcesAssociatedToCustomLineItemResponseList",
+ "documentation":"<p> A list of <code>ListResourcesAssociatedToCustomLineItemResponseElement</code> for each resource association retrieved. </p>"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p> The pagination token to be used in subsequent requests to retrieve additional results. </p>"
+ }
+ }
+ },
+ "ListResourcesAssociatedToCustomLineItemResponseElement":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemAssociationElement",
+ "documentation":"<p> The ARN of the associated resource. </p>"
+ },
+ "Relationship":{
+ "shape":"CustomLineItemRelationship",
+ "documentation":"<p> The type of relationship between the custom line item and the associated resource. </p>"
+ }
+ },
+ "documentation":"<p> A representation of a resource association for a custom line item. </p>"
+ },
+ "ListResourcesAssociatedToCustomLineItemResponseList":{
+ "type":"list",
+ "member":{"shape":"ListResourcesAssociatedToCustomLineItemResponseElement"}
+ },
+ "ListTagsForResourceRequest":{
+ "type":"structure",
+ "required":["ResourceArn"],
+ "members":{
+ "ResourceArn":{
+ "shape":"Arn",
+ "documentation":"<p> The Amazon Resource Name (ARN) that identifies the resource to list the tags. </p>",
+ "location":"uri",
+ "locationName":"ResourceArn"
+ }
+ }
+ },
+ "ListTagsForResourceResponse":{
+ "type":"structure",
+ "members":{
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p> The tags for the resource. </p>"
+ }
+ }
+ },
+ "Margin":{"type":"string"},
+ "MarginPercentage":{"type":"string"},
+ "MaxBillingGroupResults":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
+ "MaxCustomLineItemResults":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
+ "MaxPricingPlanResults":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
+ "MaxPricingRuleResults":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
+ "ModifierPercentage":{
+ "type":"double",
+ "box":true,
+ "min":0
+ },
+ "NumberOfAccounts":{
+ "type":"long",
+ "min":0
+ },
+ "NumberOfAssociatedPricingRules":{
+ "type":"long",
+ "min":1
+ },
+ "NumberOfAssociations":{
+ "type":"long",
+ "min":0
+ },
+ "NumberOfPricingPlansAssociatedWith":{
+ "type":"long",
+ "min":0
+ },
+ "PricingPlanArn":{
+ "type":"string",
+ "pattern":"(arn:aws:billingconductor::[0-9]{12}:pricingplan/)?[a-zA-Z0-9]{10}"
+ },
+ "PricingPlanArns":{
+ "type":"list",
+ "member":{"shape":"PricingPlanArn"},
+ "max":100,
+ "min":1
+ },
+ "PricingPlanDescription":{
+ "type":"string",
+ "max":1024,
+ "min":0,
+ "sensitive":true
+ },
+ "PricingPlanFullArn":{
+ "type":"string",
+ "pattern":"arn:aws:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}"
+ },
+ "PricingPlanList":{
+ "type":"list",
+ "member":{"shape":"PricingPlanListElement"}
+ },
+ "PricingPlanListElement":{
+ "type":"structure",
+ "members":{
+ "Name":{
+ "shape":"PricingPlanName",
+ "documentation":"<p>The name of a pricing plan. </p>"
+ },
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p>The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan. </p>"
+ },
+ "Description":{
+ "shape":"PricingPlanDescription",
+ "documentation":"<p>The pricing plan description. </p>"
+ },
+ "Size":{
+ "shape":"NumberOfAssociatedPricingRules",
+ "documentation":"<p> The pricing rules count currently associated with this pricing plan list element. </p>"
+ },
+ "CreationTime":{
+ "shape":"Instant",
+ "documentation":"<p> The time the pricing plan was created. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the pricing plan was modified. </p>"
+ }
+ },
+ "documentation":"<p>A representation of a pricing plan. </p>"
+ },
+ "PricingPlanName":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+",
+ "sensitive":true
+ },
+ "PricingRuleArn":{
+ "type":"string",
+ "pattern":"(arn:aws:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}"
+ },
+ "PricingRuleArns":{
+ "type":"list",
+ "member":{"shape":"PricingRuleArn"},
+ "max":100,
+ "min":1
+ },
+ "PricingRuleArnsInput":{
+ "type":"list",
+ "member":{"shape":"PricingRuleArn"},
+ "max":30,
+ "min":0
+ },
+ "PricingRuleArnsNonEmptyInput":{
+ "type":"list",
+ "member":{"shape":"PricingRuleArn"},
+ "max":30,
+ "min":1
+ },
+ "PricingRuleDescription":{
+ "type":"string",
+ "max":1024,
+ "min":0,
+ "sensitive":true
+ },
+ "PricingRuleList":{
+ "type":"list",
+ "member":{"shape":"PricingRuleListElement"}
+ },
+ "PricingRuleListElement":{
+ "type":"structure",
+ "members":{
+ "Name":{
+ "shape":"PricingRuleName",
+ "documentation":"<p> The name of a pricing rule. </p>"
+ },
+ "Arn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) used to uniquely identify a pricing rule. </p>"
+ },
+ "Description":{
+ "shape":"PricingRuleDescription",
+ "documentation":"<p> The pricing rule description. </p>"
+ },
+ "Scope":{
+ "shape":"PricingRuleScope",
+ "documentation":"<p> The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific. </p>"
+ },
+ "Type":{
+ "shape":"PricingRuleType",
+ "documentation":"<p> The type of pricing rule. </p>"
+ },
+ "ModifierPercentage":{
+ "shape":"ModifierPercentage",
+ "documentation":"<p> A percentage modifier applied on the public pricing rates. </p>"
+ },
+ "Service":{
+ "shape":"Service",
+ "documentation":"<p> If the <code>Scope</code> attribute is <code>SERVICE</code>, this attribute indicates which service the <code>PricingRule</code> is applicable for. </p>"
+ },
+ "AssociatedPricingPlanCount":{
+ "shape":"NumberOfPricingPlansAssociatedWith",
+ "documentation":"<p> The pricing plans count that this pricing rule is associated with. </p>"
+ },
+ "CreationTime":{
+ "shape":"Instant",
+ "documentation":"<p> The time the pricing rule was created. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the pricing rule was modified. </p>"
+ }
+ },
+ "documentation":"<p> A representation of a pricing rule. </p>"
+ },
+ "PricingRuleName":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"[a-zA-Z0-9_\\+=\\.\\-@]+",
+ "sensitive":true
+ },
+ "PricingRuleScope":{
+ "type":"string",
+ "enum":[
+ "GLOBAL",
+ "SERVICE"
+ ]
+ },
+ "PricingRuleType":{
+ "type":"string",
+ "enum":[
+ "MARKUP",
+ "DISCOUNT"
+ ]
+ },
+ "ProformaCost":{"type":"string"},
+ "ResourceNotFoundException":{
+ "type":"structure",
+ "required":[
+ "Message",
+ "ResourceId",
+ "ResourceType"
+ ],
+ "members":{
+ "Message":{"shape":"String"},
+ "ResourceId":{
+ "shape":"String",
+ "documentation":"<p>Resource identifier that was not found. </p>"
+ },
+ "ResourceType":{
+ "shape":"String",
+ "documentation":"<p>Resource type that was not found. </p>"
+ }
+ },
+ "documentation":"<p>The request references a resource that doesn't exist. </p>",
+ "error":{
+ "httpStatusCode":404,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "RetryAfterSeconds":{"type":"integer"},
+ "Service":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"[a-zA-Z0-9]+"
+ },
+ "ServiceLimitExceededException":{
+ "type":"structure",
+ "required":[
+ "Message",
+ "LimitCode",
+ "ServiceCode"
+ ],
+ "members":{
+ "Message":{"shape":"String"},
+ "ResourceId":{
+ "shape":"String",
+ "documentation":"<p>Identifier of the resource affected. </p>"
+ },
+ "ResourceType":{
+ "shape":"String",
+ "documentation":"<p>Type of the resource affected. </p>"
+ },
+ "LimitCode":{
+ "shape":"String",
+ "documentation":"<p>The unique code identifier of the service limit that is being exceeded. </p>"
+ },
+ "ServiceCode":{
+ "shape":"String",
+ "documentation":"<p>The unique code for the service of the limit that is being exceeded. </p>"
+ }
+ },
+ "documentation":"<p>The request would cause a service limit to exceed. </p>",
+ "error":{
+ "httpStatusCode":402,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "String":{"type":"string"},
+ "TagKey":{
+ "type":"string",
+ "max":128,
+ "min":1
+ },
+ "TagKeyList":{
+ "type":"list",
+ "member":{"shape":"TagKey"},
+ "max":200,
+ "min":1
+ },
+ "TagMap":{
+ "type":"map",
+ "key":{"shape":"TagKey"},
+ "value":{"shape":"TagValue"},
+ "max":200,
+ "min":1
+ },
+ "TagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "ResourceArn",
+ "Tags"
+ ],
+ "members":{
+ "ResourceArn":{
+ "shape":"Arn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the resource to which to add tags. </p>",
+ "location":"uri",
+ "locationName":"ResourceArn"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p> The tags to add to the resource as a list of key-value pairs. </p>"
+ }
+ }
+ },
+ "TagResourceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "TagValue":{
+ "type":"string",
+ "max":256,
+ "min":0
+ },
+ "ThrottlingException":{
+ "type":"structure",
+ "required":["Message"],
+ "members":{
+ "Message":{"shape":"String"},
+ "RetryAfterSeconds":{
+ "shape":"RetryAfterSeconds",
+ "documentation":"<p>Number of seconds you can safely retry after the call. </p>",
+ "location":"header",
+ "locationName":"Retry-After"
+ }
+ },
+ "documentation":"<p>The request was denied due to request throttling. </p>",
+ "error":{
+ "httpStatusCode":429,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "Token":{"type":"string"},
+ "UntagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "ResourceArn",
+ "TagKeys"
+ ],
+ "members":{
+ "ResourceArn":{
+ "shape":"Arn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the resource to which to delete tags. </p>",
+ "location":"uri",
+ "locationName":"ResourceArn"
+ },
+ "TagKeys":{
+ "shape":"TagKeyList",
+ "documentation":"<p> The tags to delete from the resource as a list of key-value pairs. </p>",
+ "location":"querystring",
+ "locationName":"tagKeys"
+ }
+ }
+ },
+ "UntagResourceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "UpdateBillingGroupInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the billing group being updated. </p>"
+ },
+ "Name":{
+ "shape":"BillingGroupName",
+ "documentation":"<p>The name of the billing group. The names must be unique to each billing group. </p>"
+ },
+ "Status":{
+ "shape":"BillingGroupStatus",
+ "documentation":"<p>The status of the billing group. Only one of the valid values can be used. </p>"
+ },
+ "ComputationPreference":{
+ "shape":"ComputationPreference",
+ "documentation":"<p> The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group. </p>"
+ },
+ "Description":{
+ "shape":"BillingGroupDescription",
+ "documentation":"<p>A description of the billing group. </p>"
+ }
+ }
+ },
+ "UpdateBillingGroupOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"BillingGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the billing group that was updated. </p>"
+ },
+ "Name":{
+ "shape":"BillingGroupName",
+ "documentation":"<p> The name of the billing group. The names must be unique to each billing group. </p>"
+ },
+ "Description":{
+ "shape":"BillingGroupDescription",
+ "documentation":"<p> A description of the billing group. </p>"
+ },
+ "PrimaryAccountId":{
+ "shape":"AccountId",
+ "documentation":"<p> The account ID that serves as the main account in a billing group. </p>"
+ },
+ "PricingPlanArn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group. </p>"
+ },
+ "Size":{
+ "shape":"NumberOfAccounts",
+ "documentation":"<p> The number of accounts in the particular billing group. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the billing group was modified. </p>"
+ },
+ "Status":{
+ "shape":"BillingGroupStatus",
+ "documentation":"<p> The status of the billing group. Only one of the valid values can be used. </p>"
+ },
+ "StatusReason":{
+ "shape":"BillingGroupStatusReason",
+ "documentation":"<p> The reason why the billing group is in its current status. </p>"
+ }
+ }
+ },
+ "UpdateCustomLineItemChargeDetails":{
+ "type":"structure",
+ "members":{
+ "Flat":{
+ "shape":"UpdateCustomLineItemFlatChargeDetails",
+ "documentation":"<p> An <code>UpdateCustomLineItemFlatChargeDetails</code> that describes the new charge details of a flat custom line item. </p>"
+ },
+ "Percentage":{
+ "shape":"UpdateCustomLineItemPercentageChargeDetails",
+ "documentation":"<p> An <code>UpdateCustomLineItemPercentageChargeDetails</code> that describes the new charge details of a percentage custom line item. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the new charge details of a custom line item. This should contain only one of <code>Flat</code> or <code>Percentage</code>. </p>"
+ },
+ "UpdateCustomLineItemFlatChargeDetails":{
+ "type":"structure",
+ "required":["ChargeValue"],
+ "members":{
+ "ChargeValue":{
+ "shape":"CustomLineItemChargeValue",
+ "documentation":"<p> The custom line item's new fixed charge value in USD. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the new charge details associated with a flat custom line item. </p>"
+ },
+ "UpdateCustomLineItemInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The ARN of the custom line item to be updated. </p>"
+ },
+ "Name":{
+ "shape":"BillingGroupName",
+ "documentation":"<p> The new name for the custom line item. </p>"
+ },
+ "Description":{
+ "shape":"CustomLineItemDescription",
+ "documentation":"<p> The new line item description of the custom line item. </p>"
+ },
+ "ChargeDetails":{
+ "shape":"UpdateCustomLineItemChargeDetails",
+ "documentation":"<p> A <code>ListCustomLineItemChargeDetails</code> containing the new charge details for the custom line item. </p>"
+ },
+ "BillingPeriodRange":{"shape":"CustomLineItemBillingPeriodRange"}
+ }
+ },
+ "UpdateCustomLineItemOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"CustomLineItemArn",
+ "documentation":"<p> The ARN of the successfully updated custom line item. </p>"
+ },
+ "BillingGroupArn":{
+ "shape":"BillingGroupFullArn",
+ "documentation":"<p> The ARN of the billing group that the custom line item is applied to. </p>"
+ },
+ "Name":{
+ "shape":"CustomLineItemName",
+ "documentation":"<p> The name of the successfully updated custom line item. </p>"
+ },
+ "Description":{
+ "shape":"CustomLineItemDescription",
+ "documentation":"<p> The description of the successfully updated custom line item. </p>"
+ },
+ "ChargeDetails":{
+ "shape":"ListCustomLineItemChargeDetails",
+ "documentation":"<p> A <code>ListCustomLineItemChargeDetails</code> containing the charge details of the successfully updated custom line item. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the custom line item was modified. </p>"
+ },
+ "AssociationSize":{
+ "shape":"NumberOfAssociations",
+ "documentation":"<p> The number of resources that are associated to the custom line item. </p>"
+ }
+ }
+ },
+ "UpdateCustomLineItemPercentageChargeDetails":{
+ "type":"structure",
+ "required":["PercentageValue"],
+ "members":{
+ "PercentageValue":{
+ "shape":"CustomLineItemPercentageChargeValue",
+ "documentation":"<p> The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value. </p>"
+ }
+ },
+ "documentation":"<p> A representation of the new charge details associated with a percentage custom line item. </p>"
+ },
+ "UpdatePricingPlanInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the pricing plan you're updating. </p>"
+ },
+ "Name":{
+ "shape":"PricingPlanName",
+ "documentation":"<p>The name of the pricing plan. The name must be unique to each pricing plan. </p>"
+ },
+ "Description":{
+ "shape":"PricingPlanDescription",
+ "documentation":"<p>The pricing plan description. </p>"
+ }
+ }
+ },
+ "UpdatePricingPlanOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingPlanArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the updated pricing plan. </p>"
+ },
+ "Name":{
+ "shape":"PricingPlanName",
+ "documentation":"<p> The name of the pricing plan. The name must be unique to each pricing plan. </p>"
+ },
+ "Description":{
+ "shape":"PricingPlanDescription",
+ "documentation":"<p> The new description for the pricing rule. </p>"
+ },
+ "Size":{
+ "shape":"NumberOfAssociatedPricingRules",
+ "documentation":"<p> The pricing rules count currently associated with this pricing plan list. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the pricing plan was modified. </p>"
+ }
+ }
+ },
+ "UpdatePricingRuleInput":{
+ "type":"structure",
+ "required":["Arn"],
+ "members":{
+ "Arn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the pricing rule to update. </p>"
+ },
+ "Name":{
+ "shape":"PricingRuleName",
+ "documentation":"<p> The new name of the pricing rule. The name must be unique to each pricing rule. </p>"
+ },
+ "Description":{
+ "shape":"PricingRuleDescription",
+ "documentation":"<p> The new description for the pricing rule. </p>"
+ },
+ "Type":{
+ "shape":"PricingRuleType",
+ "documentation":"<p> The new pricing rule type. </p>"
+ },
+ "ModifierPercentage":{
+ "shape":"ModifierPercentage",
+ "documentation":"<p> The new modifier to show pricing plan rates as a percentage. </p>"
+ }
+ }
+ },
+ "UpdatePricingRuleOutput":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"PricingRuleArn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the successfully updated pricing rule. </p>"
+ },
+ "Name":{
+ "shape":"PricingRuleName",
+ "documentation":"<p> The new name of the pricing rule. The name must be unique to each pricing rule. </p>"
+ },
+ "Description":{
+ "shape":"PricingRuleDescription",
+ "documentation":"<p> The new description for the pricing rule. </p>"
+ },
+ "Scope":{
+ "shape":"PricingRuleScope",
+ "documentation":"<p> The scope of pricing rule that indicates if it is globally applicable, or is service-specific. </p>"
+ },
+ "Type":{
+ "shape":"PricingRuleType",
+ "documentation":"<p> The new pricing rule type. </p>"
+ },
+ "ModifierPercentage":{
+ "shape":"ModifierPercentage",
+ "documentation":"<p> The new modifier to show pricing plan rates as a percentage. </p>"
+ },
+ "Service":{
+ "shape":"Service",
+ "documentation":"<p> If the <code>Scope</code> attribute is set to <code>SERVICE</code>, the attribute indicates which service the <code>PricingRule</code> is applicable for. </p>"
+ },
+ "AssociatedPricingPlanCount":{
+ "shape":"NumberOfPricingPlansAssociatedWith",
+ "documentation":"<p> The pricing plans count that this pricing rule is associated with. </p>"
+ },
+ "LastModifiedTime":{
+ "shape":"Instant",
+ "documentation":"<p> The most recent time the pricing rule was modified. </p>"
+ }
+ }
+ },
+ "ValidationException":{
+ "type":"structure",
+ "required":["Message"],
+ "members":{
+ "Message":{"shape":"String"},
+ "Reason":{
+ "shape":"ValidationExceptionReason",
+ "documentation":"<p>The reason the request's validation failed. </p>"
+ },
+ "Fields":{
+ "shape":"ValidationExceptionFieldList",
+ "documentation":"<p>The fields that caused the error, if applicable. </p>"
+ }
+ },
+ "documentation":"<p>The input doesn't match with the constraints specified by Amazon Web Services services.</p>",
+ "error":{
+ "httpStatusCode":400,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "ValidationExceptionField":{
+ "type":"structure",
+ "required":[
+ "Name",
+ "Message"
+ ],
+ "members":{
+ "Name":{
+ "shape":"String",
+ "documentation":"<p>The field name. </p>"
+ },
+ "Message":{
+ "shape":"String",
+ "documentation":"<p>The message describing why the field failed validation. </p>"
+ }
+ },
+ "documentation":"<p>The field's information of a request that resulted in an exception. </p>"
+ },
+ "ValidationExceptionFieldList":{
+ "type":"list",
+ "member":{"shape":"ValidationExceptionField"}
+ },
+ "ValidationExceptionReason":{
+ "type":"string",
+ "enum":[
+ "UNKNOWN_OPERATION",
+ "CANNOT_PARSE",
+ "FIELD_VALIDATION_FAILED",
+ "OTHER",
+ "PRIMARY_NOT_ASSOCIATED",
+ "PRIMARY_CANNOT_DISASSOCIATE",
+ "ACCOUNTS_NOT_ASSOCIATED",
+ "ACCOUNTS_ALREADY_ASSOCIATED",
+ "ILLEGAL_PRIMARY_ACCOUNT",
+ "ILLEGAL_ACCOUNTS",
+ "MISMATCHED_BILLINGGROUP_ARN",
+ "MISSING_BILLINGGROUP",
+ "MISMATCHED_CUSTOMLINEITEM_ARN",
+ "ILLEGAL_BILLING_PERIOD",
+ "ILLEGAL_BILLING_PERIOD_RANGE",
+ "TOO_MANY_ACCOUNTS_IN_REQUEST",
+ "DUPLICATE_ACCOUNT",
+ "INVALID_BILLING_GROUP_STATUS",
+ "MISMATCHED_PRICINGPLAN_ARN",
+ "MISSING_PRICINGPLAN",
+ "MISMATCHED_PRICINGRULE_ARN",
+ "DUPLICATE_PRICINGRULE_ARNS",
+ "ILLEGAL_EXPRESSION",
+ "ILLEGAL_SCOPE",
+ "ILLEGAL_SERVICE",
+ "PRICINGRULES_NOT_EXIST",
+ "PRICINGRULES_ALREADY_ASSOCIATED",
+ "PRICINGRULES_NOT_ASSOCIATED",
+ "INVALID_TIME_RANGE",
+ "INVALID_BILLINGVIEW_ARN",
+ "MISMATCHED_BILLINGVIEW_ARN",
+ "ILLEGAL_CUSTOMLINEITEM",
+ "MISSING_CUSTOMLINEITEM",
+ "ILLEGAL_CUSTOMLINEITEM_UPDATE",
+ "TOO_MANY_CUSTOMLINEITEMS_IN_REQUEST",
+ "ILLEGAL_CHARGE_DETAILS",
+ "ILLEGAL_UPDATE_CHARGE_DETAILS",
+ "INVALID_ARN",
+ "ILLEGAL_RESOURCE_ARNS",
+ "ILLEGAL_CUSTOMLINEITEM_MODIFICATION",
+ "MISSING_LINKED_ACCOUNT_IDS",
+ "MULTIPLE_LINKED_ACCOUNT_IDS",
+ "MISSING_PRICING_PLAN_ARN",
+ "MULTIPLE_PRICING_PLAN_ARN"
+ ]
+ }
+ },
+ "documentation":"<p>Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a <a href=\"https://docs.aws.amazon.com/enterprisebilling/6b7c01c5-b592-467e-9769-90052eaf359c/userguide/understanding-eb.html#eb-other-definitions\">pro forma</a> version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the <a href=\"https://console.aws.amazon.com/billing\">Amazon Web Services Billing console</a>, or configure a cost and usage report per billing group.</p> <p>This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the <a href=\"https://console.aws.amazon.com/enterprisebilling/\">Amazon Web Services Billing Conductor</a> user interface, see the <a href=\"https://docs.aws.amazon.com/enterprisebilling/6b7c01c5-b592-467e-9769-90052eaf359c/userguide/what-is-enterprisebilling.html\"> Amazon Web Services Enterprise Billing Console User Guide</a>.</p>"
+}
diff --git a/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/waiters-2.json b/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/waiters-2.json
new file mode 100644
index 0000000000..ee5023dc5b
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/billingconductor/2021-07-30/waiters-2.json
@@ -0,0 +1,4 @@
+{
+ "version": 2,
+ "waiters": {}
+}
diff --git a/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/paginators-1.json b/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/paginators-1.json
index 0124729416..15f7a63e05 100644
--- a/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/paginators-1.json
@@ -41,6 +41,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Actions"
+ },
+ "DescribeBudgetNotificationsForAccount": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "BudgetNotificationsForAccount"
}
}
}
diff --git a/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/service-2.json b/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/service-2.json
index cd5ecf7c32..4fe71ec03c 100644
--- a/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/budgets/2016-10-20/service-2.json
@@ -231,6 +231,24 @@
],
"documentation":"<p> Describes all of the budget actions for a budget. </p>"
},
+ "DescribeBudgetNotificationsForAccount":{
+ "name":"DescribeBudgetNotificationsForAccount",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"DescribeBudgetNotificationsForAccountRequest"},
+ "output":{"shape":"DescribeBudgetNotificationsForAccountResponse"},
+ "errors":[
+ {"shape":"InternalErrorException"},
+ {"shape":"InvalidParameterException"},
+ {"shape":"NotFoundException"},
+ {"shape":"InvalidNextTokenException"},
+ {"shape":"ExpiredNextTokenException"},
+ {"shape":"AccessDeniedException"}
+ ],
+ "documentation":"<p> Lists the budget names and notifications that are associated with an account. </p>"
+ },
"DescribeBudgetPerformanceHistory":{
"name":"DescribeBudgetPerformanceHistory",
"http":{
@@ -334,7 +352,7 @@
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p> <important> <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples\">Examples</a> section. </p> </important>"
+ "documentation":"<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until Amazon Web Services has new usage data to use for forecasting.</p> <important> <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples\">Examples</a> section. </p> </important>"
},
"UpdateBudgetAction":{
"name":"UpdateBudgetAction",
@@ -399,7 +417,7 @@
},
"AccountId":{
"type":"string",
- "documentation":"<p>The account ID of the user. It should be a 12-digit number.</p>",
+ "documentation":"<p>The account ID of the user. It's a 12-digit number.</p>",
"max":12,
"min":12,
"pattern":"\\d{12}"
@@ -421,37 +439,37 @@
"members":{
"ActionId":{
"shape":"ActionId",
- "documentation":"<p> A system-generated universally unique identifier (UUID) for the action. </p>"
+ "documentation":"<p>A system-generated universally unique identifier (UUID) for the action. </p>"
},
"BudgetName":{"shape":"BudgetName"},
"NotificationType":{"shape":"NotificationType"},
"ActionType":{
"shape":"ActionType",
- "documentation":"<p> The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition. </p>"
+ "documentation":"<p>The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition. </p>"
},
"ActionThreshold":{
"shape":"ActionThreshold",
- "documentation":"<p> The trigger threshold of the action. </p>"
+ "documentation":"<p>The trigger threshold of the action. </p>"
},
"Definition":{
"shape":"Definition",
- "documentation":"<p> Where you specify all of the type-specific parameters. </p>"
+ "documentation":"<p>Where you specify all of the type-specific parameters. </p>"
},
"ExecutionRoleArn":{
"shape":"RoleArn",
- "documentation":"<p> The role passed for action execution and reversion. Roles and actions must be in the same account. </p>"
+ "documentation":"<p>The role passed for action execution and reversion. Roles and actions must be in the same account. </p>"
},
"ApprovalModel":{
"shape":"ApprovalModel",
- "documentation":"<p> This specifies if the action needs manual or automatic approval. </p>"
+ "documentation":"<p>This specifies if the action needs manual or automatic approval. </p>"
},
"Status":{
"shape":"ActionStatus",
- "documentation":"<p> The status of action. </p>"
+ "documentation":"<p>The status of the action. </p>"
},
"Subscribers":{"shape":"Subscribers"}
},
- "documentation":"<p> A budget action resource. </p>"
+ "documentation":"<p>A budget action resource. </p>"
},
"ActionHistories":{
"type":"list",
@@ -471,18 +489,18 @@
"Timestamp":{"shape":"GenericTimestamp"},
"Status":{
"shape":"ActionStatus",
- "documentation":"<p> The status of action at the time of the event. </p>"
+ "documentation":"<p>The status of action at the time of the event. </p>"
},
"EventType":{
"shape":"EventType",
- "documentation":"<p> This distinguishes between whether the events are triggered by the user or generated by the system. </p>"
+ "documentation":"<p>This distinguishes between whether the events are triggered by the user or are generated by the system. </p>"
},
"ActionHistoryDetails":{
"shape":"ActionHistoryDetails",
- "documentation":"<p> The description of details of the event. </p>"
+ "documentation":"<p>The description of the details for the event. </p>"
}
},
- "documentation":"<p> The historical records for a budget action. </p>"
+ "documentation":"<p>The historical records for a budget action. </p>"
},
"ActionHistoryDetails":{
"type":"structure",
@@ -494,10 +512,10 @@
"Message":{"shape":"GenericString"},
"Action":{
"shape":"Action",
- "documentation":"<p> The budget action resource. </p>"
+ "documentation":"<p>The budget action resource. </p>"
}
},
- "documentation":"<p> The description of details of the event. </p>"
+ "documentation":"<p>The description of the details for the event. </p>"
},
"ActionId":{
"type":"string",
@@ -537,7 +555,7 @@
"ActionThresholdValue":{"shape":"NotificationThreshold"},
"ActionThresholdType":{"shape":"ThresholdType"}
},
- "documentation":"<p> The trigger threshold of the action. </p>"
+ "documentation":"<p>The trigger threshold of the action. </p>"
},
"ActionType":{
"type":"string",
@@ -553,6 +571,12 @@
"max":100,
"min":0
},
+ "AdjustmentPeriod":{
+ "type":"integer",
+ "box":true,
+ "max":60,
+ "min":1
+ },
"ApprovalModel":{
"type":"string",
"enum":[
@@ -560,6 +584,32 @@
"MANUAL"
]
},
+ "AutoAdjustData":{
+ "type":"structure",
+ "required":["AutoAdjustType"],
+ "members":{
+ "AutoAdjustType":{
+ "shape":"AutoAdjustType",
+ "documentation":"<p>The string that defines whether your budget auto-adjusts based on historical or forecasted data.</p>"
+ },
+ "HistoricalOptions":{
+ "shape":"HistoricalOptions",
+ "documentation":"<p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>"
+ },
+ "LastAutoAdjustTime":{
+ "shape":"GenericTimestamp",
+ "documentation":"<p>The last time that your budget was auto-adjusted.</p>"
+ }
+ },
+ "documentation":"<p>The parameters that determine the budget amount for an auto-adjusting budget.</p>"
+ },
+ "AutoAdjustType":{
+ "type":"string",
+ "enum":[
+ "HISTORICAL",
+ "FORECAST"
+ ]
+ },
"Budget":{
"type":"structure",
"required":[
@@ -574,15 +624,15 @@
},
"BudgetLimit":{
"shape":"Spend",
- "documentation":"<p>The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to <code>100</code>, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use <code>BudgetLimit</code> with <code>PlannedBudgetLimits</code> for <code>CreateBudget</code> and <code>UpdateBudget</code> actions. </p>"
+ "documentation":"<p>The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to <code>100</code>. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use <code>BudgetLimit</code> with <code>PlannedBudgetLimits</code> for <code>CreateBudget</code> and <code>UpdateBudget</code> actions. </p>"
},
"PlannedBudgetLimits":{
"shape":"PlannedBudgetLimits",
- "documentation":"<p>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</p> <p> <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports monthly and quarterly <code>TimeUnit</code>. </p> <p>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </p> <p>For quarterly budgets, provide 4 quarters of <code>PlannedBudgetLimits</code> value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The <code>key</code> is the start of the quarter, <code>UTC</code> in epoch seconds. </p> <p>If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the <code>PlannedBudgetLimits</code> values only for the remaining periods.</p> <p>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </p> <p>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </p> <p> <code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with <code>PlannedBudgetLimits</code> will also contain <code>BudgetLimit</code> representing the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This only applies to budgets created with <code>PlannedBudgetLimits</code>. Budgets created without <code>PlannedBudgetLimits</code> will only contain <code>BudgetLimit</code>, and no <code>PlannedBudgetLimits</code>.</p>"
+ "documentation":"<p>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</p> <p> <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports both monthly and quarterly <code>TimeUnit</code>. </p> <p>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </p> <p>For quarterly budgets, provide four quarters of <code>PlannedBudgetLimits</code> value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The <code>key</code> is the start of the quarter, <code>UTC</code> in epoch seconds. </p> <p>If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the <code>PlannedBudgetLimits</code> values only for the remaining periods.</p> <p>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </p> <p>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </p> <p> <code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with <code>PlannedBudgetLimits</code> also contain <code>BudgetLimit</code> representing the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This only applies to budgets that are created with <code>PlannedBudgetLimits</code>. Budgets that are created without <code>PlannedBudgetLimits</code> only contain <code>BudgetLimit</code>. They don't contain <code>PlannedBudgetLimits</code>.</p>"
},
"CostFilters":{
"shape":"CostFilters",
- "documentation":"<p>The cost filters, such as service or tag, that are applied to a budget.</p> <p>AWS Budgets supports the following services as a filter for RI budgets:</p> <ul> <li> <p>Amazon Elastic Compute Cloud - Compute</p> </li> <li> <p>Amazon Redshift</p> </li> <li> <p>Amazon Relational Database Service</p> </li> <li> <p>Amazon ElastiCache</p> </li> <li> <p>Amazon Elasticsearch Service</p> </li> </ul>"
+ "documentation":"<p>The cost filters, such as <code>Region</code>, <code>Service</code>, <code>member account</code>, <code>Tag</code>, or <code>Cost Category</code>, that are applied to a budget.</p> <p>Amazon Web Services Budgets supports the following services as a <code>Service</code> filter for RI budgets:</p> <ul> <li> <p>Amazon EC2</p> </li> <li> <p>Amazon Redshift</p> </li> <li> <p>Amazon Relational Database Service</p> </li> <li> <p>Amazon ElastiCache</p> </li> <li> <p>Amazon OpenSearch Service</p> </li> </ul>"
},
"CostTypes":{
"shape":"CostTypes",
@@ -594,7 +644,7 @@
},
"TimePeriod":{
"shape":"TimePeriod",
- "documentation":"<p>The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before <code>06/15/87 00:00 UTC</code>. </p> <p>If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers.</p>"
+ "documentation":"<p>The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before <code>06/15/87 00:00 UTC</code>. </p> <p>If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, Amazon Web Services set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, Amazon Web Services set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, Amazon Web Services set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.</p>"
},
"CalculatedSpend":{
"shape":"CalculatedSpend",
@@ -602,14 +652,18 @@
},
"BudgetType":{
"shape":"BudgetType",
- "documentation":"<p>Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.</p>"
+ "documentation":"<p>Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.</p>"
},
"LastUpdatedTime":{
"shape":"GenericTimestamp",
"documentation":"<p>The last time that you updated this budget.</p>"
+ },
+ "AutoAdjustData":{
+ "shape":"AutoAdjustData",
+ "documentation":"<p>The parameters that determine the budget amount for an auto-adjusting budget.</p>"
}
},
- "documentation":"<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p> <p>This is the ARN pattern for a budget: </p> <p> <code>arn:aws:budgets::AccountId:budget/budgetName</code> </p>"
+ "documentation":"<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p> <p>This is the Amazon Resource Name (ARN) pattern for a budget: </p> <p> <code>arn:aws:budgets::AccountId:budget/budgetName</code> </p>"
},
"BudgetName":{
"type":"string",
@@ -618,6 +672,19 @@
"min":1,
"pattern":"[^:\\\\]+"
},
+ "BudgetNotificationsForAccount":{
+ "type":"structure",
+ "members":{
+ "Notifications":{"shape":"Notifications"},
+ "BudgetName":{"shape":"BudgetName"}
+ },
+ "documentation":"<p> The budget name and associated notifications for an account. </p>"
+ },
+ "BudgetNotificationsForAccountList":{
+ "type":"list",
+ "member":{"shape":"BudgetNotificationsForAccount"},
+ "max":50
+ },
"BudgetPerformanceHistory":{
"type":"structure",
"members":{
@@ -634,7 +701,7 @@
"TimeUnit":{"shape":"TimeUnit"},
"BudgetedAndActualAmountsList":{
"shape":"BudgetedAndActualAmountsList",
- "documentation":"<p>A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.</p>"
+ "documentation":"<p>A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.</p>"
}
},
"documentation":"<p>A history of the state of a budget at the end of the budget's specified time period.</p>"
@@ -664,7 +731,7 @@
},
"TimePeriod":{
"shape":"TimePeriod",
- "documentation":"<p>The time period covered by this budget comparison.</p>"
+ "documentation":"<p>The time period that's covered by this budget comparison.</p>"
}
},
"documentation":"<p>The amount of cost or usage that you created the budget for, compared to your actual costs or usage.</p>"
@@ -684,18 +751,18 @@
"members":{
"ActualSpend":{
"shape":"Spend",
- "documentation":"<p>The amount of cost, usage, RI units, or Savings Plans units that you have used.</p>"
+ "documentation":"<p>The amount of cost, usage, RI units, or Savings Plans units that you used.</p>"
},
"ForecastedSpend":{
"shape":"Spend",
- "documentation":"<p>The amount of cost, usage, RI units, or Savings Plans units that you are forecasted to use.</p>"
+ "documentation":"<p>The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.</p>"
}
},
- "documentation":"<p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, RI units, or Savings Plans units and the <code>forecastedSpend</code> tracks how much you are predicted to spend based on your historical usage profile.</p> <p>For example, if it is the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>"
+ "documentation":"<p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, RI units, or Savings Plans units and the <code>forecastedSpend</code> tracks how much that you're predicted to spend based on your historical usage profile.</p> <p>For example, if it's the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>"
},
"ComparisonOperator":{
"type":"string",
- "documentation":"<p> The comparison operator of a notification. Currently the service supports the following operators:</p> <p> <code>GREATER_THAN</code>, <code>LESS_THAN</code>, <code>EQUAL_TO</code> </p>",
+ "documentation":"<p> The comparison operator of a notification. Currently, the service supports the following operators:</p> <p> <code>GREATER_THAN</code>, <code>LESS_THAN</code>, <code>EQUAL_TO</code> </p>",
"enum":[
"GREATER_THAN",
"LESS_THAN",
@@ -756,7 +823,7 @@
"documentation":"<p>Specifies whether a budget uses the amortized rate.</p> <p>The default value is <code>false</code>.</p>"
}
},
- "documentation":"<p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, and <code>SAVINGS_PLANS_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>"
+ "documentation":"<p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, and <code>SAVINGS_PLANS_COVERAGE</code> budgets don't have <code>CostTypes</code>.</p>"
},
"CreateBudgetActionRequest":{
"type":"structure",
@@ -825,7 +892,7 @@
},
"NotificationsWithSubscribers":{
"shape":"NotificationWithSubscribersList",
- "documentation":"<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</p>"
+ "documentation":"<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, Amazon Web Services creates the notifications and subscribers for you.</p>"
}
},
"documentation":"<p> Request of CreateBudget </p>"
@@ -851,7 +918,7 @@
},
"BudgetName":{
"shape":"BudgetName",
- "documentation":"<p>The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.</p>"
+ "documentation":"<p>The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.</p>"
},
"Notification":{
"shape":"Notification",
@@ -917,18 +984,18 @@
"members":{
"IamActionDefinition":{
"shape":"IamActionDefinition",
- "documentation":"<p> The AWS Identity and Access Management (IAM) action definition details. </p>"
+ "documentation":"<p>The Identity and Access Management (IAM) action definition details. </p>"
},
"ScpActionDefinition":{
"shape":"ScpActionDefinition",
- "documentation":"<p> The service control policies (SCPs) action definition details. </p>"
+ "documentation":"<p>The service control policies (SCPs) action definition details. </p>"
},
"SsmActionDefinition":{
"shape":"SsmActionDefinition",
- "documentation":"<p> The AWS Systems Manager (SSM) action definition details. </p>"
+ "documentation":"<p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>"
}
},
- "documentation":"<p> Specifies all of the type-specific parameters. </p>"
+ "documentation":"<p>Specifies all of the type-specific parameters. </p>"
},
"DeleteBudgetActionRequest":{
"type":"structure",
@@ -1152,6 +1219,28 @@
"NextToken":{"shape":"GenericString"}
}
},
+ "DescribeBudgetNotificationsForAccountRequest":{
+ "type":"structure",
+ "required":["AccountId"],
+ "members":{
+ "AccountId":{"shape":"AccountId"},
+ "MaxResults":{
+ "shape":"MaxResultsBudgetNotifications",
+ "documentation":"<p> An integer that shows how many budget name entries a paginated response contains. </p>"
+ },
+ "NextToken":{"shape":"GenericString"}
+ }
+ },
+ "DescribeBudgetNotificationsForAccountResponse":{
+ "type":"structure",
+ "members":{
+ "BudgetNotificationsForAccount":{
+ "shape":"BudgetNotificationsForAccountList",
+ "documentation":"<p> A list of budget names and associated notifications for an account. </p>"
+ },
+ "NextToken":{"shape":"GenericString"}
+ }
+ },
"DescribeBudgetPerformanceHistoryRequest":{
"type":"structure",
"required":[
@@ -1415,7 +1504,7 @@
},
"GenericTimestamp":{
"type":"timestamp",
- "documentation":"<p> A generic time stamp. In Java, it is transformed to a <code>Date</code> object.</p>"
+ "documentation":"<p> A generic time stamp. In Java, it's transformed to a <code>Date</code> object.</p>"
},
"Group":{
"type":"string",
@@ -1429,28 +1518,43 @@
"max":100,
"min":1
},
+ "HistoricalOptions":{
+ "type":"structure",
+ "required":["BudgetAdjustmentPeriod"],
+ "members":{
+ "BudgetAdjustmentPeriod":{
+ "shape":"AdjustmentPeriod",
+ "documentation":"<p>The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the <code>TimeUnit</code> granularity of the budget:</p> <ul> <li> <p>For the <code>DAILY</code> granularity, the maximum value is <code>60</code>.</p> </li> <li> <p>For the <code>MONTHLY</code> granularity, the maximum value is <code>12</code>.</p> </li> <li> <p>For the <code>QUARTERLY</code> granularity, the maximum value is <code>4</code>.</p> </li> <li> <p>For the <code>ANNUALLY</code> granularity, the maximum value is <code>1</code>.</p> </li> </ul>"
+ },
+ "LookBackAvailablePeriods":{
+ "shape":"AdjustmentPeriod",
+ "documentation":"<p>The integer that describes how many budget periods in your <code>BudgetAdjustmentPeriod</code> are included in the calculation of your current <code>BudgetLimit</code>. If the first budget period in your <code>BudgetAdjustmentPeriod</code> has no cost data, then that budget period isn’t included in the average that determines your budget limit. </p> <p>For example, if you set <code>BudgetAdjustmentPeriod</code> as <code>4</code> quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, <code>LookBackAvailablePeriods</code> returns <code>3</code>. </p> <p>You can’t set your own <code>LookBackAvailablePeriods</code>. The value is automatically calculated from the <code>BudgetAdjustmentPeriod</code> and your historical cost data.</p>"
+ }
+ },
+ "documentation":"<p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>"
+ },
"IamActionDefinition":{
"type":"structure",
"required":["PolicyArn"],
"members":{
"PolicyArn":{
"shape":"PolicyArn",
- "documentation":"<p> The Amazon Resource Name (ARN) of the policy to be attached. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the policy to be attached. </p>"
},
"Roles":{
"shape":"Roles",
- "documentation":"<p> A list of roles to be attached. There must be at least one role. </p>"
+ "documentation":"<p>A list of roles to be attached. There must be at least one role. </p>"
},
"Groups":{
"shape":"Groups",
- "documentation":"<p> A list of groups to be attached. There must be at least one group. </p>"
+ "documentation":"<p>A list of groups to be attached. There must be at least one group. </p>"
},
"Users":{
"shape":"Users",
- "documentation":"<p> A list of users to be attached. There must be at least one user. </p>"
+ "documentation":"<p>A list of users to be attached. There must be at least one user. </p>"
}
},
- "documentation":"<p> The AWS Identity and Access Management (IAM) action definition details. </p>"
+ "documentation":"<p>The Identity and Access Management (IAM) action definition details. </p>"
},
"InstanceId":{
"type":"string",
@@ -1495,6 +1599,12 @@
"max":100,
"min":1
},
+ "MaxResultsBudgetNotifications":{
+ "type":"integer",
+ "box":true,
+ "max":50,
+ "min":1
+ },
"NotFoundException":{
"type":"structure",
"members":{
@@ -1513,26 +1623,26 @@
"members":{
"NotificationType":{
"shape":"NotificationType",
- "documentation":"<p>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</p>"
+ "documentation":"<p>Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that you're forecasted to spend (<code>FORECASTED</code>).</p>"
},
"ComparisonOperator":{
"shape":"ComparisonOperator",
- "documentation":"<p>The comparison that is used for this notification.</p>"
+ "documentation":"<p>The comparison that's used for this notification.</p>"
},
"Threshold":{
"shape":"NotificationThreshold",
- "documentation":"<p>The threshold that is associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.</p>"
+ "documentation":"<p>The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.</p>"
},
"ThresholdType":{
"shape":"ThresholdType",
- "documentation":"<p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</p>"
+ "documentation":"<p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.</p>"
},
"NotificationState":{
"shape":"NotificationState",
- "documentation":"<p>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</p>"
+ "documentation":"<p>Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you passed the set threshold for the budget.</p>"
}
},
- "documentation":"<p>A notification that is associated with a budget. A budget can have up to ten notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A <code>thresholdType</code> of <code>PERCENTAGE</code> </p> </li> <li> <p>A <code>comparisonOperator</code> of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification <code>threshold</code> of <code>80</code> </p> </li> </ul>"
+ "documentation":"<p>A notification that's associated with a budget. A budget can have up to ten notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A <code>thresholdType</code> of <code>PERCENTAGE</code> </p> </li> <li> <p>A <code>comparisonOperator</code> of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification <code>threshold</code> of <code>80</code> </p> </li> </ul>"
},
"NotificationState":{
"type":"string",
@@ -1544,7 +1654,7 @@
"NotificationThreshold":{
"type":"double",
"documentation":"<p> The threshold of a notification.</p>",
- "max":40000000000,
+ "max":15000000000000,
"min":0
},
"NotificationType":{
@@ -1564,7 +1674,7 @@
"members":{
"Notification":{
"shape":"Notification",
- "documentation":"<p>The notification that is associated with a budget.</p>"
+ "documentation":"<p>The notification that's associated with a budget.</p>"
},
"Subscribers":{
"shape":"Subscribers",
@@ -1653,14 +1763,14 @@
"members":{
"PolicyId":{
"shape":"PolicyId",
- "documentation":"<p> The policy ID attached. </p>"
+ "documentation":"<p>The policy ID attached. </p>"
},
"TargetIds":{
"shape":"TargetIds",
- "documentation":"<p> A list of target IDs. </p>"
+ "documentation":"<p>A list of target IDs. </p>"
}
},
- "documentation":"<p> The service control policies (SCP) action definition details. </p>"
+ "documentation":"<p>The service control policies (SCP) action definition details. </p>"
},
"Spend":{
"type":"structure",
@@ -1671,14 +1781,14 @@
"members":{
"Amount":{
"shape":"NumericValue",
- "documentation":"<p>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</p>"
+ "documentation":"<p>The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.</p>"
},
"Unit":{
"shape":"UnitValue",
- "documentation":"<p>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
+ "documentation":"<p>The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP.</p>"
}
},
- "documentation":"<p>The amount of cost or usage that is measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>"
+ "documentation":"<p>The amount of cost or usage that's measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage has the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>"
},
"SsmActionDefinition":{
"type":"structure",
@@ -1690,18 +1800,18 @@
"members":{
"ActionSubType":{
"shape":"ActionSubType",
- "documentation":"<p> The action subType. </p>"
+ "documentation":"<p>The action subType. </p>"
},
"Region":{
"shape":"Region",
- "documentation":"<p> The Region to run the SSM document. </p>"
+ "documentation":"<p>The Region to run the SSM document. </p>"
},
"InstanceIds":{
"shape":"InstanceIds",
- "documentation":"<p> The EC2 and RDS instance IDs. </p>"
+ "documentation":"<p>The EC2 and RDS instance IDs. </p>"
}
},
- "documentation":"<p> The AWS Systems Manager (SSM) action definition details. </p>"
+ "documentation":"<p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>"
},
"Subscriber":{
"type":"structure",
@@ -1712,14 +1822,14 @@
"members":{
"SubscriptionType":{
"shape":"SubscriptionType",
- "documentation":"<p>The type of notification that AWS sends to a subscriber.</p>"
+ "documentation":"<p>The type of notification that Amazon Web Services sends to a subscriber.</p>"
},
"Address":{
"shape":"SubscriberAddress",
- "documentation":"<p>The address that AWS sends budget notifications to, either an SNS topic or an email.</p> <p>When you create a subscriber, the value of <code>Address</code> can't contain line breaks.</p>"
+ "documentation":"<p>The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.</p> <p>When you create a subscriber, the value of <code>Address</code> can't contain line breaks.</p>"
}
},
- "documentation":"<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p> <p>For example, an email subscriber would have the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>"
+ "documentation":"<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p> <p>For example, an email subscriber has the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>"
},
"SubscriberAddress":{
"type":"string",
@@ -1769,14 +1879,14 @@
"members":{
"Start":{
"shape":"GenericTimestamp",
- "documentation":"<p>The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>"
+ "documentation":"<p>The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, Amazon Web Services set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, Amazon Web Services set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>"
},
"End":{
"shape":"GenericTimestamp",
- "documentation":"<p>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</p>"
+ "documentation":"<p>The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API.</p> <p>After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</p>"
}
},
- "documentation":"<p>The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>"
+ "documentation":"<p>The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>"
},
"TimeUnit":{
"type":"string",
@@ -1958,5 +2068,5 @@
"documentation":"<p>The error message the exception carries.</p>"
}
},
- "documentation":"<p>The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets. </p> <p>Budgets provide you with a way to see the following information:</p> <ul> <li> <p>How close your plan is to your budgeted amount or to the free tier limits</p> </li> <li> <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p> </li> <li> <p>Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month</p> </li> <li> <p>How much of your budget has been used</p> </li> </ul> <p>AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p> <ul> <li> <p> <b>Cost budgets</b> - Plan how much you want to spend on a service.</p> </li> <li> <p> <b>Usage budgets</b> - Plan how much you want to use one or more services.</p> </li> <li> <p> <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p> </li> <li> <p> <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p> </li> </ul> <p>Service Endpoint</p> <p>The AWS Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.amazonaws.com</p> </li> </ul> <p>For information about costs that are associated with the AWS Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>"
+ "documentation":"<p>The Amazon Web Services Budgets API enables you to use Amazon Web Services Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Amazon Web Services Budgets. </p> <p>Budgets provide you with a way to see the following information:</p> <ul> <li> <p>How close your plan is to your budgeted amount or to the free tier limits</p> </li> <li> <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p> </li> <li> <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p> </li> <li> <p>How much of your budget has been used</p> </li> </ul> <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p> <ul> <li> <p> <b>Cost budgets</b> - Plan how much you want to spend on a service.</p> </li> <li> <p> <b>Usage budgets</b> - Plan how much you want to use one or more services.</p> </li> <li> <p> <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p> </li> <li> <p> <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p> </li> </ul> <p>Service Endpoint</p> <p>The Amazon Web Services Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.amazonaws.com</p> </li> </ul> <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">Amazon Web Services Cost Management Pricing</a>.</p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/ce/2017-10-25/service-2.json b/contrib/python/botocore/py3/botocore/data/ce/2017-10-25/service-2.json
index e473268804..adea1d8835 100644
--- a/contrib/python/botocore/py3/botocore/data/ce/2017-10-25/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ce/2017-10-25/service-2.json
@@ -399,6 +399,20 @@
],
"documentation":"<p>Returns the name, ARN, <code>NumberOfRules</code> and effective dates of all Cost Categories defined in the account. You have the option to use <code>EffectiveOn</code> to return a list of Cost Categories that were active on a specific date. If there is no <code>EffectiveOn</code> specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. <code>ListCostCategoryDefinitions</code> supports pagination. The request can have a <code>MaxResults</code> range up to 100.</p>"
},
+ "ListTagsForResource":{
+ "name":"ListTagsForResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListTagsForResourceRequest"},
+ "output":{"shape":"ListTagsForResourceResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"LimitExceededException"}
+ ],
+ "documentation":"<p>Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN). </p>"
+ },
"ProvideAnomalyFeedback":{
"name":"ProvideAnomalyFeedback",
"http":{
@@ -412,6 +426,35 @@
],
"documentation":"<p>Modifies the feedback property of a given cost anomaly. </p>"
},
+ "TagResource":{
+ "name":"TagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"TagResourceRequest"},
+ "output":{"shape":"TagResourceResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"TooManyTagsException"},
+ {"shape":"LimitExceededException"}
+ ],
+ "documentation":"<p>An API operation for adding one or more tags (key-value pairs) to a resource.</p> <p>You can use the <code>TagResource</code> operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.</p> <p> Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.</p>"
+ },
+ "UntagResource":{
+ "name":"UntagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"UntagResourceRequest"},
+ "output":{"shape":"UntagResourceResponse"},
+ "errors":[
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"LimitExceededException"}
+ ],
+ "documentation":"<p> Removes one or more tags from a resource. Specify only tag key(s) in your request. Do not specify the value. </p>"
+ },
"UpdateAnomalyMonitor":{
"name":"UpdateAnomalyMonitor",
"http":{
@@ -424,7 +467,7 @@
{"shape":"LimitExceededException"},
{"shape":"UnknownMonitorException"}
],
- "documentation":"<p>Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn'tt change anomalies detected in the past. </p>"
+ "documentation":"<p>Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past. </p>"
},
"UpdateAnomalySubscription":{
"name":"UpdateAnomalySubscription",
@@ -1078,6 +1121,10 @@
"AnomalyMonitor":{
"shape":"AnomalyMonitor",
"documentation":"<p>The cost anomaly detection monitor object that you want to create.</p>"
+ },
+ "ResourceTags":{
+ "shape":"ResourceTagList",
+ "documentation":"<p> An optional list of tags to associate with the specified <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html\"> <code>AnomalyMonitor</code> </a>. You can use resource tags to control access to your monitor using IAM policies.</p> <p>Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:</p> <ul> <li> <p>Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use</p> </li> <li> <p>The maximum length of a key is 128 characters</p> </li> <li> <p>The maximum length of a value is 256 characters</p> </li> <li> <p>Valid characters for keys and values are: <code>A-Z</code>, <code>a-z</code>, spaces, <code>_.:/=+-</code> </p> </li> <li> <p>Keys and values are case sensitive</p> </li> <li> <p>Keys and values are trimmed for any leading or trailing whitespaces</p> </li> <li> <p>Don’t use <code>aws:</code> as a prefix for your keys. This prefix is reserved for Amazon Web Services use</p> </li> </ul>"
}
}
},
@@ -1098,6 +1145,10 @@
"AnomalySubscription":{
"shape":"AnomalySubscription",
"documentation":"<p>The cost anomaly subscription object that you want to create. </p>"
+ },
+ "ResourceTags":{
+ "shape":"ResourceTagList",
+ "documentation":"<p> An optional list of tags to associate with the specified <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html\"> <code>AnomalySubscription</code> </a>. You can use resource tags to control access to your <code>subscription</code> using IAM policies.</p> <p>Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:</p> <ul> <li> <p>Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use</p> </li> <li> <p>The maximum length of a key is 128 characters</p> </li> <li> <p>The maximum length of a value is 256 characters</p> </li> <li> <p>Valid characters for keys and values are: <code>A-Z</code>, <code>a-z</code>, spaces, <code>_.:/=+-</code> </p> </li> <li> <p>Keys and values are case sensitive</p> </li> <li> <p>Keys and values are trimmed for any leading or trailing whitespaces</p> </li> <li> <p>Don’t use <code>aws:</code> as a prefix for your keys. This prefix is reserved for Amazon Web Services use</p> </li> </ul>"
}
}
},
@@ -1129,6 +1180,10 @@
"SplitChargeRules":{
"shape":"CostCategorySplitChargeRulesList",
"documentation":"<p> The split charge rules used to allocate your charges between your Cost Category values. </p>"
+ },
+ "ResourceTags":{
+ "shape":"ResourceTagList",
+ "documentation":"<p> An optional list of tags to associate with the specified <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html\"> <code>CostCategory</code> </a>. You can use resource tags to control access to your <code>cost category</code> using IAM policies.</p> <p>Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:</p> <ul> <li> <p>Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use</p> </li> <li> <p>The maximum length of a key is 128 characters</p> </li> <li> <p>The maximum length of a value is 256 characters</p> </li> <li> <p>Valid characters for keys and values are: <code>A-Z</code>, <code>a-z</code>, spaces, <code>_.:/=+-</code> </p> </li> <li> <p>Keys and values are case sensitive</p> </li> <li> <p>Keys and values are trimmed for any leading or trailing whitespaces</p> </li> <li> <p>Don’t use <code>aws:</code> as a prefix for your keys. This prefix is reserved for Amazon Web Services use</p> </li> </ul>"
}
}
},
@@ -1315,7 +1370,6 @@
"PLATFORM",
"SUBSCRIPTION_ID",
"LEGAL_ENTITY_NAME",
- "INVOICING_ENTITY",
"DEPLOYMENT_OPTION",
"DATABASE_ENGINE",
"CACHE_ENGINE",
@@ -1328,7 +1382,8 @@
"SAVINGS_PLAN_ARN",
"PAYMENT_OPTION",
"AGREEMENT_END_DATE_TIME_AFTER",
- "AGREEMENT_END_DATE_TIME_BEFORE"
+ "AGREEMENT_END_DATE_TIME_BEFORE",
+ "INVOICING_ENTITY"
]
},
"DimensionValues":{
@@ -1811,7 +1866,7 @@
},
"Filter":{
"shape":"Expression",
- "documentation":"<p>Filters Amazon Web Services costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p> <p>Valid values for <code>MatchOptions</code> for <code>CostCategories</code> and <code>Tags</code> are <code>EQUALS</code>, <code>ABSENT</code>, and <code>CASE_SENSITIVE</code>.</p> <p>The default values are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>. Valid values for <code>MatchOptions</code> for <code>Dimensions</code> are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p>"
+ "documentation":"<p>Filters Amazon Web Services costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p> <p>Valid values for <code>MatchOptions</code> for <code>Dimensions</code> are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p> <p>Valid values for <code>MatchOptions</code> for <code>CostCategories</code> and <code>Tags</code> are <code>EQUALS</code>, <code>ABSENT</code>, and <code>CASE_SENSITIVE</code>. Default values are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p>"
},
"Metrics":{
"shape":"MetricNames",
@@ -1866,7 +1921,7 @@
},
"Filter":{
"shape":"Expression",
- "documentation":"<p>Filters Amazon Web Services costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p> <p>The <code>GetCostAndUsageWithResources</code> operation requires that you either group by or filter by a <code>ResourceId</code>. It requires the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> <code>\"SERVICE = Amazon Elastic Compute Cloud - Compute\"</code> in the filter.</p> <p>Valid values for <code>MatchOptions</code> for <code>CostCategories</code> and <code>Tags</code> are <code>EQUALS</code>, <code>ABSENT</code>, and <code>CASE_SENSITIVE</code>.</p> <p>The default values are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>. Valid values for <code>MatchOptions</code> for <code>Dimensions</code> are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p>"
+ "documentation":"<p>Filters Amazon Web Services costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p> <p>The <code>GetCostAndUsageWithResources</code> operation requires that you either group by or filter by a <code>ResourceId</code>. It requires the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> <code>\"SERVICE = Amazon Elastic Compute Cloud - Compute\"</code> in the filter.</p> <p>Valid values for <code>MatchOptions</code> for <code>Dimensions</code> are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p> <p>Valid values for <code>MatchOptions</code> for <code>CostCategories</code> and <code>Tags</code> are <code>EQUALS</code>, <code>ABSENT</code>, and <code>CASE_SENSITIVE</code>. Default values are <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p>"
},
"Metrics":{
"shape":"MetricNames",
@@ -2736,6 +2791,25 @@
}
}
},
+ "ListTagsForResourceRequest":{
+ "type":"structure",
+ "required":["ResourceArn"],
+ "members":{
+ "ResourceArn":{
+ "shape":"Arn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html\">ResourceTag</a>.</p>"
+ }
+ }
+ },
+ "ListTagsForResourceResponse":{
+ "type":"structure",
+ "members":{
+ "ResourceTags":{
+ "shape":"ResourceTagList",
+ "documentation":"<p>A list of tag key value pairs that are associated with the response. </p>"
+ }
+ }
+ },
"LookbackPeriodInDays":{
"type":"string",
"enum":[
@@ -3327,11 +3401,54 @@
"ResourceNotFoundException":{
"type":"structure",
"members":{
- "Message":{"shape":"ErrorMessage"}
+ "Message":{"shape":"ErrorMessage"},
+ "ResourceName":{"shape":"Arn"}
},
"documentation":"<p> The specified ARN in the request doesn't exist. </p>",
"exception":true
},
+ "ResourceTag":{
+ "type":"structure",
+ "required":[
+ "Key",
+ "Value"
+ ],
+ "members":{
+ "Key":{
+ "shape":"ResourceTagKey",
+ "documentation":"<p> The key that is associated with the tag. </p>"
+ },
+ "Value":{
+ "shape":"ResourceTagValue",
+ "documentation":"<p> The value that is associated with the tag. </p>"
+ }
+ },
+ "documentation":"<p> The tag structure that contains a tag key and value. </p> <note> <p>Tagging is supported only for the following Cost Explorer resource types: <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html\"> <code>AnomalyMonitor</code> </a>, <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html\"> <code>AnomalySubscription</code> </a>, <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html\"> <code>CostCategory</code> </a>.</p> </note>"
+ },
+ "ResourceTagKey":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
+ },
+ "ResourceTagKeyList":{
+ "type":"list",
+ "member":{"shape":"ResourceTagKey"},
+ "max":200,
+ "min":0
+ },
+ "ResourceTagList":{
+ "type":"list",
+ "member":{"shape":"ResourceTag"},
+ "max":200,
+ "min":0
+ },
+ "ResourceTagValue":{
+ "type":"string",
+ "max":256,
+ "min":0,
+ "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
+ },
"ResourceUtilization":{
"type":"structure",
"members":{
@@ -3954,7 +4071,7 @@
"type":"string",
"max":302,
"min":6,
- "pattern":"(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+$)"
+ "pattern":"(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\\.fifo)?$)"
},
"SubscriberStatus":{
"type":"string",
@@ -3992,6 +4109,28 @@
"type":"list",
"member":{"shape":"Entity"}
},
+ "TagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "ResourceArn",
+ "ResourceTags"
+ ],
+ "members":{
+ "ResourceArn":{
+ "shape":"Arn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html\">ResourceTag</a>. </p>"
+ },
+ "ResourceTags":{
+ "shape":"ResourceTagList",
+ "documentation":"<p> A list of tag key-value pairs to be added to the resource.</p> <p>Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:</p> <ul> <li> <p>Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use</p> </li> <li> <p>The maximum length of a key is 128 characters</p> </li> <li> <p>The maximum length of a value is 256 characters</p> </li> <li> <p>Valid characters for keys and values are: <code>A-Z</code>, <code>a-z</code>, spaces, <code>_.:/=+-</code> </p> </li> <li> <p>Keys and values are case sensitive</p> </li> <li> <p>Keys and values are trimmed for any leading or trailing whitespaces</p> </li> <li> <p>Don’t use <code>aws:</code> as a prefix for your keys. This prefix is reserved for Amazon Web Services use</p> </li> </ul>"
+ }
+ }
+ },
+ "TagResourceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
"TagValues":{
"type":"structure",
"members":{
@@ -4073,6 +4212,15 @@
},
"documentation":"<p>Details on termination recommendation. </p>"
},
+ "TooManyTagsException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ErrorMessage"},
+ "ResourceName":{"shape":"Arn"}
+ },
+ "documentation":"<p>Can occur if you specify a number of tags for a resource greater than the maximum 50 user tags per resource.</p>",
+ "exception":true
+ },
"TotalActualHours":{"type":"string"},
"TotalActualUnits":{"type":"string"},
"TotalAmortizedFee":{"type":"string"},
@@ -4126,6 +4274,28 @@
"documentation":"<p>Cost Explorer was unable to identify the usage unit. Provide <code>UsageType/UsageTypeGroup</code> filter selections that contain matching units, for example: <code>hours</code>.</p>",
"exception":true
},
+ "UntagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "ResourceArn",
+ "ResourceTagKeys"
+ ],
+ "members":{
+ "ResourceArn":{
+ "shape":"Arn",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html\">ResourceTag</a>. </p>"
+ },
+ "ResourceTagKeys":{
+ "shape":"ResourceTagKeyList",
+ "documentation":"<p> A list of tag keys associated with tags that need to be removed from the resource. If you specify a tag key that does not exist, it is ignored. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use. </p>"
+ }
+ }
+ },
+ "UntagResourceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
"UnusedHours":{"type":"string"},
"UnusedUnits":{"type":"string"},
"UpdateAnomalyMonitorRequest":{
diff --git a/contrib/python/botocore/py3/botocore/data/chime-sdk-meetings/2021-07-15/service-2.json b/contrib/python/botocore/py3/botocore/data/chime-sdk-meetings/2021-07-15/service-2.json
index b39e8ceb4c..8f50bdac72 100644
--- a/contrib/python/botocore/py3/botocore/data/chime-sdk-meetings/2021-07-15/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/chime-sdk-meetings/2021-07-15/service-2.json
@@ -230,7 +230,7 @@
"documentation":"<p>Makes echo reduction available to clients who connect to the meeting.</p>"
}
},
- "documentation":"<p>An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.</p>"
+ "documentation":"<p>An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus. </p>"
},
"BadRequestException":{
"type":"structure",
@@ -368,7 +368,7 @@
},
"MediaRegion":{
"shape":"MediaRegion",
- "documentation":"<p>The Region in which to create the meeting.</p> <p> Available values: <code>af-south-1</code> , <code>ap-northeast-1</code> , <code>ap-northeast-2</code> , <code>ap-south-1</code> , <code>ap-southeast-1</code> , <code>ap-southeast-2</code> , <code>ca-central-1</code> , <code>eu-central-1</code> , <code>eu-north-1</code> , <code>eu-south-1</code> , <code>eu-west-1</code> , <code>eu-west-2</code> , <code>eu-west-3</code> , <code>sa-east-1</code> , <code>us-east-1</code> , <code>us-east-2</code> , <code>us-west-1</code> , <code>us-west-2</code> . </p>"
+ "documentation":"<p>The Region in which to create the meeting.</p> <p> Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>. </p> <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>"
},
"MeetingHostId":{
"shape":"ExternalUserId",
@@ -385,6 +385,10 @@
"MeetingFeatures":{
"shape":"MeetingFeaturesConfiguration",
"documentation":"<p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>"
+ },
+ "PrimaryMeetingId":{
+ "shape":"PrimaryMeetingId",
+ "documentation":"<p>When specified, replicates the media from the primary meeting to the new meeting.</p>"
}
}
},
@@ -413,7 +417,7 @@
},
"MediaRegion":{
"shape":"MediaRegion",
- "documentation":"<p>The Region in which to create the meeting.</p>"
+ "documentation":"<p>The Region in which to create the meeting.</p> <p> Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>. </p> <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>"
},
"MeetingHostId":{
"shape":"ExternalUserId",
@@ -434,6 +438,10 @@
"Attendees":{
"shape":"CreateMeetingWithAttendeesRequestItemList",
"documentation":"<p>The attendee information, including attendees' IDs and join tokens.</p>"
+ },
+ "PrimaryMeetingId":{
+ "shape":"PrimaryMeetingId",
+ "documentation":"<p>When specified, replicates the media from the primary meeting to the new meeting.</p>"
}
}
},
@@ -530,7 +538,6 @@
},
"EngineTranscribeSettings":{
"type":"structure",
- "required":["LanguageCode"],
"members":{
"LanguageCode":{
"shape":"TranscribeLanguageCode",
@@ -570,11 +577,23 @@
},
"PiiEntityTypes":{
"shape":"TranscribePiiEntityTypes",
- "documentation":"<p>Lists the PII entity types you want to identify or redact. To specify entity types, you must enable <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p> <p>PIIEntityTypes must be comma-separated. The available values are: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING, CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, and <code>ALL</code>.</p> <p> <code>PiiEntityTypes</code> is an optional parameter with a default value of <code>ALL</code>.</p>"
+ "documentation":"<p>Lists the PII entity types you want to identify or redact. To specify entity types, you must enable <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p> <p> <code>PIIEntityTypes</code> must be comma-separated. The available values are: <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING, CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>, <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>, <code>SSN</code>, and <code>ALL</code>.</p> <p> <code>PiiEntityTypes</code> is an optional parameter with a default value of <code>ALL</code>.</p>"
},
"LanguageModelName":{
"shape":"TranscribeLanguageModelName",
"documentation":"<p>The name of the language model used during transcription.</p>"
+ },
+ "IdentifyLanguage":{
+ "shape":"Boolean",
+ "documentation":"<p>Automatically identifies the language spoken in media files.</p>"
+ },
+ "LanguageOptions":{
+ "shape":"TranscribeLanguageOptions",
+ "documentation":"<p>Language codes for the languages that you want to identify. You must provide at least 2 codes.</p>"
+ },
+ "PreferredLanguage":{
+ "shape":"TranscribeLanguageCode",
+ "documentation":"<p>Language code for the preferred language.</p>"
}
},
"documentation":"<p>Settings specific to the Amazon Transcribe engine.</p>"
@@ -777,7 +796,7 @@
},
"MediaRegion":{
"shape":"MediaRegion",
- "documentation":"<p>The Region in which you create the meeting. Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>.</p>"
+ "documentation":"<p>The Region in which you create the meeting. Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>, <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>.</p> <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>"
},
"MediaPlacement":{
"shape":"MediaPlacement",
@@ -786,6 +805,10 @@
"MeetingFeatures":{
"shape":"MeetingFeaturesConfiguration",
"documentation":"<p>The features available to a meeting, such as Amazon Voice Focus.</p>"
+ },
+ "PrimaryMeetingId":{
+ "shape":"PrimaryMeetingId",
+ "documentation":"<p>When specified, replicates the media from the primary meeting to this meeting.</p>"
}
},
"documentation":"<p>A meeting created using the Amazon Chime SDK.</p>"
@@ -805,7 +828,7 @@
"documentation":"<p>The configuration settings for the audio features available to a meeting. </p>"
}
},
- "documentation":"<p>The configuration settings of the features available to a meeting.</p>"
+ "documentation":"<p>The configuration settings of the features available to a meeting.&gt;</p>"
},
"NotFoundException":{
"type":"structure",
@@ -839,6 +862,11 @@
},
"documentation":"<p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>"
},
+ "PrimaryMeetingId":{
+ "type":"string",
+ "max":64,
+ "min":2
+ },
"ResultMax":{
"type":"integer",
"max":100,
@@ -932,6 +960,12 @@
"min":1,
"pattern":"^[0-9a-zA-Z._-]+"
},
+ "TranscribeLanguageOptions":{
+ "type":"string",
+ "max":200,
+ "min":1,
+ "pattern":"^[a-zA-Z-,]+"
+ },
"TranscribeMedicalContentIdentificationType":{
"type":"string",
"enum":["PHI"]
@@ -1052,5 +1086,5 @@
"exception":true
}
},
- "documentation":"<p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see <a href=\"http://amazonaws.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_meetings\">Amazon Chime SDK meetings</a>.</p>"
+ "documentation":"<p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html\">Amazon Chime SDK meetings</a>.</p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/chime/2018-05-01/service-2.json b/contrib/python/botocore/py3/botocore/data/chime/2018-05-01/service-2.json
index 1f173dde91..e8562cfdee 100644
--- a/contrib/python/botocore/py3/botocore/data/chime/2018-05-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/chime/2018-05-01/service-2.json
@@ -525,6 +525,7 @@
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"UnauthorizedClientException"},
+ {"shape":"AccessDeniedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@@ -3710,7 +3711,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
- "documentation":"<p>Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.</p>"
+ "documentation":"<p>Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.</p>"
},
"UpdateSipRule":{
"name":"UpdateSipRule",
@@ -5231,7 +5232,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>Tags assigned to the <code>AppInstanceUser</code>.</p>"
+ "documentation":"<p>Tags assigned to the <code>AppInstance</code>.</p>"
}
}
},
@@ -7089,7 +7090,7 @@
},
"ContentIdentificationType":{
"shape":"TranscribeContentIdentificationType",
- "documentation":"<p>Set this field to <code>PII</code> to identify personal health information in the transcription output.</p>"
+ "documentation":"<p>Set this field to <code>PII</code> to identify personally identifiable information in the transcription output.</p>"
},
"ContentRedactionType":{
"shape":"TranscribeContentRedactionType",
@@ -9189,7 +9190,11 @@
"members":{
"EnableSIPLogs":{
"shape":"Boolean",
- "documentation":"<p>When true, enables SIP message logs for sending to Amazon CloudWatch Logs.</p>"
+ "documentation":"<p>Boolean that enables SIP message logs to CloudWatch logs.</p>"
+ },
+ "EnableMediaMetricLogs":{
+ "shape":"Boolean",
+ "documentation":"<p>Boolean that enables logging of detailed media metrics for Voice Connectors to CloudWatch logs.</p>"
}
},
"documentation":"<p>The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.</p>"
@@ -9322,7 +9327,7 @@
},
"EventIngestionUrl":{
"shape":"UriType",
- "documentation":"<p>The event ingestion URL.</p>"
+ "documentation":"<p>The event ingestion URL to which you send client meeting events.</p>"
}
},
"documentation":"<p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json
index a518241414..d33ba93806 100644
--- a/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json
@@ -57,7 +57,7 @@
{"shape":"UnsupportedOperationException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Cancels a query if the query is not in a terminated state, such as <code>CANCELLED</code>, <code>FAILED</code> or <code>FINISHED</code>. You must specify an ARN value for <code>EventDataStore</code>. The ID of the query that you want to cancel is also required. When you run <code>CancelQuery</code>, the query status might show as <code>CANCELLED</code> even if the operation is not yet finished.</p>",
+ "documentation":"<p>Cancels a query if the query is not in a terminated state, such as <code>CANCELLED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>FINISHED</code>. You must specify an ARN value for <code>EventDataStore</code>. The ID of the query that you want to cancel is also required. When you run <code>CancelQuery</code>, the query status might show as <code>CANCELLED</code> even if the operation is not yet finished.</p>",
"idempotent":true
},
"CreateEventDataStore":{
@@ -365,7 +365,7 @@
{"shape":"OperationNotPermittedException"},
{"shape":"UnsupportedOperationException"}
],
- "documentation":"<p>Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for <code>EventDataStore</code>. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding <code>StartTime</code> and <code>EndTime</code> parameters, and a <code>QueryStatus</code> value. Valid values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, or <code>CANCELLED</code>.</p>",
+ "documentation":"<p>Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for <code>EventDataStore</code>. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding <code>StartTime</code> and <code>EndTime</code> parameters, and a <code>QueryStatus</code> value. Valid values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code>.</p>",
"idempotent":true
},
"ListTags":{
@@ -1075,7 +1075,7 @@
},
"QueryStatus":{
"shape":"QueryStatus",
- "documentation":"<p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, or <code>CANCELLED</code> </p>"
+ "documentation":"<p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code> </p>"
},
"QueryStatistics":{
"shape":"QueryStatisticsForDescribeQuery",
@@ -1437,7 +1437,7 @@
"members":{
"QueryStatus":{
"shape":"QueryStatus",
- "documentation":"<p>The status of the query. Values include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, or <code>CANCELLED</code>.</p>"
+ "documentation":"<p>The status of the query. Values include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code>.</p>"
},
"QueryStatistics":{
"shape":"QueryStatistics",
@@ -1569,7 +1569,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>The specified query cannot be canceled because it is in the <code>FINISHED</code>, <code>FAILED</code>, or <code>CANCELLED</code> state.</p>",
+ "documentation":"<p>The specified query cannot be canceled because it is in the <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code> state.</p>",
"exception":true
},
"InsightNotEnabledException":{
@@ -1906,7 +1906,7 @@
},
"QueryStatus":{
"shape":"QueryStatus",
- "documentation":"<p>The status of queries that you want to return in results. Valid values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, or <code>CANCELLED</code>.</p>"
+ "documentation":"<p>The status of queries that you want to return in results. Valid values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code>.</p>"
}
}
},
@@ -2228,7 +2228,7 @@
},
"QueryStatus":{
"shape":"QueryStatus",
- "documentation":"<p>The status of the query. This can be <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, or <code>CANCELLED</code>.</p>"
+ "documentation":"<p>The status of the query. This can be <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code>.</p>"
},
"CreationTime":{
"shape":"Date",
@@ -2275,6 +2275,10 @@
"TotalResultsCount":{
"shape":"Integer",
"documentation":"<p>The total number of results returned by a query.</p>"
+ },
+ "BytesScanned":{
+ "shape":"Long",
+ "documentation":"<p>The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.</p>"
}
},
"documentation":"<p>Metadata about a query, such as the number of results.</p>"
@@ -2290,6 +2294,10 @@
"shape":"Long",
"documentation":"<p>The number of events that the query scanned in the event data store.</p>"
},
+ "BytesScanned":{
+ "shape":"Long",
+ "documentation":"<p>The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.</p>"
+ },
"ExecutionTimeInMillis":{
"shape":"Integer",
"documentation":"<p>The query's run time, in milliseconds.</p>"
@@ -2308,7 +2316,8 @@
"RUNNING",
"FINISHED",
"FAILED",
- "CANCELLED"
+ "CANCELLED",
+ "TIMED_OUT"
]
},
"ReadWriteType":{
diff --git a/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/service-2.json b/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/service-2.json
index 35d103b24f..dda43de47e 100644
--- a/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/service-2.json
@@ -96,7 +96,7 @@
{"shape":"UnsupportedUserStateException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Creates a new user in the specified user pool.</p> <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.</p> <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code> for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p> <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change their password.</p> <p> <code>AdminCreateUser</code> requires developer credentials.</p>"
+ "documentation":"<p>Creates a new user in the specified user pool.</p> <p>If <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS).</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.</p> <p>Alternatively, you can call <code>AdminCreateUser</code> with <code>SUPPRESS</code> for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. </p> <p>In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change their password.</p> <p> <code>AdminCreateUser</code> requires developer credentials.</p>"
},
"AdminDeleteUser":{
"name":"AdminDeleteUser",
@@ -150,7 +150,7 @@
{"shape":"AliasExistsException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Amazon Cognito User Pools native username + password user, they aren't permitted to use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked <code>DestinationUser</code>) signs in, they must create a new user account. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html\">AdminLinkProviderForUser</a>.</p> <p>This action is enabled only for admin access and requires developer credentials.</p> <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p> <p>To deactivate a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the name that is used in the user pool for the user.</p> <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social identity providers. The <code>ProviderAttributeValue</code> must always be the exact subject that was used when the user was originally linked as a source user.</p> <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code> must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked using <code> AdminLinkProviderForUser</code> call. (If the linking was done with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.</p>"
+ "documentation":"<p>Prevents the user from signing in with the specified external (SAML or social) identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external identity provider (IdP) user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked <code>DestinationUser</code>, the user must create a new user account. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html\">AdminLinkProviderForUser</a>.</p> <p>This action is enabled only for admin access and requires developer credentials.</p> <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p> <p>To deactivate a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the name that is used in the user pool for the user.</p> <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social identity providers. The <code>ProviderAttributeValue</code> must always be the exact subject that was used when the user was originally linked as a source user.</p> <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code> must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked using <code> AdminLinkProviderForUser</code> call. (If the linking was done with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.</p>"
},
"AdminDisableUser":{
"name":"AdminDisableUser",
@@ -267,7 +267,7 @@
{"shape":"UserNotFoundException"},
{"shape":"UserNotConfirmedException"}
],
- "documentation":"<p>Initiates the authentication flow, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
+ "documentation":"<p>Initiates the authentication flow, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
},
"AdminLinkProviderForUser":{
"name":"AdminLinkProviderForUser",
@@ -384,7 +384,7 @@
{"shape":"InvalidSmsRoleTrustRelationshipException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Resets the specified user's password in a user pool as an administrator. Works on any user.</p> <p>When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
+ "documentation":"<p>Resets the specified user's password in a user pool as an administrator. Works on any user.</p> <p>When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
},
"AdminRespondToAuthChallenge":{
"name":"AdminRespondToAuthChallenge",
@@ -416,7 +416,7 @@
{"shape":"UserNotConfirmedException"},
{"shape":"SoftwareTokenMFANotFoundException"}
],
- "documentation":"<p>Responds to an authentication challenge, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
+ "documentation":"<p>Responds to an authentication challenge, as an administrator.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
},
"AdminSetUserMFAPreference":{
"name":"AdminSetUserMFAPreference",
@@ -534,7 +534,7 @@
{"shape":"InvalidEmailRoleAccessPolicyException"},
{"shape":"InvalidSmsRoleTrustRelationshipException"}
],
- "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> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action 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> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Calling this action requires developer credentials.</p>"
},
"AdminUserGlobalSignOut":{
"name":"AdminUserGlobalSignOut",
@@ -768,7 +768,7 @@
{"shape":"UserPoolTaggingException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>"
+ "documentation":"<p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>"
},
"CreateUserPoolClient":{
"name":"CreateUserPoolClient",
@@ -1108,10 +1108,9 @@
{"shape":"InvalidEmailRoleAccessPolicyException"},
{"shape":"CodeDeliveryFailureException"},
{"shape":"UserNotFoundException"},
- {"shape":"UserNotConfirmedException"},
{"shape":"InternalErrorException"}
],
- "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. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html\">Recovering User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists, an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html\">ConfirmForgotPassword</a>. </p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "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. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html\">Recovering User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists, an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html\">ConfirmForgotPassword</a>. </p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"GetCSVHeader":{
@@ -1265,7 +1264,7 @@
{"shape":"UserNotConfirmedException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Gets the user attribute verification code for the specified attribute name.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "documentation":"<p>Gets the user attribute verification code for the specified attribute name.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"GetUserPoolMfaConfig":{
@@ -1328,7 +1327,7 @@
{"shape":"InvalidSmsRoleAccessPolicyException"},
{"shape":"InvalidSmsRoleTrustRelationshipException"}
],
- "documentation":"<p>Initiates the authentication flow.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "documentation":"<p>Initiates the authentication flow.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"ListDevices":{
@@ -1528,7 +1527,7 @@
{"shape":"UserNotFoundException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "documentation":"<p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"RespondToAuthChallenge":{
@@ -1561,7 +1560,7 @@
{"shape":"InternalErrorException"},
{"shape":"SoftwareTokenMFANotFoundException"}
],
- "documentation":"<p>Responds to the authentication challenge.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "documentation":"<p>Responds to the authentication challenge.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"RevokeToken":{
@@ -1655,7 +1654,7 @@
{"shape":"NotAuthorizedException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Sets the user pool multi-factor authentication (MFA) configuration.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>"
+ "documentation":"<p>Sets the user pool multi-factor authentication (MFA) configuration.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>"
},
"SetUserSettings":{
"name":"SetUserSettings",
@@ -1701,7 +1700,7 @@
{"shape":"InvalidEmailRoleAccessPolicyException"},
{"shape":"CodeDeliveryFailureException"}
],
- "documentation":"<p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "documentation":"<p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"StartUserImportJob":{
@@ -1894,7 +1893,7 @@
{"shape":"UserNotConfirmedException"},
{"shape":"InternalErrorException"}
],
- "documentation":"<p>Allows a user to update a specific attribute (one at a time).</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
+ "documentation":"<p>Allows a user to update a specific attribute (one at a time).</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>",
"authtype":"none"
},
"UpdateUserPool":{
@@ -1918,7 +1917,7 @@
{"shape":"UserPoolTaggingException"},
{"shape":"InvalidEmailRoleAccessPolicyException"}
],
- "documentation":"<p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html\">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be set to the default value.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to U.S. phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito will use the registered number automatically. Otherwise, Amazon Cognito users that must receive SMS messages might be unable to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you will have limitations, such as sending messages only to verified phone numbers. After testing in the sandbox environment, you can move out of the SMS sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>"
+ "documentation":"<p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html\">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be set to the default value.</p> <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note>"
},
"UpdateUserPoolClient":{
"name":"UpdateUserPoolClient",
@@ -2038,7 +2037,7 @@
},
"EventAction":{
"shape":"AccountTakeoverEventActionType",
- "documentation":"<p>The event action.</p> <ul> <li> <p> <code>BLOCK</code> Choosing this action will block the request.</p> </li> <li> <p> <code>MFA_IF_CONFIGURED</code> Present an MFA challenge if user has configured it, else allow the request.</p> </li> <li> <p> <code>MFA_REQUIRED</code> Present an MFA challenge if user has configured it, else block the request.</p> </li> <li> <p> <code>NO_ACTION</code> Allow the user to sign in.</p> </li> </ul>"
+ "documentation":"<p>The action to take in response to the account takeover action. Valid values are:</p> <ul> <li> <p> <code>BLOCK</code> Choosing this action will block the request.</p> </li> <li> <p> <code>MFA_IF_CONFIGURED</code> Present an MFA challenge if user has configured it, else allow the request.</p> </li> <li> <p> <code>MFA_REQUIRED</code> Present an MFA challenge if user has configured it, else block the request.</p> </li> <li> <p> <code>NO_ACTION</code> Allow the user to sign in.</p> </li> </ul>"
}
},
"documentation":"<p>Account takeover action type.</p>"
@@ -2148,7 +2147,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the <code>clientMetadata</code> attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the <code>clientMetadata</code> attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to confirm user registration.</p>"
@@ -2218,7 +2217,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the <i>pre sign-up</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to create a user in the specified user pool.</p>"
@@ -2456,7 +2455,7 @@
},
"UserStatus":{
"shape":"UserStatusType",
- "documentation":"<p>The user status. Can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>COMPROMISED - User is disabled due to a potential security threat.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>"
+ "documentation":"<p>The user status. Can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>"
},
"MFAOptions":{
"shape":"MFAOptionListType",
@@ -2499,7 +2498,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p> <ul> <li> <p>Pre signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p> </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p> <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p> <ul> <li> <p>Pre signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p> </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p> <p>When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
},
"AnalyticsMetadata":{
"shape":"AnalyticsMetadataType",
@@ -2548,7 +2547,7 @@
},
"DestinationUser":{
"shape":"ProviderUserIdentifierType",
- "documentation":"<p>The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Amazon Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.</p> <p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user, it should be the provider-specific <code>user_id</code>.</p> <p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p> <p>The <code>ProviderName</code> should be set to <code>Cognito</code> for users in Cognito user pools.</p> <important> <p>All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.</p> </important>"
+ "documentation":"<p>The existing user in the user pool that you want to assign to the external identity provider user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked identity provider attribute) signs in.</p> <p>For a native username + password user, the <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> should be the username in the user pool. For a federated user, it should be the provider-specific <code>user_id</code>.</p> <p>The <code>ProviderAttributeName</code> of the <code>DestinationUser</code> is ignored.</p> <p>The <code>ProviderName</code> should be set to <code>Cognito</code> for users in Cognito user pools.</p> <important> <p>All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.</p> </important>"
},
"SourceUser":{
"shape":"ProviderUserIdentifierType",
@@ -2716,7 +2715,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to reset a user's password as an administrator.</p>"
@@ -2765,7 +2764,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, <i>post authentication</i>, <i>user migration</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth challenge</i>, and <i>verify auth challenge response</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers: </p> <ul> <li> <p>pre sign-up</p> </li> <li> <p>custom message</p> </li> <li> <p>post authentication</p> </li> <li> <p>user migration</p> </li> <li> <p>pre token generation</p> </li> <li> <p>define auth challenge</p> </li> <li> <p>create auth challenge</p> </li> <li> <p>verify auth challenge response</p> </li> </ul> <p>When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>The request to respond to the authentication challenge, as an administrator.</p>"
@@ -2969,7 +2968,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to update the user's attributes as an administrator.</p>"
@@ -3044,7 +3043,7 @@
},
"ApplicationArn":{
"shape":"ArnType",
- "documentation":"<p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for integration with the chosen User Pool Client. Amazon Cognito publishes events to the Amazon Pinpointproject declared by the app ARN.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpointproject declared by the app ARN.</p>"
},
"RoleArn":{
"shape":"ArnType",
@@ -3059,7 +3058,7 @@
"documentation":"<p>If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.</p>"
}
},
- "documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.</p> <note> <p>In Regions where Pinpoint isn't available, User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In Regions where Pinpoint is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region. </p> </note>"
+ "documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.</p> <note> <p>In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p> </note>"
},
"AnalyticsMetadataType":{
"type":"structure",
@@ -3069,7 +3068,7 @@
"documentation":"<p>The endpoint ID.</p>"
}
},
- "documentation":"<p>An Amazon Pinpoint analytics endpoint.</p> <p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.</p> <note> <p>Amazon Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region in which the user pool resides.</p> </note>"
+ "documentation":"<p>An Amazon Pinpoint analytics endpoint.</p> <p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.</p> <note> <p>Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.</p> </note>"
},
"ArnType":{
"type":"string",
@@ -3249,7 +3248,7 @@
"BlockedIPRangeListType":{
"type":"list",
"member":{"shape":"StringType"},
- "max":20
+ "max":200
},
"BooleanType":{"type":"boolean"},
"CSSType":{"type":"string"},
@@ -3549,7 +3548,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>The request representing the confirmation for a password reset.</p>"
@@ -3598,7 +3597,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the <i>post confirmation</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to confirm registration of a user.</p>"
@@ -3840,11 +3839,11 @@
},
"WriteAttributes":{
"shape":"ClientPermissionListType",
- "documentation":"<p>The user pool attributes that the app client can write to.</p> <p>If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html\">Specifying Identity Provider Attribute Mappings for Your User Pool</a>.</p>"
+ "documentation":"<p>The user pool attributes that the app client can write to.</p> <p>If your app client allows users to sign in through an identity provider, this array must include all attributes that you have mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html\">Specifying Identity Provider Attribute Mappings for Your user pool</a>.</p>"
},
"ExplicitAuthFlows":{
"shape":"ExplicitAuthFlowsListType",
- "documentation":"<p>The authentication flows that are supported by the user pool clients. Flow names without the <code>ALLOW_</code> prefix are no longer supported, in favor of new names with the <code>ALLOW_</code> prefix. Note that values with <code>ALLOW_</code> prefix must be used only along with the <code>ALLOW_</code> prefix.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.</p> </li> <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li> <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li> <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li> <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li> </ul>"
+ "documentation":"<p>The authentication flows that are supported by the user pool clients. Flow names without the <code>ALLOW_</code> prefix are no longer supported, in favor of new names with the <code>ALLOW_</code> prefix.</p> <note> <p>Values with <code>ALLOW_</code> prefix must be used only along with the <code>ALLOW_</code> prefix.</p> </note> <p>Valid values include:</p> <ul> <li> <p> <code>ALLOW_ADMIN_USER_PASSWORD_AUTH</code>: Enable admin based user password authentication flow <code>ADMIN_USER_PASSWORD_AUTH</code>. This setting replaces the <code>ADMIN_NO_SRP_AUTH</code> setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.</p> </li> <li> <p> <code>ALLOW_CUSTOM_AUTH</code>: Enable Lambda trigger based authentication.</p> </li> <li> <p> <code>ALLOW_USER_PASSWORD_AUTH</code>: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.</p> </li> <li> <p> <code>ALLOW_USER_SRP_AUTH</code>: Enable SRP-based authentication.</p> </li> <li> <p> <code>ALLOW_REFRESH_TOKEN_AUTH</code>: Enable authflow to refresh tokens.</p> </li> </ul>"
},
"SupportedIdentityProviders":{
"shape":"SupportedIdentityProvidersListType",
@@ -3876,7 +3875,7 @@
},
"AnalyticsConfiguration":{
"shape":"AnalyticsConfigurationType",
- "documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p> <note> <p>In Amazon Web Services Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region. </p> </note>"
+ "documentation":"<p>The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.</p> <note> <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p> </note>"
},
"PreventUserExistenceErrors":{
"shape":"PreventUserExistenceErrorTypes",
@@ -3987,11 +3986,11 @@
},
"EmailConfiguration":{
"shape":"EmailConfigurationType",
- "documentation":"<p>The email configuration.</p>"
+ "documentation":"<p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.</p>"
},
"SmsConfiguration":{
"shape":"SmsConfigurationType",
- "documentation":"<p>The SMS configuration.</p>"
+ "documentation":"<p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>"
},
"UserPoolTags":{
"shape":"UserPoolTagsType",
@@ -4583,7 +4582,7 @@
"members":{
"SourceArn":{
"shape":"ArnType",
- "documentation":"<p>The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the <code>EmailSendingAccount</code> parameter:</p> <ul> <li> <p>If you specify <code>COGNITO_DEFAULT</code>, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.</p> </li> <li> <p>If you specify <code>DEVELOPER</code>, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.</p> </li> </ul>"
+ "documentation":"<p>The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the <code>EmailSendingAccount</code> parameter:</p> <ul> <li> <p>If you specify <code>COGNITO_DEFAULT</code>, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.</p> </li> <li> <p>If you specify <code>DEVELOPER</code>, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.</p> </li> </ul> <p>The Region value of the <code>SourceArn</code> parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the <code>SourceArn</code> and the user pool Region are the same. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping\">Amazon SES email configuration regions</a> in the <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html\">Amazon Cognito Developer Guide</a>.</p>"
},
"ReplyToEmailAddress":{
"shape":"EmailAddressType",
@@ -4591,7 +4590,7 @@
},
"EmailSendingAccount":{
"shape":"EmailSendingAccountType",
- "documentation":"<p>Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon Simple Email Service email configuration. Specify one of the following values:</p> <dl> <dt>COGNITO_DEFAULT</dt> <dd> <p>When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.</p> <p>To look up the email delivery limit for the default option, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html\">Limits in </a> in the <i> Developer Guide</i>.</p> <p>The default FROM address is <code>no-reply@verificationemail.com</code>. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the <code>SourceArn</code> parameter.</p> <p> If EmailSendingAccount is COGNITO_DEFAULT, you can't use the following parameters:</p> <ul> <li> <p>EmailVerificationMessage</p> </li> <li> <p>EmailVerificationSubject</p> </li> <li> <p>InviteMessageTemplate.EmailMessage</p> </li> <li> <p>InviteMessageTemplate.EmailSubject</p> </li> <li> <p>VerificationMessageTemplate.EmailMessage</p> </li> <li> <p>VerificationMessageTemplate.EmailMessageByLink</p> </li> <li> <p>VerificationMessageTemplate.EmailSubject,</p> </li> <li> <p>VerificationMessageTemplate.EmailSubjectByLink</p> </li> </ul> <note> <p>DEVELOPER EmailSendingAccount is required.</p> </note> </dd> <dt>DEVELOPER</dt> <dd> <p>When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.</p> <p>If you use this option, you must provide the ARN of an Amazon SES verified email address for the <code>SourceArn</code> parameter.</p> <p>Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a <i>service-linked role</i>, which is a type of role, in your Amazon Web Services account. This role contains the permissions that allow to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon Cognito</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </dd> </dl>"
+ "documentation":"<p>Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:</p> <dl> <dt>COGNITO_DEFAULT</dt> <dd> <p>When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.</p> <p>To look up the email delivery limit for the default option, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html\">Limits in </a> in the <i> Developer Guide</i>.</p> <p>The default FROM address is <code>no-reply@verificationemail.com</code>. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the <code>SourceArn</code> parameter.</p> <p> If EmailSendingAccount is COGNITO_DEFAULT, you can't use the following parameters:</p> <ul> <li> <p>EmailVerificationMessage</p> </li> <li> <p>EmailVerificationSubject</p> </li> <li> <p>InviteMessageTemplate.EmailMessage</p> </li> <li> <p>InviteMessageTemplate.EmailSubject</p> </li> <li> <p>VerificationMessageTemplate.EmailMessage</p> </li> <li> <p>VerificationMessageTemplate.EmailMessageByLink</p> </li> <li> <p>VerificationMessageTemplate.EmailSubject,</p> </li> <li> <p>VerificationMessageTemplate.EmailSubjectByLink</p> </li> </ul> <note> <p>DEVELOPER EmailSendingAccount is required.</p> </note> </dd> <dt>DEVELOPER</dt> <dd> <p>When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.</p> <p>If you use this option, you must provide the ARN of an Amazon SES verified email address for the <code>SourceArn</code> parameter.</p> <p>Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a <i>service-linked role</i>, which is a type of role, in your Amazon Web Services account. This role contains the permissions that allow to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon Cognito</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </dd> </dl>"
},
"From":{
"shape":"StringType",
@@ -4599,10 +4598,10 @@
},
"ConfigurationSet":{
"shape":"SESConfigurationSet",
- "documentation":"<p>The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails: </p> <ul> <li> <p>Event publishing – Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch.</p> </li> <li> <p>IP pool management – When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.</p> </li> </ul>"
+ "documentation":"<p>The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails: </p> <dl> <dt>Event publishing</dt> <dd> <p>Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch</p> </dd> <dt>IP pool management</dt> <dd> <p>When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.</p> </dd> </dl>"
}
},
- "documentation":"<p>The email configuration type.</p> <note> <p>Amazon Cognito has specific Regions for use with Amazon Simple Email Service. For more information on the supported Regions, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html\">Email settings for Amazon Cognito user pools</a>.</p> </note>"
+ "documentation":"<p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.</p> <note> <p>Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html\">Email settings for Amazon Cognito user pools</a>.</p> </note>"
},
"EmailNotificationBodyType":{
"type":"string",
@@ -4834,7 +4833,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>user migration</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>user migration</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to reset a user's password.</p>"
@@ -5016,7 +5015,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to get user attribute verification.</p>"
@@ -5275,7 +5274,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p> <ul> <li> <p>Pre signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p> </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:</p> <ul> <li> <p>Pre signup</p> </li> <li> <p>Pre authentication</p> </li> <li> <p>User migration</p> </li> </ul> <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a <code>validationData</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the <code>validationData</code> value to enhance your workflow for your specific needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
},
"ClientId":{
"shape":"ClientIdType",
@@ -5297,7 +5296,7 @@
"members":{
"ChallengeName":{
"shape":"ChallengeNameType",
- "documentation":"<p>The name of the challenge that you're responding to with this call. This name is returned in the <code>AdminInitiateAuth</code> response if you must 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 activated 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 who 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> <li> <p> <code>MFA_SETUP</code>: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters <code>MFA_CAN_SETUP</code> value. </p> <p> To set up software token MFA, use the session returned here from <code>InitiateAuth</code> as an input to <code>AssociateSoftwareToken</code>. Use the session returned by <code>VerifySoftwareToken</code> as an input to <code>RespondToAuthChallenge</code> with challenge name <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call <code>InitiateAuth</code> again to restart sign-in.</p> </li> </ul>"
+ "documentation":"<p>The name of the challenge that you're responding to with this call. This name is returned in the <code>AdminInitiateAuth</code> response if you must pass another challenge.</p> <p>Valid values include the following:</p> <note> <p>All of the following challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable) in the parameters.</p> </note> <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 activated 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 who 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> <li> <p> <code>MFA_SETUP</code>: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters <code>MFA_CAN_SETUP</code> value. </p> <p> To set up software token MFA, use the session returned here from <code>InitiateAuth</code> as an input to <code>AssociateSoftwareToken</code>. Use the session returned by <code>VerifySoftwareToken</code> as an input to <code>RespondToAuthChallenge</code> with challenge name <code>MFA_SETUP</code> to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call <code>InitiateAuth</code> again to restart sign-in.</p> </li> </ul>"
},
"Session":{
"shape":"SessionType",
@@ -5853,7 +5852,7 @@
"documentation":"<p>The attribute name of the MFA option type. The only valid value is <code>phone_number</code>.</p>"
}
},
- "documentation":"<p> <i>This data type is no longer supported.</i> You can use it only for SMS multi-factor authentication (MFA) configurations. You can't use it for time-based one-time password (TOTP) software token MFA configurations.</p>"
+ "documentation":"<p> <i>This data type is no longer supported.</i> Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.</p>"
},
"MessageActionType":{
"type":"string",
@@ -6043,7 +6042,6 @@
"PasswordType":{
"type":"string",
"max":256,
- "min":6,
"pattern":"[\\S]+",
"sensitive":true
},
@@ -6200,6 +6198,11 @@
"max":315360000,
"min":0
},
+ "RegionCodeType":{
+ "type":"string",
+ "max":32,
+ "min":5
+ },
"ResendConfirmationCodeRequest":{
"type":"structure",
"required":[
@@ -6229,7 +6232,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to resend the confirmation code.</p>"
@@ -6360,7 +6363,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>post authentication</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>post authentication</i>, <i>pre token generation</i>, <i>define auth challenge</i>, <i>create auth challenge</i>, and <i>verify auth challenge</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>The request to respond to an authentication challenge.</p>"
@@ -6697,7 +6700,7 @@
},
"MfaConfiguration":{
"shape":"UserPoolMfaType",
- "documentation":"<p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users with an MFA factor set up can sign in. To learn more, see <a href=\"cognito/latest/developerguide/user-pool-settings-mfa.html\">Adding Multi-Factor Authentication (MFA) to a User Pool</a>. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li> </ul>"
+ "documentation":"<p>The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see <a href=\"cognito/latest/developerguide/user-pool-settings-mfa.html\">Adding Multi-Factor Authentication (MFA) to a user pool</a>. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li> </ul>"
}
}
},
@@ -6784,7 +6787,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.</p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: <i>pre sign-up</i>, <i>custom message</i>, and <i>post confirmation</i>. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to register a user.</p>"
@@ -6814,7 +6817,7 @@
"SkippedIPRangeListType":{
"type":"list",
"member":{"shape":"StringType"},
- "max":20
+ "max":200
},
"SmsConfigurationType":{
"type":"structure",
@@ -6826,10 +6829,14 @@
},
"ExternalId":{
"shape":"StringType",
- "documentation":"<p>The external ID is a value that you should use to add security to your IAM role that is used to call Amazon SNS to send SMS messages for your user pool. If you provide an <code>ExternalId</code>, the Amazon Cognito User Pool will include it when attempting to assume your IAM role so that you can set your roles trust policy to require the <code>ExternalID</code>. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito will create a role with the required permissions and a trust policy that demonstrates use of the <code>ExternalId</code>.</p> <p>For more information about the <code>ExternalId</code> of a role, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\">How to use an external ID when granting access to your Amazon Web Services resources to a third party</a> </p>"
+ "documentation":"<p>The external ID provides additional security for your IAM role. You can use an <code>ExternalId</code> with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an <code>ExternalId</code>, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the <code>ExternalID</code>. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the <code>ExternalId</code>.</p> <p>For more information about the <code>ExternalId</code> of a role, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\">How to use an external ID when granting access to your Amazon Web Services resources to a third party</a> </p>"
+ },
+ "SnsRegion":{
+ "shape":"RegionCodeType",
+ "documentation":"<p>The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported <b>Legacy Amazon SNS alternate Region</b>. </p> <p> Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html\">SMS message settings for Amazon Cognito user pools</a>.</p>"
}
},
- "documentation":"<p>The SMS configuration type that includes the settings the Amazon Cognito User Pool must call for the Amazon Simple Notification Service service to send an SMS message from your Amazon Web Services account. The Amazon Cognito User Pool makes the request to the Amazon SNS Service by using an Identity and Access Management role that you provide for your Amazon Web Services account.</p>"
+ "documentation":"<p>The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>"
},
"SmsMfaConfigType":{
"type":"structure",
@@ -6840,7 +6847,7 @@
},
"SmsConfiguration":{
"shape":"SmsConfigurationType",
- "documentation":"<p>The SMS configuration.</p>"
+ "documentation":"<p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.</p>"
}
},
"documentation":"<p>The SMS text message multi-factor authentication (MFA) configuration type.</p>"
@@ -7367,7 +7374,7 @@
},
"ClientMetadata":{
"shape":"ClientMetadataType",
- "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. </p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\">Customizing User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
+ "documentation":"<p>A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates. </p> <p>You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the <i>custom message</i> trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a <code>clientMetadata</code> attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for your specific needs.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html\"> Customizing user pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <note> <p>When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:</p> <ul> <li> <p>Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.</p> </li> <li> <p>Validate the ClientMetadata value.</p> </li> <li> <p>Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.</p> </li> </ul> </note>"
}
},
"documentation":"<p>Represents the request to update user attributes.</p>"
@@ -7459,7 +7466,7 @@
},
"AnalyticsConfiguration":{
"shape":"AnalyticsConfigurationType",
- "documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p> <note> <p>In Amazon Web Services Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In Regions where Pinpoint is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region. </p> </note>"
+ "documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p> <note> <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.</p> </note>"
},
"PreventUserExistenceErrors":{
"shape":"PreventUserExistenceErrorTypes",
@@ -7565,11 +7572,11 @@
},
"EmailConfiguration":{
"shape":"EmailConfigurationType",
- "documentation":"<p>Email configuration.</p>"
+ "documentation":"<p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>"
},
"SmsConfiguration":{
"shape":"SmsConfigurationType",
- "documentation":"<p>SMS configuration.</p>"
+ "documentation":"<p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>"
},
"UserPoolTags":{
"shape":"UserPoolTagsType",
@@ -7874,7 +7881,7 @@
},
"AnalyticsConfiguration":{
"shape":"AnalyticsConfigurationType",
- "documentation":"<p>The Amazon Pinpoint analytics configuration for the user pool client.</p> <note> <p>Amazon Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region in which the user pool resides.</p> </note>"
+ "documentation":"<p>The Amazon Pinpoint analytics configuration for the user pool client.</p> <note> <p>Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.</p> </note>"
},
"PreventUserExistenceErrors":{
"shape":"PreventUserExistenceErrorTypes",
@@ -8049,11 +8056,11 @@
},
"EmailConfiguration":{
"shape":"EmailConfigurationType",
- "documentation":"<p>The email configuration.</p>"
+ "documentation":"<p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.</p>"
},
"SmsConfiguration":{
"shape":"SmsConfigurationType",
- "documentation":"<p>The SMS configuration.</p>"
+ "documentation":"<p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>"
},
"UserPoolTags":{
"shape":"UserPoolTagsType",
@@ -8061,11 +8068,11 @@
},
"SmsConfigurationFailure":{
"shape":"StringType",
- "documentation":"<p>The reason why the SMS configuration can't send the messages to your users.</p> <p>This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.</p> <ul> <li> <p>InvalidSmsRoleAccessPolicyException - The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html\">SmsConfigurationType</a>.</p> </li> <li> <p>SNSSandbox - The Amazon Web Services account is in SNS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html\">Moving out of the SMS sandbox</a>.</p> </li> </ul>"
+ "documentation":"<p>The reason why the SMS configuration can't send the messages to your users.</p> <p>This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.</p> <dl> <dt>InvalidSmsRoleAccessPolicyException</dt> <dd> <p>The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html\">SmsConfigurationType</a>.</p> </dd> <dt>SNSSandbox</dt> <dd> <p>The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html\">Moving out of the SMS sandbox</a>.</p> </dd> </dl>"
},
"EmailConfigurationFailure":{
"shape":"StringType",
- "documentation":"<p>The reason why the email configuration can't send the messages to your users.</p>"
+ "documentation":"<p>Deprecated. Review error codes from API requests with <code>EventSource:cognito-idp.amazonaws.com</code> in CloudTrail for information about problems with user pool email configuration.</p>"
},
"Domain":{
"shape":"DomainType",
@@ -8135,7 +8142,7 @@
},
"UserStatus":{
"shape":"UserStatusType",
- "documentation":"<p>The user status. This can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>COMPROMISED - User is disabled due to a potential security threat.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>"
+ "documentation":"<p>The user status. This can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else. </p> </li> </ul>"
},
"MFAOptions":{
"shape":"MFAOptionListType",
@@ -8161,7 +8168,7 @@
"members":{
"CaseSensitive":{
"shape":"WrappedBooleanType",
- "documentation":"<p>Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.</p> <p>Valid values include:</p> <ul> <li> <p> <b> <code>True</code> </b>: Enables case sensitivity for all username input. When this option is set to <code>True</code>, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.</p> </li> <li> <p> <b> <code>False</code> </b>: Enables case insensitivity for all username input. For example, when this option is set to <code>False</code>, users can sign in using either \"username\" or \"Username\". This option also enables both <code>preferred_username</code> and <code>email</code> alias to be case insensitive, in addition to the <code>username</code> attribute.</p> </li> </ul>"
+ "documentation":"<p>Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.</p> <p>Valid values include:</p> <dl> <dt>True</dt> <dd> <p>Enables case sensitivity for all username input. When this option is set to <code>True</code>, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.</p> </dd> <dt>False</dt> <dd> <p>Enables case insensitivity for all username input. For example, when this option is set to <code>False</code>, users can sign in using either \"username\" or \"Username\". This option also enables both <code>preferred_username</code> and <code>email</code> alias to be case insensitive, in addition to the <code>username</code> attribute.</p> </dd> </dl>"
}
},
"documentation":"<p>The username configuration type. </p>"
diff --git a/contrib/python/botocore/py3/botocore/data/comprehend/2017-11-27/service-2.json b/contrib/python/botocore/py3/botocore/data/comprehend/2017-11-27/service-2.json
index 31fc4d479e..5f57959deb 100644
--- a/contrib/python/botocore/py3/botocore/data/comprehend/2017-11-27/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/comprehend/2017-11-27/service-2.json
@@ -432,6 +432,22 @@
],
"documentation":"<p>Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.</p>"
},
+ "DescribeTargetedSentimentDetectionJob":{
+ "name":"DescribeTargetedSentimentDetectionJob",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"DescribeTargetedSentimentDetectionJobRequest"},
+ "output":{"shape":"DescribeTargetedSentimentDetectionJobResponse"},
+ "errors":[
+ {"shape":"InvalidRequestException"},
+ {"shape":"JobNotFoundException"},
+ {"shape":"TooManyRequestsException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.</p>"
+ },
"DescribeTopicsDetectionJob":{
"name":"DescribeTopicsDetectionJob",
"http":{
@@ -769,6 +785,22 @@
],
"documentation":"<p>Lists all tags associated with a given Amazon Comprehend resource. </p>"
},
+ "ListTargetedSentimentDetectionJobs":{
+ "name":"ListTargetedSentimentDetectionJobs",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListTargetedSentimentDetectionJobsRequest"},
+ "output":{"shape":"ListTargetedSentimentDetectionJobsResponse"},
+ "errors":[
+ {"shape":"InvalidRequestException"},
+ {"shape":"TooManyRequestsException"},
+ {"shape":"InvalidFilterException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a list of targeted sentiment detection jobs that you have submitted.</p>"
+ },
"ListTopicsDetectionJobs":{
"name":"ListTopicsDetectionJobs",
"http":{
@@ -921,7 +953,24 @@
{"shape":"TooManyTagsException"},
{"shape":"InternalServerException"}
],
- "documentation":"<p>Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.</p>"
+ "documentation":"<p>Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.</p>"
+ },
+ "StartTargetedSentimentDetectionJob":{
+ "name":"StartTargetedSentimentDetectionJob",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"StartTargetedSentimentDetectionJobRequest"},
+ "output":{"shape":"StartTargetedSentimentDetectionJobResponse"},
+ "errors":[
+ {"shape":"InvalidRequestException"},
+ {"shape":"TooManyRequestsException"},
+ {"shape":"KmsKeyValidationException"},
+ {"shape":"TooManyTagsException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.</p>"
},
"StartTopicsDetectionJob":{
"name":"StartTopicsDetectionJob",
@@ -1030,6 +1079,21 @@
],
"documentation":"<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
},
+ "StopTargetedSentimentDetectionJob":{
+ "name":"StopTargetedSentimentDetectionJob",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"StopTargetedSentimentDetectionJobRequest"},
+ "output":{"shape":"StopTargetedSentimentDetectionJobResponse"},
+ "errors":[
+ {"shape":"InvalidRequestException"},
+ {"shape":"JobNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Stops a targeted sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
+ },
"StopTrainingDocumentClassifier":{
"name":"StopTrainingDocumentClassifier",
"http":{
@@ -2072,6 +2136,25 @@
}
}
},
+ "DescribeTargetedSentimentDetectionJobRequest":{
+ "type":"structure",
+ "required":["JobId"],
+ "members":{
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</p>"
+ }
+ }
+ },
+ "DescribeTargetedSentimentDetectionJobResponse":{
+ "type":"structure",
+ "members":{
+ "TargetedSentimentDetectionJobProperties":{
+ "shape":"TargetedSentimentDetectionJobProperties",
+ "documentation":"<p>An object that contains the properties associated with a targeted sentiment detection job.</p>"
+ }
+ }
+ },
"DescribeTopicsDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
@@ -2993,7 +3076,7 @@
},
"F1Score":{
"shape":"Double",
- "documentation":"<p>A measure of how accurate the recognizer results are for the test data. It is derived from the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. </p>"
+ "documentation":"<p>A measure of how accurate the recognizer results are for the test data. It is derived from the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score. </p>"
}
},
"documentation":"<p>Detailed information about the accuracy of an entity recognizer. </p>"
@@ -3580,7 +3663,7 @@
"KmsKeyId":{
"type":"string",
"max":2048,
- "pattern":".*"
+ "pattern":"^\\p{ASCII}+$"
},
"KmsKeyValidationException":{
"type":"structure",
@@ -4050,6 +4133,36 @@
}
}
},
+ "ListTargetedSentimentDetectionJobsRequest":{
+ "type":"structure",
+ "members":{
+ "Filter":{
+ "shape":"TargetedSentimentDetectionJobFilter",
+ "documentation":"<p>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
+ },
+ "NextToken":{
+ "shape":"String",
+ "documentation":"<p>Identifies the next page of results to return.</p>"
+ },
+ "MaxResults":{
+ "shape":"MaxResultsInteger",
+ "documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
+ }
+ }
+ },
+ "ListTargetedSentimentDetectionJobsResponse":{
+ "type":"structure",
+ "members":{
+ "TargetedSentimentDetectionJobPropertiesList":{
+ "shape":"TargetedSentimentDetectionJobPropertiesList",
+ "documentation":"<p>A list containing the properties of each job that is returned.</p>"
+ },
+ "NextToken":{
+ "shape":"String",
+ "documentation":"<p>Identifies the next page of results to return.</p>"
+ }
+ }
+ },
"ListTopicsDetectionJobsRequest":{
"type":"structure",
"members":{
@@ -4114,14 +4227,14 @@
"members":{
"S3Uri":{
"shape":"S3Uri",
- "documentation":"<p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.</p> <p>When the topic detection job is finished, the service creates an output file in a directory specific to the job. The <code>S3Uri</code> field contains the location of the output file, called <code>output.tar.gz</code>. It is a compressed archive that contains the ouput of the operation.</p>"
+ "documentation":"<p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.</p> <p>When the topic detection job is finished, the service creates an output file in a directory specific to the job. The <code>S3Uri</code> field contains the location of the output file, called <code>output.tar.gz</code>. It is a compressed archive that contains the ouput of the operation.</p> <p> For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with <code>.out</code> appended at the end. </p>"
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:</p> <ul> <li> <p>KMS Key ID: <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>KMS Key Alias: <code>\"alias/ExampleAlias\"</code> </p> </li> <li> <p>ARN of a KMS Key Alias: <code>\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"</code> </p> </li> </ul>"
}
},
- "documentation":"<p>Provides configuration parameters for the output of topic detection jobs.</p> <p/>"
+ "documentation":"<p>Provides configuration parameters for the output of inference jobs.</p> <p/>"
},
"PartOfSpeechTag":{
"type":"structure",
@@ -4314,7 +4427,7 @@
"members":{
"S3Uri":{
"shape":"S3Uri",
- "documentation":"<p>When you use the <code>PiiOutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. </p>"
+ "documentation":"<p>When you use the <code>PiiOutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. </p> <p> For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with <code>.out</code> appended at the end. </p>"
},
"KmsKeyId":{
"shape":"KmsKeyId",
@@ -5005,6 +5118,65 @@
}
}
},
+ "StartTargetedSentimentDetectionJobRequest":{
+ "type":"structure",
+ "required":[
+ "InputDataConfig",
+ "OutputDataConfig",
+ "DataAccessRoleArn",
+ "LanguageCode"
+ ],
+ "members":{
+ "InputDataConfig":{"shape":"InputDataConfig"},
+ "OutputDataConfig":{
+ "shape":"OutputDataConfig",
+ "documentation":"<p>Specifies where to send the output files. </p>"
+ },
+ "DataAccessRoleArn":{
+ "shape":"IamRoleArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">Role-based permissions</a>.</p>"
+ },
+ "JobName":{
+ "shape":"JobName",
+ "documentation":"<p>The identifier of the job.</p>"
+ },
+ "LanguageCode":{
+ "shape":"LanguageCode",
+ "documentation":"<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p>"
+ },
+ "ClientRequestToken":{
+ "shape":"ClientRequestTokenString",
+ "documentation":"<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>",
+ "idempotencyToken":true
+ },
+ "VolumeKmsKeyId":{
+ "shape":"KmsKeyId",
+ "documentation":"<p>ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</p> <ul> <li> <p>KMS Key ID: <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> </ul>"
+ },
+ "VpcConfig":{"shape":"VpcConfig"},
+ "Tags":{
+ "shape":"TagList",
+ "documentation":"<p>Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.</p>"
+ }
+ }
+ },
+ "StartTargetedSentimentDetectionJobResponse":{
+ "type":"structure",
+ "members":{
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The identifier generated for the job. To get the status of a job, use this identifier with the operation.</p>"
+ },
+ "JobArn":{
+ "shape":"ComprehendArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:</p> <p> <code>arn:&lt;partition&gt;:comprehend:&lt;region&gt;:&lt;account-id&gt;:targeted-sentiment-detection-job/&lt;job-id&gt;</code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>"
+ },
+ "JobStatus":{
+ "shape":"JobStatus",
+ "documentation":"<p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the operation.</p> </li> </ul>"
+ }
+ }
+ },
"StartTopicsDetectionJobRequest":{
"type":"structure",
"required":[
@@ -5207,6 +5379,29 @@
}
}
},
+ "StopTargetedSentimentDetectionJobRequest":{
+ "type":"structure",
+ "required":["JobId"],
+ "members":{
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The identifier of the targeted sentiment detection job to stop.</p>"
+ }
+ }
+ },
+ "StopTargetedSentimentDetectionJobResponse":{
+ "type":"structure",
+ "members":{
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The identifier of the targeted sentiment detection job to stop.</p>"
+ },
+ "JobStatus":{
+ "shape":"JobStatus",
+ "documentation":"<p>Either <code>STOP_REQUESTED</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopSentimentDetectionJob</code> operation.</p>"
+ }
+ }
+ },
"StopTrainingDocumentClassifierRequest":{
"type":"structure",
"required":["DocumentClassifierArn"],
@@ -5350,6 +5545,81 @@
"member":{"shape":"EventTypeString"},
"min":1
},
+ "TargetedSentimentDetectionJobFilter":{
+ "type":"structure",
+ "members":{
+ "JobName":{
+ "shape":"JobName",
+ "documentation":"<p>Filters on the name of the job.</p>"
+ },
+ "JobStatus":{
+ "shape":"JobStatus",
+ "documentation":"<p>Filters the list of jobs based on job status. Returns only jobs with the specified status.</p>"
+ },
+ "SubmitTimeBefore":{
+ "shape":"Timestamp",
+ "documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
+ },
+ "SubmitTimeAfter":{
+ "shape":"Timestamp",
+ "documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
+ }
+ },
+ "documentation":"<p>Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.</p>"
+ },
+ "TargetedSentimentDetectionJobProperties":{
+ "type":"structure",
+ "members":{
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The identifier assigned to the targeted sentiment detection job.</p>"
+ },
+ "JobArn":{
+ "shape":"ComprehendArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:</p> <p> <code>arn:&lt;partition&gt;:comprehend:&lt;region&gt;:&lt;account-id&gt;:targeted-sentiment-detection-job/&lt;job-id&gt;</code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>"
+ },
+ "JobName":{
+ "shape":"JobName",
+ "documentation":"<p>The name that you assigned to the targeted sentiment detection job.</p>"
+ },
+ "JobStatus":{
+ "shape":"JobStatus",
+ "documentation":"<p>The current status of the targeted sentiment detection job. If the status is <code>FAILED</code>, the <code>Messages</code> field shows the reason for the failure.</p>"
+ },
+ "Message":{
+ "shape":"AnyLengthString",
+ "documentation":"<p>A description of the status of a job.</p>"
+ },
+ "SubmitTime":{
+ "shape":"Timestamp",
+ "documentation":"<p>The time that the targeted sentiment detection job was submitted for processing.</p>"
+ },
+ "EndTime":{
+ "shape":"Timestamp",
+ "documentation":"<p>The time that the targeted sentiment detection job ended.</p>"
+ },
+ "InputDataConfig":{"shape":"InputDataConfig"},
+ "OutputDataConfig":{"shape":"OutputDataConfig"},
+ "LanguageCode":{
+ "shape":"LanguageCode",
+ "documentation":"<p>The language code of the input documents.</p>"
+ },
+ "DataAccessRoleArn":{
+ "shape":"IamRoleArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.</p>"
+ },
+ "VolumeKmsKeyId":{
+ "shape":"KmsKeyId",
+ "documentation":"<p>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:</p> <ul> <li> <p>KMS Key ID: <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> </ul>"
+ },
+ "VpcConfig":{"shape":"VpcConfig"}
+ },
+ "documentation":"<p>Provides information about a targeted sentiment detection job.</p>"
+ },
+ "TargetedSentimentDetectionJobPropertiesList":{
+ "type":"list",
+ "member":{"shape":"TargetedSentimentDetectionJobProperties"}
+ },
"TextSizeLimitExceededException":{
"type":"structure",
"members":{
diff --git a/contrib/python/botocore/py3/botocore/data/config/2014-11-12/service-2.json b/contrib/python/botocore/py3/botocore/data/config/2014-11-12/service-2.json
index b00ee55490..92e2fe9527 100644
--- a/contrib/python/botocore/py3/botocore/data/config/2014-11-12/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/config/2014-11-12/service-2.json
@@ -142,7 +142,7 @@
{"shape":"ResourceInUseException"},
{"shape":"OrganizationAccessDeniedException"}
],
- "documentation":"<p>Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization. </p> <p>Only a master account and a delegated administrator account can delete an organization config rule. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added.</p> <p>Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.</p>"
+ "documentation":"<p>Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization. </p> <p>Only a master account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added.</p> <p>Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.</p>"
},
"DeleteOrganizationConformancePack":{
"name":"DeleteOrganizationConformancePack",
@@ -156,7 +156,7 @@
{"shape":"ResourceInUseException"},
{"shape":"OrganizationAccessDeniedException"}
],
- "documentation":"<p>Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization. </p> <p> Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added.</p> <p>Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state. </p>"
+ "documentation":"<p>Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization. </p> <p> Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added.</p> <p>Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state. </p>"
},
"DeletePendingAggregationRequest":{
"name":"DeletePendingAggregationRequest",
@@ -505,7 +505,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"OrganizationAccessDeniedException"}
],
- "documentation":"<p>Provides organization config rule deployment status for an organization.</p> <note> <p>The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.</p> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.</p> </note>"
+ "documentation":"<p>Provides organization Config rule deployment status for an organization.</p> <note> <p>The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.</p> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.</p> </note>"
},
"DescribeOrganizationConfigRules":{
"name":"DescribeOrganizationConfigRules",
@@ -521,7 +521,7 @@
{"shape":"InvalidLimitException"},
{"shape":"OrganizationAccessDeniedException"}
],
- "documentation":"<p>Returns a list of organization config rules. </p> <note> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.</p> </note>"
+ "documentation":"<p>Returns a list of organization Config rules. </p> <note> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.</p> </note>"
},
"DescribeOrganizationConformancePackStatuses":{
"name":"DescribeOrganizationConformancePackStatuses",
@@ -786,6 +786,19 @@
],
"documentation":"<p>Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.</p>"
},
+ "GetCustomRulePolicy":{
+ "name":"GetCustomRulePolicy",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetCustomRulePolicyRequest"},
+ "output":{"shape":"GetCustomRulePolicyResponse"},
+ "errors":[
+ {"shape":"NoSuchConfigRuleException"}
+ ],
+ "documentation":"<p>Returns the policy definition containing the logic for your Config Custom Policy rule.</p>"
+ },
"GetDiscoveredResourceCounts":{
"name":"GetDiscoveredResourceCounts",
"http":{
@@ -815,7 +828,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"OrganizationAccessDeniedException"}
],
- "documentation":"<p>Returns detailed status for each member account within an organization for a given organization config rule.</p>"
+ "documentation":"<p>Returns detailed status for each member account within an organization for a given organization Config rule.</p>"
},
"GetOrganizationConformancePackDetailedStatus":{
"name":"GetOrganizationConformancePackDetailedStatus",
@@ -833,6 +846,20 @@
],
"documentation":"<p>Returns detailed status for each member account within an organization for a given organization conformance pack.</p>"
},
+ "GetOrganizationCustomRulePolicy":{
+ "name":"GetOrganizationCustomRulePolicy",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetOrganizationCustomRulePolicyRequest"},
+ "output":{"shape":"GetOrganizationCustomRulePolicyResponse"},
+ "errors":[
+ {"shape":"NoSuchOrganizationConfigRuleException"},
+ {"shape":"OrganizationAccessDeniedException"}
+ ],
+ "documentation":"<p>Returns the policy definition containing the logic for your organization Config Custom Policy rule.</p>"
+ },
"GetResourceConfigHistory":{
"name":"GetResourceConfigHistory",
"http":{
@@ -972,7 +999,7 @@
{"shape":"NoAvailableOrganizationException"},
{"shape":"OrganizationAllFeaturesNotEnabledException"}
],
- "documentation":"<p>Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.</p> <p> <code>accountIds</code> that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call <code>DescribeAggregator</code> to get the previous accounts and then append new ones.</p> <note> <p>Config should be enabled in source accounts and regions you want to aggregate.</p> <p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p> <p>To register a delegated administrator, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli\">Register a Delegated Administrator</a> in the Config developer guide. </p> </note>"
+ "documentation":"<p>Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.</p> <p> <code>accountIds</code> that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call <code>DescribeConfigurationAggregators</code> to get the previous accounts and then append new ones.</p> <note> <p>Config should be enabled in source accounts and regions you want to aggregate.</p> <p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p> <p>To register a delegated administrator, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli\">Register a Delegated Administrator</a> in the Config developer guide. </p> </note>"
},
"PutConfigurationRecorder":{
"name":"PutConfigurationRecorder",
@@ -1072,7 +1099,7 @@
{"shape":"OrganizationAllFeaturesNotEnabledException"},
{"shape":"InsufficientPermissionsException"}
],
- "documentation":"<p>Adds or updates organization config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.</p> <p> Only a master account and a delegated administrator can create or update an organization config rule. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added. </p> <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with <code>GetRole</code> action.</p> <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>You can use this action to create both custom Config rules and Config managed rules. If you are adding a new custom Config rule, you must first create Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function. When you use the <code>PutOrganizationConfigRule</code> action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. If you are adding an Config managed rule, specify the rule's identifier for the <code>RuleIdentifier</code> key.</p> <p>The maximum number of organization config rules that Config supports is 150 and 3 delegated administrator per organization. </p> <note> <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p> <p>Specify either <code>OrganizationCustomRuleMetadata</code> or <code>OrganizationManagedRuleMetadata</code>.</p> </note>"
+ "documentation":"<p>Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.</p> <p> Only a master account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations <code>ListDelegatedAdministrator</code> permissions are added. </p> <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with <code>GetRole</code> action.</p> <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>You can use this action to create both custom Config rules and Config managed rules. If you are adding a new custom Config rule, you must first create Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function. When you use the <code>PutOrganizationConfigRule</code> action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. If you are adding an Config managed rule, specify the rule's identifier for the <code>RuleIdentifier</code> key.</p> <p>The maximum number of organization Config rules that Config supports is 150 and 3 delegated administrator per organization. </p> <note> <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p> <p>Specify either <code>OrganizationCustomRuleMetadata</code> or <code>OrganizationManagedRuleMetadata</code>.</p> </note>"
},
"PutOrganizationConformancePack":{
"name":"PutOrganizationConformancePack",
@@ -2103,10 +2130,22 @@
},
"FirstEvaluationStarted":{
"shape":"Boolean",
- "documentation":"<p>Indicates whether Config has evaluated your resources against the rule at least once.</p> <ul> <li> <p> <code>true</code> - Config has evaluated your Amazon Web Services resources against the rule at least once.</p> </li> <li> <p> <code>false</code> - Config has not once finished evaluating your Amazon Web Services resources against the rule.</p> </li> </ul>"
+ "documentation":"<p>Indicates whether Config has evaluated your resources against the rule at least once.</p> <ul> <li> <p> <code>true</code> - Config has evaluated your Amazon Web Services resources against the rule at least once.</p> </li> <li> <p> <code>false</code> - Config has not finished evaluating your Amazon Web Services resources against the rule at least once.</p> </li> </ul>"
+ },
+ "LastDebugLogDeliveryStatus":{
+ "shape":"String",
+ "documentation":"<p>The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either <code>Successful</code> or <code>Failed</code>.</p>"
+ },
+ "LastDebugLogDeliveryStatusReason":{
+ "shape":"String",
+ "documentation":"<p>The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.</p>"
+ },
+ "LastDebugLogDeliveryTime":{
+ "shape":"Date",
+ "documentation":"<p>The time Config last attempted to deliver a debug log for your Config Custom Policy rules.</p>"
}
},
- "documentation":"<p>Status information for your Config managed rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.</p> <p>This action does not return status information about custom Config rules.</p>"
+ "documentation":"<p>Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.</p> <p>This action does not return status information about Config Custom Lambda rules.</p>"
},
"ConfigRuleEvaluationStatusList":{
"type":"list",
@@ -2602,7 +2641,7 @@
"members":{
"ConfigRuleName":{
"shape":"ConfigRuleName",
- "documentation":"<p>Name of the config rule.</p>"
+ "documentation":"<p>Name of the Config rule.</p>"
},
"ComplianceType":{
"shape":"ConformancePackComplianceType",
@@ -2712,7 +2751,35 @@
"max":100,
"min":0
},
+ "CustomPolicyDetails":{
+ "type":"structure",
+ "required":[
+ "PolicyRuntime",
+ "PolicyText"
+ ],
+ "members":{
+ "PolicyRuntime":{
+ "shape":"PolicyRuntime",
+ "documentation":"<p>The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the <a href=\"https://github.com/aws-cloudformation/cloudformation-guard\">Guard GitHub Repository</a>.</p>"
+ },
+ "PolicyText":{
+ "shape":"PolicyText",
+ "documentation":"<p>The policy definition containing the logic for your Config Custom Policy rule.</p>"
+ },
+ "EnableDebugLogDelivery":{
+ "shape":"Boolean",
+ "documentation":"<p>The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is <code>false</code>.</p>"
+ }
+ },
+ "documentation":"<p>Provides the runtime system, policy definition, and whether debug logging enabled. You can specify the following CustomPolicyDetails parameter values only for Config Custom Policy rules.</p>"
+ },
"Date":{"type":"timestamp"},
+ "DebugLogDeliveryAccounts":{
+ "type":"list",
+ "member":{"shape":"AccountId"},
+ "max":1000,
+ "min":0
+ },
"DeleteAggregationAuthorizationRequest":{
"type":"structure",
"required":[
@@ -2806,7 +2873,7 @@
"members":{
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
- "documentation":"<p>The name of organization config rule that you want to delete.</p>"
+ "documentation":"<p>The name of organization Config rule that you want to delete.</p>"
}
}
},
@@ -3513,7 +3580,7 @@
"members":{
"OrganizationConfigRuleNames":{
"shape":"OrganizationConfigRuleNames",
- "documentation":"<p>The names of organization config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.</p>"
+ "documentation":"<p>The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.</p>"
},
"Limit":{
"shape":"CosmosPageLimit",
@@ -3543,11 +3610,11 @@
"members":{
"OrganizationConfigRuleNames":{
"shape":"OrganizationConfigRuleNames",
- "documentation":"<p>The names of organization config rules for which you want details. If you do not specify any names, Config returns details for all your organization config rules.</p>"
+ "documentation":"<p>The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.</p>"
},
"Limit":{
"shape":"CosmosPageLimit",
- "documentation":"<p>The maximum number of organization config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.</p>"
+ "documentation":"<p>The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.</p>"
},
"NextToken":{
"shape":"String",
@@ -4410,6 +4477,24 @@
}
}
},
+ "GetCustomRulePolicyRequest":{
+ "type":"structure",
+ "members":{
+ "ConfigRuleName":{
+ "shape":"ConfigRuleName",
+ "documentation":"<p>The name of your Config Custom Policy rule.</p>"
+ }
+ }
+ },
+ "GetCustomRulePolicyResponse":{
+ "type":"structure",
+ "members":{
+ "PolicyText":{
+ "shape":"PolicyText",
+ "documentation":"<p>The policy definition containing the logic for your Config Custom Policy rule.</p>"
+ }
+ }
+ },
"GetDiscoveredResourceCountsRequest":{
"type":"structure",
"members":{
@@ -4450,7 +4535,7 @@
"members":{
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
- "documentation":"<p>The name of organization config rule for which you want status details for member accounts.</p>"
+ "documentation":"<p>The name of your organization Config rule for which you want status details for member accounts.</p>"
},
"Filters":{
"shape":"StatusDetailFilters",
@@ -4514,6 +4599,25 @@
}
}
},
+ "GetOrganizationCustomRulePolicyRequest":{
+ "type":"structure",
+ "required":["OrganizationConfigRuleName"],
+ "members":{
+ "OrganizationConfigRuleName":{
+ "shape":"OrganizationConfigRuleName",
+ "documentation":"<p>The name of your organization Config Custom Policy rule. </p>"
+ }
+ }
+ },
+ "GetOrganizationCustomRulePolicyResponse":{
+ "type":"structure",
+ "members":{
+ "PolicyText":{
+ "shape":"PolicyText",
+ "documentation":"<p>The policy definition containing the logic for your organization Config Custom Policy rule.</p>"
+ }
+ }
+ },
"GetResourceConfigHistoryRequest":{
"type":"structure",
"required":[
@@ -4624,7 +4728,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>Indicates one of the following errors:</p> <ul> <li> <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.</p> </li> <li> <p>For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</p> </li> <li> <p>For PutOrganizationConfigRule, organization config rule cannot be created because you do not have permissions to call IAM <code>GetRole</code> action or create a service linked role.</p> </li> <li> <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions: </p> <ul> <li> <p>To call IAM <code>GetRole</code> action or create a service linked role.</p> </li> <li> <p>To read Amazon S3 bucket.</p> </li> </ul> </li> </ul>",
+ "documentation":"<p>Indicates one of the following errors:</p> <ul> <li> <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.</p> </li> <li> <p>For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</p> </li> <li> <p>For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM <code>GetRole</code> action or create a service linked role.</p> </li> <li> <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions: </p> <ul> <li> <p>To call IAM <code>GetRole</code> action or create a service linked role.</p> </li> <li> <p>To read Amazon S3 bucket.</p> </li> </ul> </li> </ul>",
"exception":true
},
"Integer":{"type":"integer"},
@@ -4925,7 +5029,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>You have reached the limit of the number of organization config rules you can create.</p>",
+ "documentation":"<p>You have reached the limit of the number of organization Config rules you can create.</p>",
"exception":true
},
"MaxNumberOfOrganizationConformancePacksExceededException":{
@@ -4980,26 +5084,26 @@
},
"ConfigRuleName":{
"shape":"StringWithCharLimit64",
- "documentation":"<p>The name of config rule deployed in the member account.</p>"
+ "documentation":"<p>The name of Config rule deployed in the member account.</p>"
},
"MemberAccountRuleStatus":{
"shape":"MemberAccountRuleStatus",
- "documentation":"<p>Indicates deployment status for config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p> Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when config rule has been created in the member account. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when config rule is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when config rule creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when config rule is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when config rule has been deleted in the member account. </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when config rule has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when config rule is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> </ul>"
+ "documentation":"<p>Indicates deployment status for Config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, Config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p> Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when Config rule has been created in the member account. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when Config rule is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when Config rule creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when Config rule deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when Config rule is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when Config rule has been deleted in the member account. </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when Config rule has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when Config rule is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when Config rule deletion has failed in the member account.</p> </li> </ul>"
},
"ErrorCode":{
"shape":"String",
- "documentation":"<p>An error code that is returned when config rule creation or deletion failed in the member account.</p>"
+ "documentation":"<p>An error code that is returned when Config rule creation or deletion failed in the member account.</p>"
},
"ErrorMessage":{
"shape":"String",
- "documentation":"<p>An error message indicating that config rule account creation or deletion has failed due to an error in the member account.</p>"
+ "documentation":"<p>An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.</p>"
},
"LastUpdateTime":{
"shape":"Date",
"documentation":"<p>The timestamp of the last status update.</p>"
}
},
- "documentation":"<p>Organization config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.</p>"
+ "documentation":"<p>Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.</p>"
},
"MessageType":{
"type":"string",
@@ -5051,7 +5155,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>One or more Config rules in the request are invalid. Verify that the rule names are correct and try again.</p>",
+ "documentation":"<p>The Config rule in the request is not valid. Verify that the rule is an Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.</p>",
"exception":true
},
"NoSuchConfigRuleInConformancePackException":{
@@ -5093,7 +5197,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>You specified one or more organization config rules that do not exist.</p>",
+ "documentation":"<p>The Config rule in the request is not valid. Verify that the rule is an organization Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.</p>",
"exception":true
},
"NoSuchOrganizationConformancePackException":{
@@ -5167,11 +5271,11 @@
"members":{
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
- "documentation":"<p>The name that you assign to organization config rule.</p>"
+ "documentation":"<p>The name that you assign to organization Config rule.</p>"
},
"OrganizationConfigRuleArn":{
"shape":"StringWithCharLimit256",
- "documentation":"<p>Amazon Resource Name (ARN) of organization config rule.</p>"
+ "documentation":"<p>Amazon Resource Name (ARN) of organization Config rule.</p>"
},
"OrganizationManagedRuleMetadata":{
"shape":"OrganizationManagedRuleMetadata",
@@ -5183,14 +5287,18 @@
},
"ExcludedAccounts":{
"shape":"ExcludedAccounts",
- "documentation":"<p>A comma-separated list of accounts excluded from organization config rule.</p>"
+ "documentation":"<p>A comma-separated list of accounts excluded from organization Config rule.</p>"
},
"LastUpdateTime":{
"shape":"Date",
"documentation":"<p>The timestamp of the last update.</p>"
+ },
+ "OrganizationCustomPolicyRuleMetadata":{
+ "shape":"OrganizationCustomPolicyRuleMetadataNoPolicy",
+ "documentation":"<p>An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.</p>"
}
},
- "documentation":"<p>An organization config rule that has information about config rules that Config creates in member accounts.</p>"
+ "documentation":"<p>An organization Config rule that has information about Config rules that Config creates in member accounts.</p>"
},
"OrganizationConfigRuleDetailedStatus":{
"type":"list",
@@ -5217,26 +5325,26 @@
"members":{
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
- "documentation":"<p>The name that you assign to organization config rule.</p>"
+ "documentation":"<p>The name that you assign to organization Config rule.</p>"
},
"OrganizationRuleStatus":{
"shape":"OrganizationRuleStatus",
- "documentation":"<p>Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in all the member accounts. Additionally, config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>.</p> <p>Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when an organization config rule has been successfully created in all the member accounts. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when an organization config rule creation is in progress.</p> </li> <li> <p> <code>CREATE_FAILED</code> when an organization config rule creation failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_FAILED</code> when an organization config rule deletion failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when an organization config rule deletion is in progress.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when an organization config rule has been successfully deleted from all the member accounts.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when an organization config rule has been successfully updated in all the member accounts.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when an organization config rule update is in progress.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when an organization config rule update failed in one or more member accounts within that organization.</p> </li> </ul>"
+ "documentation":"<p>Indicates deployment status of an organization Config rule. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>.</p> <p>Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when an organization Config rule has been successfully created in all the member accounts. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when an organization Config rule creation is in progress.</p> </li> <li> <p> <code>CREATE_FAILED</code> when an organization Config rule creation failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_FAILED</code> when an organization Config rule deletion failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when an organization Config rule deletion is in progress.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when an organization Config rule has been successfully deleted from all the member accounts.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when an organization Config rule has been successfully updated in all the member accounts.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when an organization Config rule update is in progress.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when an organization Config rule update failed in one or more member accounts within that organization.</p> </li> </ul>"
},
"ErrorCode":{
"shape":"String",
- "documentation":"<p>An error code that is returned when organization config rule creation or deletion has failed.</p>"
+ "documentation":"<p>An error code that is returned when organization Config rule creation or deletion has failed.</p>"
},
"ErrorMessage":{
"shape":"String",
- "documentation":"<p>An error message indicating that organization config rule creation or deletion failed due to an error.</p>"
+ "documentation":"<p>An error message indicating that organization Config rule creation or deletion failed due to an error.</p>"
},
"LastUpdateTime":{
"shape":"Date",
"documentation":"<p>The timestamp of the last update.</p>"
}
},
- "documentation":"<p>Returns the status for an organization config rule in an organization.</p>"
+ "documentation":"<p>Returns the status for an organization Config rule in an organization.</p>"
},
"OrganizationConfigRuleStatuses":{
"type":"list",
@@ -5250,6 +5358,17 @@
"ScheduledNotification"
]
},
+ "OrganizationConfigRuleTriggerTypeNoSN":{
+ "type":"string",
+ "enum":[
+ "ConfigurationItemChangeNotification",
+ "OversizedConfigurationItemChangeNotification"
+ ]
+ },
+ "OrganizationConfigRuleTriggerTypeNoSNs":{
+ "type":"list",
+ "member":{"shape":"OrganizationConfigRuleTriggerTypeNoSN"}
+ },
"OrganizationConfigRuleTriggerTypes":{
"type":"list",
"member":{"shape":"OrganizationConfigRuleTriggerType"}
@@ -5393,6 +5512,106 @@
"type":"list",
"member":{"shape":"OrganizationConformancePack"}
},
+ "OrganizationCustomPolicyRuleMetadata":{
+ "type":"structure",
+ "required":[
+ "PolicyRuntime",
+ "PolicyText"
+ ],
+ "members":{
+ "Description":{
+ "shape":"StringWithCharLimit256Min0",
+ "documentation":"<p>The description that you provide for your organization Config Custom Policy rule.</p>"
+ },
+ "OrganizationConfigRuleTriggerTypes":{
+ "shape":"OrganizationConfigRuleTriggerTypeNoSNs",
+ "documentation":"<p>The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:</p> <ul> <li> <p> <code>ConfigurationItemChangeNotification</code> - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.</p> </li> <li> <p> <code>OversizedConfigurationItemChangeNotification</code> - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.</p> </li> </ul>"
+ },
+ "InputParameters":{
+ "shape":"StringWithCharLimit2048",
+ "documentation":"<p>A string, in JSON format, that is passed to your organization Config Custom Policy rule.</p>"
+ },
+ "MaximumExecutionFrequency":{
+ "shape":"MaximumExecutionFrequency",
+ "documentation":"<p>The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>"
+ },
+ "ResourceTypesScope":{
+ "shape":"ResourceTypesScope",
+ "documentation":"<p>The type of the Amazon Web Services resource that was evaluated.</p>"
+ },
+ "ResourceIdScope":{
+ "shape":"StringWithCharLimit768",
+ "documentation":"<p>The ID of the Amazon Web Services resource that was evaluated.</p>"
+ },
+ "TagKeyScope":{
+ "shape":"StringWithCharLimit128",
+ "documentation":"<p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.</p>"
+ },
+ "TagValueScope":{
+ "shape":"StringWithCharLimit256",
+ "documentation":"<p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>"
+ },
+ "PolicyRuntime":{
+ "shape":"PolicyRuntime",
+ "documentation":"<p>The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the <a href=\"https://github.com/aws-cloudformation/cloudformation-guard\">Guard GitHub Repository</a>.</p>"
+ },
+ "PolicyText":{
+ "shape":"PolicyText",
+ "documentation":"<p>The policy definition containing the logic for your organization Config Custom Policy rule.</p>"
+ },
+ "DebugLogDeliveryAccounts":{
+ "shape":"DebugLogDeliveryAccounts",
+ "documentation":"<p>A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.</p>"
+ }
+ },
+ "documentation":"<p>An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.</p>"
+ },
+ "OrganizationCustomPolicyRuleMetadataNoPolicy":{
+ "type":"structure",
+ "members":{
+ "Description":{
+ "shape":"StringWithCharLimit256Min0",
+ "documentation":"<p>The description that you provide for your organization Config Custom Policy rule.</p>"
+ },
+ "OrganizationConfigRuleTriggerTypes":{
+ "shape":"OrganizationConfigRuleTriggerTypeNoSNs",
+ "documentation":"<p>The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:</p> <ul> <li> <p> <code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.</p> </li> <li> <p> <code>OversizedConfigurationItemChangeNotification</code> - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.</p> </li> </ul>"
+ },
+ "InputParameters":{
+ "shape":"StringWithCharLimit2048",
+ "documentation":"<p>A string, in JSON format, that is passed to your organization Config Custom Policy rule.</p>"
+ },
+ "MaximumExecutionFrequency":{
+ "shape":"MaximumExecutionFrequency",
+ "documentation":"<p>The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>"
+ },
+ "ResourceTypesScope":{
+ "shape":"ResourceTypesScope",
+ "documentation":"<p>The type of the Amazon Web Services resource that was evaluated.</p>"
+ },
+ "ResourceIdScope":{
+ "shape":"StringWithCharLimit768",
+ "documentation":"<p>The ID of the Amazon Web Services resource that was evaluated.</p>"
+ },
+ "TagKeyScope":{
+ "shape":"StringWithCharLimit128",
+ "documentation":"<p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.</p>"
+ },
+ "TagValueScope":{
+ "shape":"StringWithCharLimit256",
+ "documentation":"<p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>"
+ },
+ "PolicyRuntime":{
+ "shape":"PolicyRuntime",
+ "documentation":"<p>The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the <a href=\"https://github.com/aws-cloudformation/cloudformation-guard\">Guard GitHub Repository</a>.</p>"
+ },
+ "DebugLogDeliveryAccounts":{
+ "shape":"DebugLogDeliveryAccounts",
+ "documentation":"<p>A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.</p>"
+ }
+ },
+ "documentation":"<p>An object that specifies metadata for your organization Config Custom Policy rule including the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that trigger Config to evaluate Amazon Web Services resources against a rule.</p>"
+ },
"OrganizationCustomRuleMetadata":{
"type":"structure",
"required":[
@@ -5402,7 +5621,7 @@
"members":{
"Description":{
"shape":"StringWithCharLimit256Min0",
- "documentation":"<p>The description that you provide for organization config rule.</p>"
+ "documentation":"<p>The description that you provide for your organization Config rule.</p>"
},
"LambdaFunctionArn":{
"shape":"StringWithCharLimit256",
@@ -5414,7 +5633,7 @@
},
"InputParameters":{
"shape":"StringWithCharLimit2048",
- "documentation":"<p>A string, in JSON format, that is passed to organization config rule Lambda function.</p>"
+ "documentation":"<p>A string, in JSON format, that is passed to your organization Config rule Lambda function.</p>"
},
"MaximumExecutionFrequency":{
"shape":"MaximumExecutionFrequency",
@@ -5445,7 +5664,7 @@
"members":{
"Description":{
"shape":"StringWithCharLimit256Min0",
- "documentation":"<p>The description that you provide for organization config rule.</p>"
+ "documentation":"<p>The description that you provide for your organization Config rule.</p>"
},
"RuleIdentifier":{
"shape":"StringWithCharLimit256",
@@ -5453,7 +5672,7 @@
},
"InputParameters":{
"shape":"StringWithCharLimit2048",
- "documentation":"<p>A string, in JSON format, that is passed to organization config rule Lambda function.</p>"
+ "documentation":"<p>A string, in JSON format, that is passed to your organization Config rule Lambda function.</p>"
},
"MaximumExecutionFrequency":{
"shape":"MaximumExecutionFrequency",
@@ -5545,7 +5764,8 @@
"type":"string",
"enum":[
"CUSTOM_LAMBDA",
- "AWS"
+ "AWS",
+ "CUSTOM_POLICY"
]
},
"PageSizeLimit":{
@@ -5587,6 +5807,17 @@
"max":100,
"min":1
},
+ "PolicyRuntime":{
+ "type":"string",
+ "max":64,
+ "min":1,
+ "pattern":"guard\\-2\\.x\\.x"
+ },
+ "PolicyText":{
+ "type":"string",
+ "max":10000,
+ "min":0
+ },
"PutAggregationAuthorizationRequest":{
"type":"structure",
"required":[
@@ -5687,7 +5918,7 @@
},
"TemplateBody":{
"shape":"TemplateBody",
- "documentation":"<p>A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <note> <p>You can only use a YAML template with one resource type, that is, config rule and a remediation action. </p> </note>"
+ "documentation":"<p>A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <note> <p>You can only use a YAML template with two resource types: Config rule (<code>AWS::Config::ConfigRule</code>) and a remediation action (<code>AWS::Config::RemediationConfiguration</code>).</p> </note>"
},
"DeliveryS3Bucket":{
"shape":"DeliveryS3Bucket",
@@ -5780,7 +6011,7 @@
"members":{
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
- "documentation":"<p>The name that you assign to an organization config rule.</p>"
+ "documentation":"<p>The name that you assign to an organization Config rule.</p>"
},
"OrganizationManagedRuleMetadata":{
"shape":"OrganizationManagedRuleMetadata",
@@ -5792,7 +6023,11 @@
},
"ExcludedAccounts":{
"shape":"ExcludedAccounts",
- "documentation":"<p>A comma-separated list of accounts that you want to exclude from an organization config rule.</p>"
+ "documentation":"<p>A comma-separated list of accounts that you want to exclude from an organization Config rule.</p>"
+ },
+ "OrganizationCustomPolicyRuleMetadata":{
+ "shape":"OrganizationCustomPolicyRuleMetadata",
+ "documentation":"<p>An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.</p>"
}
}
},
@@ -5801,7 +6036,7 @@
"members":{
"OrganizationConfigRuleArn":{
"shape":"StringWithCharLimit256",
- "documentation":"<p>The Amazon Resource Name (ARN) of an organization config rule.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of an organization Config rule.</p>"
}
}
},
@@ -6436,7 +6671,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>You see this exception in the following cases: </p> <ul> <li> <p>For DeleteConfigRule, Config is deleting this rule. Try your request again later.</p> </li> <li> <p>For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.</p> </li> <li> <p>For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.</p> </li> <li> <p>For PutConfigOrganizationRule, organization config rule deletion is in progress. Try your request again later.</p> </li> <li> <p>For DeleteOrganizationConfigRule, organization config rule creation is in progress. Try your request again later.</p> </li> <li> <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.</p> </li> <li> <p>For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.</p> </li> </ul>",
+ "documentation":"<p>You see this exception in the following cases: </p> <ul> <li> <p>For DeleteConfigRule, Config is deleting this rule. Try your request again later.</p> </li> <li> <p>For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.</p> </li> <li> <p>For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.</p> </li> <li> <p>For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.</p> </li> <li> <p>For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.</p> </li> <li> <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.</p> </li> <li> <p>For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.</p> </li> </ul>",
"exception":true
},
"ResourceKey":{
@@ -6595,7 +6830,10 @@
"AWS::Kinesis::StreamConsumer",
"AWS::CodeDeploy::Application",
"AWS::CodeDeploy::DeploymentConfig",
- "AWS::CodeDeploy::DeploymentGroup"
+ "AWS::CodeDeploy::DeploymentGroup",
+ "AWS::EC2::LaunchTemplate",
+ "AWS::ECR::PublicRepository",
+ "AWS::GuardDuty::Detector"
]
},
"ResourceTypeList":{
@@ -6790,25 +7028,26 @@
},
"Source":{
"type":"structure",
- "required":[
- "Owner",
- "SourceIdentifier"
- ],
+ "required":["Owner"],
"members":{
"Owner":{
"shape":"Owner",
- "documentation":"<p>Indicates whether Amazon Web Services or the customer owns and manages the Config rule.</p>"
+ "documentation":"<p>Indicates whether Amazon Web Services or the customer owns and manages the Config rule.</p> <p>Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Config Managed Rules</a> in the Config developer guide.</p> <p>Config Custom Rules are rules that you can develop either with Guard (<code>CUSTOM_POLICY</code>) or Lambda (<code>CUSTOM_LAMBDA</code>). For more information, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html\">Config Custom Rules </a> in the Config developer guide.</p>"
},
"SourceIdentifier":{
"shape":"StringWithCharLimit256",
- "documentation":"<p>For Config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using Config managed rules</a>.</p> <p>For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as <code>arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name</code>.</p>"
+ "documentation":"<p>For Config Managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html\">List of Config Managed Rules</a>.</p> <p>For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as <code>arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name</code>.</p> <p>For Config Custom Policy rules, this field will be ignored.</p>"
},
"SourceDetails":{
"shape":"SourceDetails",
- "documentation":"<p>Provides the source and type of the event that causes Config to evaluate your Amazon Web Services resources.</p>"
+ "documentation":"<p>Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.</p> <p>If the owner is set to <code>CUSTOM_POLICY</code>, the only acceptable values for the Config rule trigger message type are <code>ConfigurationItemChangeNotification</code> and <code>OversizedConfigurationItemChangeNotification</code>.</p>"
+ },
+ "CustomPolicyDetails":{
+ "shape":"CustomPolicyDetails",
+ "documentation":"<p>Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to <code>CUSTOM_POLICY</code>.</p>"
}
},
- "documentation":"<p>Provides the Config rule owner (Amazon Web Services or customer), the rule identifier, and the events that trigger the evaluation of your Amazon Web Services resources.</p>"
+ "documentation":"<p>Provides the CustomPolicyDetails, the rule owner (Amazon Web Services or customer), the rule identifier, and the events that cause the evaluation of your Amazon Web Services resources.</p>"
},
"SourceDetail":{
"type":"structure",
@@ -6936,10 +7175,10 @@
},
"MemberAccountRuleStatus":{
"shape":"MemberAccountRuleStatus",
- "documentation":"<p>Indicates deployment status for config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when config rule has been created in the member account.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when config rule is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when config rule creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when config rule is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when config rule has been deleted in the member account.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when config rule has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when config rule is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> </ul>"
+ "documentation":"<p>Indicates deployment status for Config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, Config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when Config rule has been created in the member account.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when Config rule is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when Config rule creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when Config rule deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when Config rule is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when Config rule has been deleted in the member account.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when Config rule has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when Config rule is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when Config rule deletion has failed in the member account.</p> </li> </ul>"
}
},
- "documentation":"<p>Status filter object to filter results based on specific member account ID or status type for an organization config rule. </p>"
+ "documentation":"<p>Status filter object to filter results based on specific member account ID or status type for an organization Config rule. </p>"
},
"StopConfigurationRecorderRequest":{
"type":"structure",
diff --git a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json
index 8e17a3a5e5..0b4769c44a 100644
--- a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json
@@ -1614,7 +1614,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.</p> <p>You can use this API to override the recording behavior configured in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html\">Set recording behavior</a> block.</p> <p>Only voice recordings are supported at this time.</p>"
+ "documentation":"<p>Starts recording the contact: </p> <ul> <li> <p>If the API is called <i>before</i> the agent joins the call, recording starts when the agent joins the call.</p> </li> <li> <p>If the API is called <i>after</i> the agent joins the call, recording starts at the time of the API call.</p> </li> </ul> <p>StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.</p> <p>You can use this API to override the recording behavior configured in the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html\">Set recording behavior</a> block.</p> <p>Only voice recordings are supported at this time.</p>"
},
"StartContactStreaming":{
"name":"StartContactStreaming",
@@ -1685,7 +1685,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Ends the specified contact.</p>"
+ "documentation":"<p>Ends the specified contact. This call does not work for the following initiation methods:</p> <ul> <li> <p>CALLBACK</p> </li> <li> <p>DISCONNECT</p> </li> <li> <p>TRANSFER</p> </li> <li> <p>QUEUE_TRANSFER</p> </li> </ul>"
},
"StopContactRecording":{
"name":"StopContactRecording",
@@ -2774,7 +2774,7 @@
"members":{
"ContentType":{
"shape":"ChatContentType",
- "documentation":"<p>The type of the content. Supported types are text and plain.</p>"
+ "documentation":"<p>The type of the content. Supported types are <code>text/plain</code>.</p>"
},
"Content":{
"shape":"ChatContent",
@@ -5705,7 +5705,8 @@
"SCHEDULED_REPORTS",
"MEDIA_STREAMS",
"CONTACT_TRACE_RECORDS",
- "AGENT_EVENTS"
+ "AGENT_EVENTS",
+ "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"
]
},
"InstanceSummary":{
@@ -8440,6 +8441,10 @@
"ChatDurationInMinutes":{
"shape":"ChatDurationInMinutes",
"documentation":"<p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>"
+ },
+ "SupportedMessagingContentTypes":{
+ "shape":"SupportedMessagingContentTypes",
+ "documentation":"<p>The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.</p>"
}
}
},
@@ -8745,6 +8750,15 @@
"min":1
},
"String":{"type":"string"},
+ "SupportedMessagingContentType":{
+ "type":"string",
+ "max":100,
+ "min":1
+ },
+ "SupportedMessagingContentTypes":{
+ "type":"list",
+ "member":{"shape":"SupportedMessagingContentType"}
+ },
"SuspendContactRecordingRequest":{
"type":"structure",
"required":[
diff --git a/contrib/python/botocore/py3/botocore/data/customer-profiles/2020-08-15/service-2.json b/contrib/python/botocore/py3/botocore/data/customer-profiles/2020-08-15/service-2.json
index 33279763bd..95713d8a7b 100644
--- a/contrib/python/botocore/py3/botocore/data/customer-profiles/2020-08-15/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/customer-profiles/2020-08-15/service-2.json
@@ -47,6 +47,23 @@
],
"documentation":"<p>Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.</p> <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.</p> <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity resolution</a>: set <code>Matching</code> to true. </p> <p>To prevent cross-service impersonation when you call this API, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html\">Cross-service confused deputy prevention</a> for sample policies that you should apply. </p>"
},
+ "CreateIntegrationWorkflow":{
+ "name":"CreateIntegrationWorkflow",
+ "http":{
+ "method":"POST",
+ "requestUri":"/domains/{DomainName}/workflows/integrations"
+ },
+ "input":{"shape":"CreateIntegrationWorkflowRequest"},
+ "output":{"shape":"CreateIntegrationWorkflowResponse"},
+ "errors":[
+ {"shape":"BadRequestException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. </p>"
+ },
"CreateProfile":{
"name":"CreateProfile",
"http":{
@@ -166,6 +183,23 @@
],
"documentation":"<p>Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.</p>"
},
+ "DeleteWorkflow":{
+ "name":"DeleteWorkflow",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/domains/{DomainName}/workflows/{WorkflowId}"
+ },
+ "input":{"shape":"DeleteWorkflowRequest"},
+ "output":{"shape":"DeleteWorkflowResponse"},
+ "errors":[
+ {"shape":"BadRequestException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Deletes the specified workflow and all its corresponding resources. This is an async process.</p>"
+ },
"GetAutoMergingPreview":{
"name":"GetAutoMergingPreview",
"http":{
@@ -249,7 +283,7 @@
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
- "documentation":"<p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable identity resolution: set <code>Matching</code> to true.</p> <p>GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. </p> <important> <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. </p> <p>After the Identity Resolution Job completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p> </important> <p>Amazon Connect uses the following profile attributes to identify matches:</p> <ul> <li> <p>PhoneNumber</p> </li> <li> <p>HomePhoneNumber</p> </li> <li> <p>BusinessPhoneNumber</p> </li> <li> <p>MobilePhoneNumber</p> </li> <li> <p>EmailAddress</p> </li> <li> <p>PersonalEmailAddress</p> </li> <li> <p>BusinessEmailAddress</p> </li> <li> <p>FullName</p> </li> <li> <p>BusinessName</p> </li> </ul> <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and <b>johndoe@anycompany.com</b>, or different phone number formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>"
+ "documentation":"<p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to enable identity resolution: set <code>Matching</code> to true.</p> <p>GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. </p> <important> <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. </p> <p>After the Identity Resolution Job completes, use the <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p> </important> <p>Amazon Connect uses the following profile attributes to identify matches:</p> <ul> <li> <p>PhoneNumber</p> </li> <li> <p>HomePhoneNumber</p> </li> <li> <p>BusinessPhoneNumber</p> </li> <li> <p>MobilePhoneNumber</p> </li> <li> <p>EmailAddress</p> </li> <li> <p>PersonalEmailAddress</p> </li> <li> <p>BusinessEmailAddress</p> </li> <li> <p>FullName</p> </li> </ul> <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and <b>johndoe@anycompany.com</b>, or different phone number formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>"
},
"GetProfileObjectType":{
"name":"GetProfileObjectType",
@@ -285,6 +319,40 @@
],
"documentation":"<p>Returns the template information for a specific object type.</p> <p>A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.</p>"
},
+ "GetWorkflow":{
+ "name":"GetWorkflow",
+ "http":{
+ "method":"GET",
+ "requestUri":"/domains/{DomainName}/workflows/{WorkflowId}"
+ },
+ "input":{"shape":"GetWorkflowRequest"},
+ "output":{"shape":"GetWorkflowResponse"},
+ "errors":[
+ {"shape":"BadRequestException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Get details of specified workflow.</p>"
+ },
+ "GetWorkflowSteps":{
+ "name":"GetWorkflowSteps",
+ "http":{
+ "method":"GET",
+ "requestUri":"/domains/{DomainName}/workflows/{WorkflowId}/steps"
+ },
+ "input":{"shape":"GetWorkflowStepsRequest"},
+ "output":{"shape":"GetWorkflowStepsResponse"},
+ "errors":[
+ {"shape":"BadRequestException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Get granular list of steps in workflow.</p>"
+ },
"ListAccountIntegrations":{
"name":"ListAccountIntegrations",
"http":{
@@ -419,6 +487,23 @@
],
"documentation":"<p>Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.</p>"
},
+ "ListWorkflows":{
+ "name":"ListWorkflows",
+ "http":{
+ "method":"POST",
+ "requestUri":"/domains/{DomainName}/workflows"
+ },
+ "input":{"shape":"ListWorkflowsRequest"},
+ "output":{"shape":"ListWorkflowsResponse"},
+ "errors":[
+ {"shape":"BadRequestException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Query to list all workflows.</p>"
+ },
"MergeProfiles":{
"name":"MergeProfiles",
"http":{
@@ -672,6 +757,111 @@
},
"documentation":"<p>A generic address associated with the customer that is not mailing, shipping, or billing.</p>"
},
+ "AppflowIntegration":{
+ "type":"structure",
+ "required":["FlowDefinition"],
+ "members":{
+ "FlowDefinition":{"shape":"FlowDefinition"},
+ "Batches":{
+ "shape":"Batches",
+ "documentation":"<p>Batches in workflow of type <code>APPFLOW_INTEGRATION</code>.</p>"
+ }
+ },
+ "documentation":"<p>Details for workflow of type <code>APPFLOW_INTEGRATION</code>.</p>"
+ },
+ "AppflowIntegrationWorkflowAttributes":{
+ "type":"structure",
+ "required":[
+ "SourceConnectorType",
+ "ConnectorProfileName"
+ ],
+ "members":{
+ "SourceConnectorType":{
+ "shape":"SourceConnectorType",
+ "documentation":"<p>Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.</p>"
+ },
+ "ConnectorProfileName":{
+ "shape":"ConnectorProfileName",
+ "documentation":"<p>The name of the AppFlow connector profile used for ingestion.</p>"
+ },
+ "RoleArn":{
+ "shape":"string1To255",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.</p>"
+ }
+ },
+ "documentation":"<p>Structure holding all <code>APPFLOW_INTEGRATION</code> specific workflow attributes.</p>"
+ },
+ "AppflowIntegrationWorkflowMetrics":{
+ "type":"structure",
+ "required":[
+ "RecordsProcessed",
+ "StepsCompleted",
+ "TotalSteps"
+ ],
+ "members":{
+ "RecordsProcessed":{
+ "shape":"long",
+ "documentation":"<p>Number of records processed in <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "StepsCompleted":{
+ "shape":"long",
+ "documentation":"<p>Total steps completed in <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "TotalSteps":{
+ "shape":"long",
+ "documentation":"<p>Total steps in <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ }
+ },
+ "documentation":"<p>Workflow specific execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "AppflowIntegrationWorkflowStep":{
+ "type":"structure",
+ "required":[
+ "FlowName",
+ "Status",
+ "ExecutionMessage",
+ "RecordsProcessed",
+ "BatchRecordsStartTime",
+ "BatchRecordsEndTime",
+ "CreatedAt",
+ "LastUpdatedAt"
+ ],
+ "members":{
+ "FlowName":{
+ "shape":"FlowName",
+ "documentation":"<p>Name of the flow created during execution of workflow step. <code>APPFLOW_INTEGRATION</code> workflow type creates an appflow flow during workflow step execution on the customers behalf.</p>"
+ },
+ "Status":{
+ "shape":"Status",
+ "documentation":"<p>Workflow step status for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "ExecutionMessage":{
+ "shape":"string1To255",
+ "documentation":"<p>Message indicating execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "RecordsProcessed":{
+ "shape":"long",
+ "documentation":"<p>Total number of records processed during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "BatchRecordsStartTime":{
+ "shape":"string1To255",
+ "documentation":"<p>Start datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "BatchRecordsEndTime":{
+ "shape":"string1To255",
+ "documentation":"<p>End datetime of records pulled in batch during execution of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "CreatedAt":{
+ "shape":"timestamp",
+ "documentation":"<p>Creation timestamp of workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
+ "LastUpdatedAt":{
+ "shape":"timestamp",
+ "documentation":"<p>Last updated timestamp for workflow step for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ }
+ },
+ "documentation":"<p>Workflow step details for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ },
"AttributeSourceIdMap":{
"type":"map",
"key":{"shape":"string1To255"},
@@ -710,6 +900,28 @@
"error":{"httpStatusCode":400},
"exception":true
},
+ "Batch":{
+ "type":"structure",
+ "required":[
+ "StartTime",
+ "EndTime"
+ ],
+ "members":{
+ "StartTime":{
+ "shape":"timestamp",
+ "documentation":"<p>Start time of batch to split ingestion.</p>"
+ },
+ "EndTime":{
+ "shape":"timestamp",
+ "documentation":"<p>End time of batch to split ingestion.</p>"
+ }
+ },
+ "documentation":"<p>Batch defines the boundaries for ingestion for each step in <code>APPFLOW_INTEGRATION</code> workflow. <code>APPFLOW_INTEGRATION</code> workflow splits ingestion based on these boundaries.</p>"
+ },
+ "Batches":{
+ "type":"list",
+ "member":{"shape":"Batch"}
+ },
"BucketName":{
"type":"string",
"max":63,
@@ -863,6 +1075,61 @@
}
}
},
+ "CreateIntegrationWorkflowRequest":{
+ "type":"structure",
+ "required":[
+ "DomainName",
+ "WorkflowType",
+ "IntegrationConfig",
+ "ObjectTypeName",
+ "RoleArn"
+ ],
+ "members":{
+ "DomainName":{
+ "shape":"name",
+ "documentation":"<p>The unique name of the domain.</p>",
+ "location":"uri",
+ "locationName":"DomainName"
+ },
+ "WorkflowType":{
+ "shape":"WorkflowType",
+ "documentation":"<p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>"
+ },
+ "IntegrationConfig":{
+ "shape":"IntegrationConfig",
+ "documentation":"<p>Configuration data for integration workflow.</p>"
+ },
+ "ObjectTypeName":{
+ "shape":"typeName",
+ "documentation":"<p>The name of the profile object type.</p>"
+ },
+ "RoleArn":{
+ "shape":"RoleArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags used to organize, track, or control access for this resource.</p>"
+ }
+ }
+ },
+ "CreateIntegrationWorkflowResponse":{
+ "type":"structure",
+ "required":[
+ "WorkflowId",
+ "Message"
+ ],
+ "members":{
+ "WorkflowId":{
+ "shape":"uuid",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
+ },
+ "Message":{
+ "shape":"string1To255",
+ "documentation":"<p>A message indicating create request was received.</p>"
+ }
+ }
+ },
"CreateProfileRequest":{
"type":"structure",
"required":["DomainName"],
@@ -1168,6 +1435,32 @@
}
}
},
+ "DeleteWorkflowRequest":{
+ "type":"structure",
+ "required":[
+ "DomainName",
+ "WorkflowId"
+ ],
+ "members":{
+ "DomainName":{
+ "shape":"name",
+ "documentation":"<p>The unique name of the domain.</p>",
+ "location":"uri",
+ "locationName":"DomainName"
+ },
+ "WorkflowId":{
+ "shape":"string1To255",
+ "documentation":"<p>Unique identifier for the workflow.</p>",
+ "location":"uri",
+ "locationName":"WorkflowId"
+ }
+ }
+ },
+ "DeleteWorkflowResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
"DestinationField":{
"type":"string",
"max":256,
@@ -1613,6 +1906,10 @@
"ObjectTypeNames":{
"shape":"ObjectTypeNames",
"documentation":"<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
+ },
+ "WorkflowId":{
+ "shape":"string1To255",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
}
}
},
@@ -1784,6 +2081,118 @@
}
}
},
+ "GetWorkflowRequest":{
+ "type":"structure",
+ "required":[
+ "DomainName",
+ "WorkflowId"
+ ],
+ "members":{
+ "DomainName":{
+ "shape":"name",
+ "documentation":"<p>The unique name of the domain.</p>",
+ "location":"uri",
+ "locationName":"DomainName"
+ },
+ "WorkflowId":{
+ "shape":"uuid",
+ "documentation":"<p>Unique identifier for the workflow.</p>",
+ "location":"uri",
+ "locationName":"WorkflowId"
+ }
+ }
+ },
+ "GetWorkflowResponse":{
+ "type":"structure",
+ "members":{
+ "WorkflowId":{
+ "shape":"uuid",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
+ },
+ "WorkflowType":{
+ "shape":"WorkflowType",
+ "documentation":"<p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>"
+ },
+ "Status":{
+ "shape":"Status",
+ "documentation":"<p>Status of workflow execution.</p>"
+ },
+ "ErrorDescription":{
+ "shape":"string1To255",
+ "documentation":"<p>Workflow error messages during execution (if any).</p>"
+ },
+ "StartDate":{
+ "shape":"timestamp",
+ "documentation":"<p>The timestamp that represents when workflow execution started.</p>"
+ },
+ "LastUpdatedAt":{
+ "shape":"timestamp",
+ "documentation":"<p>The timestamp that represents when workflow execution last updated.</p>"
+ },
+ "Attributes":{
+ "shape":"WorkflowAttributes",
+ "documentation":"<p>Attributes provided for workflow execution.</p>"
+ },
+ "Metrics":{
+ "shape":"WorkflowMetrics",
+ "documentation":"<p>Workflow specific execution metrics.</p>"
+ }
+ }
+ },
+ "GetWorkflowStepsRequest":{
+ "type":"structure",
+ "required":[
+ "DomainName",
+ "WorkflowId"
+ ],
+ "members":{
+ "DomainName":{
+ "shape":"name",
+ "documentation":"<p>The unique name of the domain.</p>",
+ "location":"uri",
+ "locationName":"DomainName"
+ },
+ "WorkflowId":{
+ "shape":"uuid",
+ "documentation":"<p>Unique identifier for the workflow.</p>",
+ "location":"uri",
+ "locationName":"WorkflowId"
+ },
+ "NextToken":{
+ "shape":"token",
+ "documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
+ "location":"querystring",
+ "locationName":"next-token"
+ },
+ "MaxResults":{
+ "shape":"maxSize100",
+ "documentation":"<p>The maximum number of results to return per page.</p>",
+ "location":"querystring",
+ "locationName":"max-results"
+ }
+ }
+ },
+ "GetWorkflowStepsResponse":{
+ "type":"structure",
+ "members":{
+ "WorkflowId":{
+ "shape":"uuid",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
+ },
+ "WorkflowType":{
+ "shape":"WorkflowType",
+ "documentation":"<p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>"
+ },
+ "Items":{
+ "shape":"WorkflowStepsList",
+ "documentation":"<p>List containing workflow step details.</p>"
+ },
+ "NextToken":{
+ "shape":"token",
+ "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>"
+ }
+ }
+ },
"IdentityResolutionJob":{
"type":"structure",
"members":{
@@ -1848,6 +2257,16 @@
},
"documentation":"<p>Specifies the configuration used when importing incremental records from the source.</p>"
},
+ "IntegrationConfig":{
+ "type":"structure",
+ "members":{
+ "AppflowIntegration":{
+ "shape":"AppflowIntegration",
+ "documentation":"<p>Configuration data for <code>APPFLOW_INTEGRATION</code> workflow type.</p>"
+ }
+ },
+ "documentation":"<p>Configuration data for integration workflow.</p>"
+ },
"IntegrationList":{
"type":"list",
"member":{"shape":"ListIntegrationItem"}
@@ -1946,6 +2365,12 @@
"documentation":"<p>The maximum number of objects returned per page.</p>",
"location":"querystring",
"locationName":"max-results"
+ },
+ "IncludeHidden":{
+ "shape":"optionalBoolean",
+ "documentation":"<p>Boolean to indicate if hidden integration should be returned. Defaults to <code>False</code>.</p>",
+ "location":"querystring",
+ "locationName":"include-hidden"
}
}
},
@@ -2092,6 +2517,10 @@
"ObjectTypeNames":{
"shape":"ObjectTypeNames",
"documentation":"<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
+ },
+ "WorkflowId":{
+ "shape":"string1To255",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
}
},
"documentation":"<p>An integration in list of integrations.</p>"
@@ -2117,6 +2546,12 @@
"documentation":"<p>The maximum number of objects returned per page.</p>",
"location":"querystring",
"locationName":"max-results"
+ },
+ "IncludeHidden":{
+ "shape":"optionalBoolean",
+ "documentation":"<p>Boolean to indicate if hidden integration should be returned. Defaults to <code>False</code>.</p>",
+ "location":"querystring",
+ "locationName":"include-hidden"
}
}
},
@@ -2340,6 +2775,97 @@
}
}
},
+ "ListWorkflowsItem":{
+ "type":"structure",
+ "required":[
+ "WorkflowType",
+ "WorkflowId",
+ "Status",
+ "StatusDescription",
+ "CreatedAt",
+ "LastUpdatedAt"
+ ],
+ "members":{
+ "WorkflowType":{
+ "shape":"WorkflowType",
+ "documentation":"<p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>"
+ },
+ "WorkflowId":{
+ "shape":"string1To255",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
+ },
+ "Status":{
+ "shape":"Status",
+ "documentation":"<p>Status of workflow execution.</p>"
+ },
+ "StatusDescription":{
+ "shape":"string1To255",
+ "documentation":"<p>Description for workflow execution status.</p>"
+ },
+ "CreatedAt":{
+ "shape":"timestamp",
+ "documentation":"<p>Creation timestamp for workflow.</p>"
+ },
+ "LastUpdatedAt":{
+ "shape":"timestamp",
+ "documentation":"<p>Last updated timestamp for workflow.</p>"
+ }
+ },
+ "documentation":"<p>A workflow in list of workflows.</p>"
+ },
+ "ListWorkflowsRequest":{
+ "type":"structure",
+ "required":["DomainName"],
+ "members":{
+ "DomainName":{
+ "shape":"name",
+ "documentation":"<p>The unique name of the domain.</p>",
+ "location":"uri",
+ "locationName":"DomainName"
+ },
+ "WorkflowType":{
+ "shape":"WorkflowType",
+ "documentation":"<p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>"
+ },
+ "Status":{
+ "shape":"Status",
+ "documentation":"<p>Status of workflow execution.</p>"
+ },
+ "QueryStartDate":{
+ "shape":"timestamp",
+ "documentation":"<p>Retrieve workflows started after timestamp.</p>"
+ },
+ "QueryEndDate":{
+ "shape":"timestamp",
+ "documentation":"<p>Retrieve workflows ended after timestamp.</p>"
+ },
+ "NextToken":{
+ "shape":"token",
+ "documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
+ "location":"querystring",
+ "locationName":"next-token"
+ },
+ "MaxResults":{
+ "shape":"maxSize100",
+ "documentation":"<p>The maximum number of results to return per page.</p>",
+ "location":"querystring",
+ "locationName":"max-results"
+ }
+ }
+ },
+ "ListWorkflowsResponse":{
+ "type":"structure",
+ "members":{
+ "Items":{
+ "shape":"WorkflowList",
+ "documentation":"<p>List containing workflow details.</p>"
+ },
+ "NextToken":{
+ "shape":"token",
+ "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>"
+ }
+ }
+ },
"MarketoConnectorOperator":{
"type":"string",
"enum":[
@@ -2772,6 +3298,10 @@
"ObjectTypeNames":{
"shape":"ObjectTypeNames",
"documentation":"<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
+ },
+ "WorkflowId":{
+ "shape":"string1To255",
+ "documentation":"<p>Unique identifier for the workflow.</p>"
}
}
},
@@ -2932,6 +3462,11 @@
"error":{"httpStatusCode":404},
"exception":true
},
+ "RoleArn":{
+ "type":"string",
+ "max":512,
+ "pattern":"arn:aws:iam:.*:[0-9]+:.*"
+ },
"S3ConnectorOperator":{
"type":"string",
"enum":[
@@ -3261,6 +3796,18 @@
"type":"list",
"member":{"shape":"StandardIdentifier"}
},
+ "Status":{
+ "type":"string",
+ "enum":[
+ "NOT_STARTED",
+ "IN_PROGRESS",
+ "COMPLETE",
+ "FAILED",
+ "SPLIT",
+ "RETRY",
+ "CANCELLED"
+ ]
+ },
"TagArn":{
"type":"string",
"max":256,
@@ -3675,6 +4222,48 @@
}
}
},
+ "WorkflowAttributes":{
+ "type":"structure",
+ "members":{
+ "AppflowIntegration":{
+ "shape":"AppflowIntegrationWorkflowAttributes",
+ "documentation":"<p>Workflow attributes specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ }
+ },
+ "documentation":"<p>Structure to hold workflow attributes.</p>"
+ },
+ "WorkflowList":{
+ "type":"list",
+ "member":{"shape":"ListWorkflowsItem"}
+ },
+ "WorkflowMetrics":{
+ "type":"structure",
+ "members":{
+ "AppflowIntegration":{
+ "shape":"AppflowIntegrationWorkflowMetrics",
+ "documentation":"<p>Workflow execution metrics for <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ }
+ },
+ "documentation":"<p>Generic object containing workflow execution metrics.</p>"
+ },
+ "WorkflowStepItem":{
+ "type":"structure",
+ "members":{
+ "AppflowIntegration":{
+ "shape":"AppflowIntegrationWorkflowStep",
+ "documentation":"<p>Workflow step information specific to <code>APPFLOW_INTEGRATION</code> workflow.</p>"
+ }
+ },
+ "documentation":"<p>List containing steps in workflow.</p>"
+ },
+ "WorkflowStepsList":{
+ "type":"list",
+ "member":{"shape":"WorkflowStepItem"}
+ },
+ "WorkflowType":{
+ "type":"string",
+ "enum":["APPFLOW_INTEGRATION"]
+ },
"ZendeskConnectorOperator":{
"type":"string",
"enum":[
diff --git a/contrib/python/botocore/py3/botocore/data/databrew/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/databrew/2017-07-25/service-2.json
index 98e359d457..dc91cb861e 100644
--- a/contrib/python/botocore/py3/botocore/data/databrew/2017-07-25/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/databrew/2017-07-25/service-2.json
@@ -2956,6 +2956,11 @@
"type":"integer",
"min":1
},
+ "MaxOutputFiles":{
+ "type":"integer",
+ "max":999,
+ "min":1
+ },
"MaxResults100":{
"type":"integer",
"max":100,
@@ -3027,6 +3032,10 @@
"FormatOptions":{
"shape":"OutputFormatOptions",
"documentation":"<p>Represents options that define how DataBrew formats job output files.</p>"
+ },
+ "MaxOutputFiles":{
+ "shape":"MaxOutputFiles",
+ "documentation":"<p>Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.</p>"
}
},
"documentation":"<p>Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/dataexchange/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/dataexchange/2017-07-25/service-2.json
index cdd927da38..943534a91b 100644
--- a/contrib/python/botocore/py3/botocore/data/dataexchange/2017-07-25/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/dataexchange/2017-07-25/service-2.json
@@ -155,6 +155,10 @@
{
"shape": "AccessDeniedException",
"documentation": "<p>403 response</p>"
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "<p>409 response</p>"
}
],
"documentation": "<p>This operation creates a job.</p>"
@@ -698,6 +702,48 @@
"errors": [],
"documentation": "<p>This operation lists the tags on the resource.</p>"
},
+ "RevokeRevision": {
+ "name": "RevokeRevision",
+ "http": {
+ "method": "POST",
+ "requestUri": "/v1/data-sets/{DataSetId}/revisions/{RevisionId}/revoke",
+ "responseCode": 200
+ },
+ "input": {
+ "shape": "RevokeRevisionRequest"
+ },
+ "output": {
+ "shape": "RevokeRevisionResponse",
+ "documentation": "<p>200 response</p>"
+ },
+ "errors": [
+ {
+ "shape": "ValidationException",
+ "documentation": "<p>400 response</p>"
+ },
+ {
+ "shape": "InternalServerException",
+ "documentation": "<p>500 response</p>"
+ },
+ {
+ "shape": "AccessDeniedException",
+ "documentation": "<p>403 response</p>"
+ },
+ {
+ "shape": "ResourceNotFoundException",
+ "documentation": "<p>404 response</p>"
+ },
+ {
+ "shape": "ThrottlingException",
+ "documentation": "<p>429 response</p>"
+ },
+ {
+ "shape": "ConflictException",
+ "documentation": "<p>409 response</p>"
+ }
+ ],
+ "documentation": "<p>This operation revokes subscribers' access to a revision.</p>"
+ },
"SendApiAsset": {
"name": "SendApiAsset",
"http": {
@@ -1130,7 +1176,7 @@
"documentation": "<p>The date and time that the asset was last updated, in ISO 8601 format.</p>"
}
},
- "documentation": "<p>An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare (Preview). When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.</p>",
+ "documentation": "<p>An asset in AWS Data Exchange is a piece of data (S3 object) or a means of fulfilling data (Amazon Redshift datashare or Amazon API Gateway API). The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, an Amazon API Gateway API, or an Amazon Redshift datashare. When you create an import job for your files, API Gateway APIs, or Amazon Redshift datashares, you create an asset in AWS Data Exchange.</p>",
"required": [
"AssetType",
"CreatedAt",
@@ -1498,6 +1544,18 @@
"UpdatedAt": {
"shape": "Timestamp",
"documentation": "<p>The date and time that the revision was last updated, in ISO 8601 format.</p>"
+ },
+ "RevocationComment": {
+ "shape": "__stringMin10Max512",
+ "documentation": "<p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>"
+ },
+ "Revoked": {
+ "shape": "__boolean",
+ "documentation": "<p>A status indicating that subscribers' access to the revision was revoked.</p>"
+ },
+ "RevokedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was revoked, in ISO 8601 format.</p>"
}
}
},
@@ -2169,6 +2227,18 @@
"UpdatedAt": {
"shape": "Timestamp",
"documentation": "<p>The date and time that the revision was last updated, in ISO 8601 format.</p>"
+ },
+ "RevocationComment": {
+ "shape": "__stringMin10Max512",
+ "documentation": "<p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>"
+ },
+ "Revoked": {
+ "shape": "__boolean",
+ "documentation": "<p>A status indicating that subscribers' access to the revision was revoked.</p>"
+ },
+ "RevokedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was revoked, in ISO 8601 format.</p>"
}
}
},
@@ -3079,6 +3149,18 @@
"UpdatedAt": {
"shape": "Timestamp",
"documentation": "<p>The date and time that the revision was last updated, in ISO 8601 format.</p>"
+ },
+ "RevocationComment": {
+ "shape": "__stringMin10Max512",
+ "documentation": "<p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>"
+ },
+ "Revoked": {
+ "shape": "__boolean",
+ "documentation": "<p>A status indicating that subscribers' access to the revision was revoked.</p>"
+ },
+ "RevokedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was revoked, in ISO 8601 format.</p>"
}
},
"documentation": "<p>A revision is a container for one or more assets.</p>",
@@ -3103,6 +3185,82 @@
"DataSetId"
]
},
+ "RevokeRevisionRequest": {
+ "type": "structure",
+ "members": {
+ "DataSetId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "DataSetId",
+ "documentation": "<p>The unique identifier for a data set.</p>"
+ },
+ "RevisionId": {
+ "shape": "__string",
+ "location": "uri",
+ "locationName": "RevisionId",
+ "documentation": "<p>The unique identifier for a revision.</p>"
+ },
+ "RevocationComment": {
+ "shape": "__stringMin10Max512",
+ "documentation": "<p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>"
+ }
+ },
+ "documentation": "<p>The request body for RevokeRevision.</p>",
+ "required": [
+ "RevisionId",
+ "DataSetId",
+ "RevocationComment"
+ ]
+ },
+ "RevokeRevisionResponse": {
+ "type": "structure",
+ "members": {
+ "Arn": {
+ "shape": "Arn",
+ "documentation": "<p>The ARN for the revision.</p>"
+ },
+ "Comment": {
+ "shape": "__stringMin0Max16384",
+ "documentation": "<p>An optional comment about the revision.</p>"
+ },
+ "CreatedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was created, in ISO 8601 format.</p>"
+ },
+ "DataSetId": {
+ "shape": "Id",
+ "documentation": "<p>The unique identifier for the data set associated with this revision.</p>"
+ },
+ "Finalized": {
+ "shape": "__boolean",
+ "documentation": "<p>To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.</p> <p>Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.</p>"
+ },
+ "Id": {
+ "shape": "Id",
+ "documentation": "<p>The unique identifier for the revision.</p>"
+ },
+ "SourceId": {
+ "shape": "Id",
+ "documentation": "<p>The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.</p>"
+ },
+ "UpdatedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was last updated, in ISO 8601 format.</p>"
+ },
+ "RevocationComment": {
+ "shape": "__stringMin10Max512",
+ "documentation": "<p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>"
+ },
+ "Revoked": {
+ "shape": "__boolean",
+ "documentation": "<p>A status indicating that subscribers' access to the revision was revoked.</p>"
+ },
+ "RevokedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was revoked, in ISO 8601 format.</p>"
+ }
+ }
+ },
"S3SnapshotAsset": {
"type": "structure",
"members": {
@@ -3586,6 +3744,18 @@
"UpdatedAt": {
"shape": "Timestamp",
"documentation": "<p>The date and time that the revision was last updated, in ISO 8601 format.</p>"
+ },
+ "RevocationComment": {
+ "shape": "__stringMin10Max512",
+ "documentation": "<p>A required comment to inform subscribers of the reason their access to the revision was revoked.</p>"
+ },
+ "Revoked": {
+ "shape": "__boolean",
+ "documentation": "<p>A status indicating that subscribers' access to the revision was revoked.</p>"
+ },
+ "RevokedAt": {
+ "shape": "Timestamp",
+ "documentation": "<p>The date and time that the revision was revoked, in ISO 8601 format.</p>"
}
}
},
@@ -3683,6 +3853,11 @@
"min": 24,
"max": 24,
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
+ },
+ "__stringMin10Max512": {
+ "type": "string",
+ "min": 10,
+ "max": 512
}
},
"documentation": "<p>AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.</p><p>As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIS to download or copy your entitled data sets to Amazon S3 for use across a variety of AWS analytics and machine learning services.</p><p>As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.</p><p>A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/devops-guru/2020-12-01/service-2.json b/contrib/python/botocore/py3/botocore/data/devops-guru/2020-12-01/service-2.json
index f74723efc8..a5e9e3f910 100644
--- a/contrib/python/botocore/py3/botocore/data/devops-guru/2020-12-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/devops-guru/2020-12-01/service-2.json
@@ -84,6 +84,23 @@
],
"documentation":"<p> Returns details about an anomaly that you specify using its ID. </p>"
},
+ "DescribeEventSourcesConfig":{
+ "name":"DescribeEventSourcesConfig",
+ "http":{
+ "method":"POST",
+ "requestUri":"/event-sources",
+ "responseCode":200
+ },
+ "input":{"shape":"DescribeEventSourcesConfigRequest"},
+ "output":{"shape":"DescribeEventSourcesConfigResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ValidationException"}
+ ],
+ "documentation":"<p>This operation lists details about a DevOps Guru event source that is shared with your&#x2028; account.</p>"
+ },
"DescribeFeedback":{
"name":"DescribeFeedback",
"http":{
@@ -437,6 +454,23 @@
],
"documentation":"<p>Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.</p>"
},
+ "UpdateEventSourcesConfig":{
+ "name":"UpdateEventSourcesConfig",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/event-sources",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateEventSourcesConfigRequest"},
+ "output":{"shape":"UpdateEventSourcesConfigResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ValidationException"}
+ ],
+ "documentation":"<p>Updates the event source configuration.</p>"
+ },
"UpdateResourceCollection":{
"name":"UpdateResourceCollection",
"http":{
@@ -543,6 +577,16 @@
}
}
},
+ "AmazonCodeGuruProfilerIntegration":{
+ "type":"structure",
+ "members":{
+ "Status":{
+ "shape":"EventSourceOptInStatus",
+ "documentation":"<p>The status of the CodeGuru Profiler integration.</p>"
+ }
+ },
+ "documentation":"<p>Information about your account's integration with Amazon CodeGuru Profiler.</p>"
+ },
"AnomalyDescription":{"type":"string"},
"AnomalyId":{
"type":"string",
@@ -596,6 +640,7 @@
"HIGH"
]
},
+ "AnomalySource":{"type":"string"},
"AnomalySourceDetails":{
"type":"structure",
"members":{
@@ -610,6 +655,24 @@
},
"documentation":"<p> Details about the source of the anomalous operational data that triggered the anomaly.</p>"
},
+ "AnomalySourceMetadata":{
+ "type":"structure",
+ "members":{
+ "Source":{
+ "shape":"AnomalySource",
+ "documentation":"<p>The source of the anomaly.</p>"
+ },
+ "SourceResourceName":{
+ "shape":"ResourceName",
+ "documentation":"<p>The name of the anomaly's resource.</p>"
+ },
+ "SourceResourceType":{
+ "shape":"ResourceType",
+ "documentation":"<p>The anomaly's resource type.</p>"
+ }
+ },
+ "documentation":"<p>Metadata about an anomaly. The anomaly is detected using analysis of the metric data&#x2028; over a period of time</p>"
+ },
"AnomalyStatus":{
"type":"string",
"enum":[
@@ -987,6 +1050,20 @@
}
}
},
+ "DescribeEventSourcesConfigRequest":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "DescribeEventSourcesConfigResponse":{
+ "type":"structure",
+ "members":{
+ "EventSources":{
+ "shape":"EventSourcesConfig",
+ "documentation":"<p>The name of the event source.</p>"
+ }
+ }
+ },
"DescribeFeedbackRequest":{
"type":"structure",
"members":{
@@ -1335,6 +1412,23 @@
"min":10,
"pattern":"^[a-z]+[a-z0-9]*\\.amazonaws\\.com|aws\\.events$"
},
+ "EventSourceOptInStatus":{
+ "type":"string",
+ "enum":[
+ "ENABLED",
+ "DISABLED"
+ ]
+ },
+ "EventSourcesConfig":{
+ "type":"structure",
+ "members":{
+ "AmazonCodeGuruProfiler":{
+ "shape":"AmazonCodeGuruProfilerIntegration",
+ "documentation":"<p/>"
+ }
+ },
+ "documentation":"<p>Describes the event sources.</p>"
+ },
"EventTimeRange":{
"type":"structure",
"required":[
@@ -1428,6 +1522,7 @@
}
}
},
+ "InsightDescription":{"type":"string"},
"InsightFeedback":{
"type":"structure",
"members":{
@@ -2211,6 +2306,14 @@
"Limit":{
"shape":"AnomalyLimit",
"documentation":"<p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. </p>"
+ },
+ "SourceMetadata":{
+ "shape":"AnomalySourceMetadata",
+ "documentation":"<p>The metadata for the anomaly.</p>"
+ },
+ "AnomalyResources":{
+ "shape":"AnomalyResources",
+ "documentation":"<p>Information about a resource in which DevOps Guru detected anomalous behavior.</p>"
}
},
"documentation":"<p>Information about an anomaly. This object is returned by <code>ListAnomalies</code>.</p>"
@@ -2252,6 +2355,14 @@
"Limit":{
"shape":"AnomalyLimit",
"documentation":"<p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. </p>"
+ },
+ "SourceMetadata":{
+ "shape":"AnomalySourceMetadata",
+ "documentation":"<p>Returns the metadata of the source.</p>"
+ },
+ "AnomalyResources":{
+ "shape":"AnomalyResources",
+ "documentation":"<p>Information about a resource in which DevOps Guru detected anomalous behavior.</p>"
}
},
"documentation":"<p>Details about a proactive anomaly. This object is returned by <code>DescribeAnomaly.</code> </p>"
@@ -2281,6 +2392,10 @@
"SsmOpsItemId":{
"shape":"SsmOpsItemId",
"documentation":"<p> The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight. </p>"
+ },
+ "Description":{
+ "shape":"InsightDescription",
+ "documentation":"<p>Describes the proactive insight.</p>"
}
},
"documentation":"<p>Details about a proactive insight. This object is returned by <code>ListInsights</code>.</p>"
@@ -2506,6 +2621,10 @@
"SsmOpsItemId":{
"shape":"SsmOpsItemId",
"documentation":"<p> The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight. </p>"
+ },
+ "Description":{
+ "shape":"InsightDescription",
+ "documentation":"<p>Describes the reactive insight.</p>"
}
},
"documentation":"<p> Information about a reactive insight. This object is returned by <code>ListInsights</code>. </p>"
@@ -2609,10 +2728,15 @@
"RelatedAnomalies":{
"shape":"RecommendationRelatedAnomalies",
"documentation":"<p> Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue. </p>"
+ },
+ "Category":{
+ "shape":"RecommendationCategory",
+ "documentation":"<p>The category type of the recommendation.</p>"
}
},
"documentation":"<p> Recommendation information to help you remediate detected anomalous behavior that generated an insight. </p>"
},
+ "RecommendationCategory":{"type":"string"},
"RecommendationDescription":{"type":"string"},
"RecommendationLink":{"type":"string"},
"RecommendationName":{"type":"string"},
@@ -3316,6 +3440,20 @@
},
"documentation":"<p> Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.</p>"
},
+ "UpdateEventSourcesConfigRequest":{
+ "type":"structure",
+ "members":{
+ "EventSources":{
+ "shape":"EventSourcesConfig",
+ "documentation":"<p>The name of the event source.</p>"
+ }
+ }
+ },
+ "UpdateEventSourcesConfigResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
"UpdateResourceCollectionAction":{
"type":"string",
"enum":[
diff --git a/contrib/python/botocore/py3/botocore/data/dynamodb/2012-08-10/service-2.json b/contrib/python/botocore/py3/botocore/data/dynamodb/2012-08-10/service-2.json
index 83e2af6400..25c87aae09 100644
--- a/contrib/python/botocore/py3/botocore/data/dynamodb/2012-08-10/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/dynamodb/2012-08-10/service-2.json
@@ -411,7 +411,7 @@
{"shape":"InternalServerError"},
{"shape":"DuplicateItemException"}
],
- "documentation":"<p>This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.</p>"
+ "documentation":"<p>This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.</p> <p>For PartiQL reads (<code>SELECT</code> statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a <code>LastEvaluatedKey</code> value to continue the read in a subsequent operation. If the filter criteria in <code>WHERE</code> clause does not match any data, the read will return an empty result set.</p> <p>A single <code>SELECT</code> statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using <code>WHERE</code> clause). If <code>LastEvaluatedKey</code> is present in the response, you need to paginate the result set.</p>"
},
"ExecuteTransaction":{
"name":"ExecuteTransaction",
@@ -2477,7 +2477,11 @@
"shape":"PartiQLNextToken",
"documentation":"<p>Set this value to get remaining results, if <code>NextToken</code> was returned in the statement response.</p>"
},
- "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}
+ "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
+ "Limit":{
+ "shape":"PositiveIntegerObject",
+ "documentation":"<p>The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in <code>LastEvaluatedKey</code> to apply in a subsequent operation to continue the operation. </p>"
+ }
}
},
"ExecuteStatementOutput":{
@@ -2491,7 +2495,11 @@
"shape":"PartiQLNextToken",
"documentation":"<p>If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.</p>"
},
- "ConsumedCapacity":{"shape":"ConsumedCapacity"}
+ "ConsumedCapacity":{"shape":"ConsumedCapacity"},
+ "LastEvaluatedKey":{
+ "shape":"Key",
+ "documentation":"<p>The primary key 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. If <code>LastEvaluatedKey</code> is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved. If <code>LastEvaluatedKey</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>LastEvaluatedKey</code> is empty. </p>"
+ }
}
},
"ExecuteTransactionInput":{
diff --git a/contrib/python/botocore/py3/botocore/data/ebs/2019-11-02/service-2.json b/contrib/python/botocore/py3/botocore/data/ebs/2019-11-02/service-2.json
index 880e4822d0..bea4106a85 100644
--- a/contrib/python/botocore/py3/botocore/data/ebs/2019-11-02/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ebs/2019-11-02/service-2.json
@@ -291,7 +291,7 @@
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request uses the same client token as a previous, but non-identical request.</p>",
- "error":{"httpStatusCode":503},
+ "error":{"httpStatusCode":409},
"exception":true
},
"DataLength":{"type":"integer"},
@@ -314,19 +314,19 @@
"members":{
"SnapshotId":{
"shape":"SnapshotId",
- "documentation":"<p>The ID of the snapshot containing the block from which to get data.</p>",
+ "documentation":"<p>The ID of the snapshot containing the block from which to get data.</p> <important> <p>If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important>",
"location":"uri",
"locationName":"snapshotId"
},
"BlockIndex":{
"shape":"BlockIndex",
- "documentation":"<p>The block index of the block from which to get data.</p> <p>Obtain the <code>BlockIndex</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
+ "documentation":"<p>The block index of the block in which to read the data. A block index is a logical index in units of <code>512</code> KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/<code>524288</code>). The logical offset of the data must be <code>512</code> KiB aligned.</p>",
"location":"uri",
"locationName":"blockIndex"
},
"BlockToken":{
"shape":"BlockToken",
- "documentation":"<p>The block token of the block from which to get data.</p> <p>Obtain the <code>BlockToken</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
+ "documentation":"<p>The block token of the block from which to get data. You can obtain the <code>BlockToken</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
"location":"querystring",
"locationName":"blockToken"
}
@@ -532,7 +532,7 @@
"members":{
"SnapshotId":{
"shape":"SnapshotId",
- "documentation":"<p>The ID of the snapshot.</p>",
+ "documentation":"<p>The ID of the snapshot.</p> <important> <p>If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>..</p> </important>",
"location":"uri",
"locationName":"snapshotId"
},
@@ -607,7 +607,8 @@
"type":"string",
"enum":[
"ACCOUNT_THROTTLED",
- "DEPENDENCY_REQUEST_THROTTLED"
+ "DEPENDENCY_REQUEST_THROTTLED",
+ "RESOURCE_LEVEL_THROTTLE"
]
},
"ResourceNotFoundException":{
@@ -663,7 +664,7 @@
},
"ParentSnapshotId":{
"shape":"SnapshotId",
- "documentation":"<p>The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.</p> <p>If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopySnapshot.html\">CopySnapshot</a>.</p>"
+ "documentation":"<p>The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.</p> <p>You can't specify <b>ParentSnapshotId</b> and <b>Encrypted</b> in the same request. If you specify both parameters, the request fails with <code>ValidationException</code>.</p> <p>The encryption status of the snapshot depends on the values that you specify for <b>Encrypted</b>, <b>KmsKeyArn</b>, and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account is enabled for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default\"> encryption by default</a>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <important> <p>If you specify an encrypted parent snapshot, you must have permission to use the KMS key that was used to encrypt the parent snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions\"> Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important>"
},
"Tags":{
"shape":"Tags",
@@ -680,11 +681,11 @@
},
"Encrypted":{
"shape":"Boolean",
- "documentation":"<p>Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify <code>true</code>. To create an unencrypted snapshot, omit this parameter.</p> <p>If you specify a value for <b>ParentSnapshotId</b>, omit this parameter.</p> <p>If you specify <code>true</code>, the snapshot is encrypted using the KMS key specified using the <b>KmsKeyArn</b> parameter. If no value is specified for <b>KmsKeyArn</b>, the default KMS key for your account is used. If no default KMS key has been specified for your account, the Amazon Web Services managed KMS key is used. To set a default KMS key for your account, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html\"> ModifyEbsDefaultKmsKeyId</a>.</p> <p>If your account is enabled for encryption by default, you cannot set this parameter to <code>false</code>. In this case, you can omit this parameter.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
+ "documentation":"<p>Indicates whether to encrypt the snapshot.</p> <p>You can't specify <b>Encrypted</b> and <b> ParentSnapshotId</b> in the same request. If you specify both parameters, the request fails with <code>ValidationException</code>.</p> <p>The encryption status of the snapshot depends on the values that you specify for <b>Encrypted</b>, <b>KmsKeyArn</b>, and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account is enabled for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default\"> encryption by default</a>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <important> <p>To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions\"> Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important>"
},
"KmsKeyArn":{
"shape":"KmsKeyArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot. If you do not specify a KMS key, the default Amazon Web Services managed KMS key is used.</p> <p>If you specify a <b>ParentSnapshotId</b>, omit this parameter; the snapshot will be encrypted using the same KMS key that was used to encrypt the parent snapshot.</p> <p>If <b>Encrypted</b> is set to <code>true</code>, you must specify a KMS key ARN. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.</p> <p>The encryption status of the snapshot depends on the values that you specify for <b>Encrypted</b>, <b>KmsKeyArn</b>, and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account is enabled for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default\"> encryption by default</a>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <important> <p>To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions\"> Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important>"
},
"Timeout":{
"shape":"Timeout",
@@ -768,7 +769,7 @@
"TagValue":{
"type":"string",
"max":255,
- "pattern":"^[\\S\\s]+$"
+ "pattern":"^[\\S\\s]*$"
},
"Tags":{
"type":"list",
@@ -777,7 +778,7 @@
"TimeStamp":{"type":"timestamp"},
"Timeout":{
"type":"integer",
- "max":60,
+ "max":4320,
"min":10
},
"ValidationException":{
@@ -806,7 +807,8 @@
"INVALID_TAG",
"INVALID_DEPENDENCY_REQUEST",
"INVALID_PARAMETER_VALUE",
- "INVALID_VOLUME_SIZE"
+ "INVALID_VOLUME_SIZE",
+ "CONFLICTING_BLOCK_UPDATE"
]
},
"VolumeSize":{
diff --git a/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json b/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json
index 34dc719ac4..ce669bdd6f 100644
--- a/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json
@@ -586,7 +586,7 @@
},
"input":{"shape":"CreateFleetRequest"},
"output":{"shape":"CreateFleetResult"},
- "documentation":"<p>Launches an EC2 Fleet.</p> <p>You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html\">Launching an EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
+ "documentation":"<p>Launches an EC2 Fleet.</p> <p>You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html\">EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
},
"CreateFlowLogs":{
"name":"CreateFlowLogs",
@@ -1241,7 +1241,7 @@
},
"input":{"shape":"DeleteFleetsRequest"},
"output":{"shape":"DeleteFleetsResult"},
- "documentation":"<p>Deletes the specified EC2 Fleet.</p> <p>After you delete an EC2 Fleet, it launches no new instances.</p> <p>You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the <code>deleted_terminating</code> state. Otherwise, the EC2 Fleet enters the <code>deleted_running</code> state, and the instances continue to run until they are interrupted or you terminate them manually.</p> <p>For <code>instant</code> fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted <code>instant</code> fleet with running instances is not supported.</p> <p class=\"title\"> <b>Restrictions</b> </p> <ul> <li> <p>You can delete up to 25 <code>instant</code> fleets in a single request. If you exceed this number, no <code>instant</code> fleets are deleted and an error is returned. There is no restriction on the number of fleets of type <code>maintain</code> or <code>request</code> that can be deleted in a single request.</p> </li> <li> <p>Up to 1000 instances can be terminated in a single request to delete <code>instant</code> fleets.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet\">Deleting an EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
+ "documentation":"<p>Deletes the specified EC2 Fleet.</p> <p>After you delete an EC2 Fleet, it launches no new instances.</p> <p>You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the <code>deleted_terminating</code> state. Otherwise, the EC2 Fleet enters the <code>deleted_running</code> state, and the instances continue to run until they are interrupted or you terminate them manually.</p> <p>For <code>instant</code> fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted <code>instant</code> fleet with running instances is not supported.</p> <p class=\"title\"> <b>Restrictions</b> </p> <ul> <li> <p>You can delete up to 25 <code>instant</code> fleets in a single request. If you exceed this number, no <code>instant</code> fleets are deleted and an error is returned. There is no restriction on the number of fleets of type <code>maintain</code> or <code>request</code> that can be deleted in a single request.</p> </li> <li> <p>Up to 1000 instances can be terminated in a single request to delete <code>instant</code> fleets.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet\">Delete an EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
},
"DeleteFlowLogs":{
"name":"DeleteFlowLogs",
@@ -1822,7 +1822,7 @@
},
"input":{"shape":"DeregisterInstanceEventNotificationAttributesRequest"},
"output":{"shape":"DeregisterInstanceEventNotificationAttributesResult"},
- "documentation":"<p>c</p> <p>Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.</p>"
+ "documentation":"<p>Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.</p>"
},
"DeregisterTransitGatewayMulticastGroupMembers":{
"name":"DeregisterTransitGatewayMulticastGroupMembers",
@@ -2122,7 +2122,7 @@
},
"input":{"shape":"DescribeFleetInstancesRequest"},
"output":{"shape":"DescribeFleetInstancesResult"},
- "documentation":"<p>Describes the running instances for the specified EC2 Fleet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html#monitor-ec2-fleet\">Monitoring your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
+ "documentation":"<p>Describes the running instances for the specified EC2 Fleet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet\">Monitor your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
},
"DescribeFleets":{
"name":"DescribeFleets",
@@ -2132,7 +2132,7 @@
},
"input":{"shape":"DescribeFleetsRequest"},
"output":{"shape":"DescribeFleetsResult"},
- "documentation":"<p>Describes the specified EC2 Fleets or all of your EC2 Fleets.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html#monitor-ec2-fleet\">Monitoring your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
+ "documentation":"<p>Describes the specified EC2 Fleets or all of your EC2 Fleets.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet\">Monitor your EC2 Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p>"
},
"DescribeFlowLogs":{
"name":"DescribeFlowLogs",
@@ -4535,7 +4535,7 @@
},
"input":{"shape":"MonitorInstancesRequest"},
"output":{"shape":"MonitorInstancesResult"},
- "documentation":"<p>Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html\">Monitor your instances using CloudWatch</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>To disable detailed monitoring, see .</p>"
+ "documentation":"<p>Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html\">Monitor your instances using CloudWatch</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>To disable detailed monitoring, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html\">UnmonitorInstances</a>.</p>"
},
"MoveAddressToVpc":{
"name":"MoveAddressToVpc",
@@ -4555,7 +4555,7 @@
},
"input":{"shape":"MoveByoipCidrToIpamRequest"},
"output":{"shape":"MoveByoipCidrToIpamResult"},
- "documentation":"<p>Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.</p>"
+ "documentation":"<p>Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.</p> <p>If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in <a href=\"/vpc/latest/ipam/tutorials-byoip-ipam.html\">Tutorial: BYOIP address CIDRs to IPAM</a>.</p>"
},
"ProvisionByoipCidr":{
"name":"ProvisionByoipCidr",
@@ -4575,7 +4575,7 @@
},
"input":{"shape":"ProvisionIpamPoolCidrRequest"},
"output":{"shape":"ProvisionIpamPoolCidrResult"},
- "documentation":"<p>Provision a CIDR to an IPAM pool. You can use thsi action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.</p> <p>For more information, see <a href=\"/vpc/latest/ipam/prov-cidr-ipam.html\">Provision CIDRs to pools</a> in the <i>Amazon VPC IPAM User Guide</i>. </p>"
+ "documentation":"<p>Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.</p> <p>For more information, see <a href=\"/vpc/latest/ipam/prov-cidr-ipam.html\">Provision CIDRs to pools</a> in the <i>Amazon VPC IPAM User Guide</i>. </p>"
},
"ProvisionPublicIpv4PoolCidr":{
"name":"ProvisionPublicIpv4PoolCidr",
@@ -4585,7 +4585,7 @@
},
"input":{"shape":"ProvisionPublicIpv4PoolCidrRequest"},
"output":{"shape":"ProvisionPublicIpv4PoolCidrResult"},
- "documentation":"<p>Provision a CIDR to a public IPv4 pool.</p> <p>For more information about IPAM, see <a href=\"/vpc/latest/ipam/what-is-it-ipam.html\">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>. </p>"
+ "documentation":"<p>Provision a CIDR to a public IPv4 pool.</p> <p>For more information about IPAM, see <a href=\"/vpc/latest/ipam/what-is-it-ipam.html\">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"
},
"PurchaseHostReservation":{
"name":"PurchaseHostReservation",
@@ -4644,7 +4644,7 @@
},
"input":{"shape":"RegisterInstanceEventNotificationAttributesRequest"},
"output":{"shape":"RegisterInstanceEventNotificationAttributesResult"},
- "documentation":"<p>Registers a set of tag keys to include in scheduled event notifications for your resources. </p> <p>To remove tags, use .</p>"
+ "documentation":"<p>Registers a set of tag keys to include in scheduled event notifications for your resources. </p> <p>To remove tags, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html\">DeregisterInstanceEventNotificationAttributes</a>.</p>"
},
"RegisterTransitGatewayMulticastGroupMembers":{
"name":"RegisterTransitGatewayMulticastGroupMembers",
@@ -5666,6 +5666,29 @@
},
"documentation":"<p>An entry for a prefix list.</p>"
},
+ "AdditionalDetail":{
+ "type":"structure",
+ "members":{
+ "AdditionalDetailType":{
+ "shape":"String",
+ "documentation":"<p>The information type.</p>",
+ "locationName":"additionalDetailType"
+ },
+ "Component":{
+ "shape":"AnalysisComponent",
+ "documentation":"<p>The path component.</p>",
+ "locationName":"component"
+ }
+ },
+ "documentation":"<p>Describes an additional detail for a path analysis.</p>"
+ },
+ "AdditionalDetailList":{
+ "type":"list",
+ "member":{
+ "shape":"AdditionalDetail",
+ "locationName":"item"
+ }
+ },
"Address":{
"type":"structure",
"members":{
@@ -6282,7 +6305,7 @@
},
"Origin":{
"shape":"String",
- "documentation":"<p>Describes how the route was created. The following are possible values:</p> <ul> <li> <p> <code>CreateRouteTable</code> - The route was automatically created when the route table was created.</p> </li> <li> <p> <code>CreateRoute</code> - The route was manually added to the route table.</p> </li> <li> <p> <code>EnableVgwRoutePropagation</code> - The route was propagated by route propagation.</p> </li> </ul>",
+ "documentation":"<p>Describes how the route was created. The following are the possible values:</p> <ul> <li> <p>CreateRouteTable - The route was automatically created when the route table was created.</p> </li> <li> <p>CreateRoute - The route was manually added to the route table.</p> </li> <li> <p>EnableVgwRoutePropagation - The route was propagated by route propagation.</p> </li> </ul>",
"locationName":"origin"
},
"TransitGatewayId":{
@@ -6308,7 +6331,7 @@
},
"Direction":{
"shape":"String",
- "documentation":"<p>The direction. The following are possible values:</p> <ul> <li> <p>egress</p> </li> <li> <p>ingress</p> </li> </ul>",
+ "documentation":"<p>The direction. The following are the possible values:</p> <ul> <li> <p>egress</p> </li> <li> <p>ingress</p> </li> </ul>",
"locationName":"direction"
},
"SecurityGroupId":{
@@ -7599,7 +7622,7 @@
"members":{
"State":{
"shape":"AvailabilityZoneState",
- "documentation":"<p>The state of the Availability Zone, Local Zone, or Wavelength Zone.</p>",
+ "documentation":"<p>The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always <code>available</code>.</p>",
"locationName":"zoneState"
},
"OptInStatus":{
@@ -9627,7 +9650,7 @@
"type":"structure",
"members":{
"PoolId":{
- "shape":"CoipPoolId",
+ "shape":"Ipv4PoolCoipId",
"documentation":"<p>The ID of the address pool.</p>",
"locationName":"poolId"
},
@@ -9658,7 +9681,7 @@
"CoipPoolIdSet":{
"type":"list",
"member":{
- "shape":"CoipPoolId",
+ "shape":"Ipv4PoolCoipId",
"locationName":"item"
}
},
@@ -10676,12 +10699,12 @@
},
"ErrorCode":{
"shape":"String",
- "documentation":"<p>The error code that indicates why the instance could not be launched. For more information about error codes, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error Codes</a>.</p>",
+ "documentation":"<p>The error code that indicates why the instance could not be launched. For more information about error codes, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error codes</a>.</p>",
"locationName":"errorCode"
},
"ErrorMessage":{
"shape":"String",
- "documentation":"<p>The error message that describes why the instance could not be launched. For more information about error messages, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error Codes</a>.</p>",
+ "documentation":"<p>The error message that describes why the instance could not be launched. For more information about error messages, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error codes</a>.</p>",
"locationName":"errorMessage"
}
},
@@ -10745,7 +10768,7 @@
},
"ClientToken":{
"shape":"String",
- "documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring Idempotency</a>.</p>"
+ "documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a>.</p>"
},
"SpotOptions":{
"shape":"SpotOptionsRequest",
@@ -10773,7 +10796,7 @@
},
"Type":{
"shape":"FleetType",
- "documentation":"<p>The fleet type. The default value is <code>maintain</code>.</p> <ul> <li> <p> <code>maintain</code> - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.</p> </li> <li> <p> <code>request</code> - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.</p> </li> <li> <p> <code>instant</code> - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/ec2-fleet-request-type.html\">EC2 Fleet request types</a> in the <i>Amazon EC2 User Guide</i>.</p>"
+ "documentation":"<p>The fleet type. The default value is <code>maintain</code>.</p> <ul> <li> <p> <code>maintain</code> - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.</p> </li> <li> <p> <code>request</code> - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.</p> </li> <li> <p> <code>instant</code> - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html\">EC2 Fleet request types</a> in the <i>Amazon EC2 User Guide</i>.</p>"
},
"ValidFrom":{
"shape":"DateTime",
@@ -11115,7 +11138,10 @@
},
"CreateIpamPoolRequest":{
"type":"structure",
- "required":["IpamScopeId"],
+ "required":[
+ "IpamScopeId",
+ "AddressFamily"
+ ],
"members":{
"DryRun":{
"shape":"Boolean",
@@ -11862,7 +11888,7 @@
},
"InterfaceType":{
"shape":"NetworkInterfaceCreationType",
- "documentation":"<p>Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify <code>efa</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html\"> Elastic Fabric Adapter</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. To create a trunk network interface, specify <code>trunk</code>.</p>"
+ "documentation":"<p>The type of network interface. The default is <code>interface</code>.</p> <p>The only supported values are <code>efa</code> and <code>trunk</code>.</p>"
},
"SubnetId":{
"shape":"SubnetId",
@@ -14142,6 +14168,10 @@
"IpamId":{
"shape":"IpamId",
"documentation":"<p>The ID of the IPAM to delete.</p>"
+ },
+ "Cascade":{
+ "shape":"Boolean",
+ "documentation":"<p>Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:</p> <ul> <li> <p>Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.</p> <note> <p>No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.</p> </note> </li> <li> <p>Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.</p> </li> <li> <p>Deletes all IPAM pools in private scopes.</p> </li> <li> <p>Deletes all non-default private scopes in the IPAM.</p> </li> <li> <p>Deletes the default public and private scopes and the IPAM.</p> </li> </ul>"
}
}
},
@@ -15718,7 +15748,7 @@
"members":{
"Filters":{
"shape":"FilterList",
- "documentation":"<p>The filters.</p> <ul> <li> <p> <code>group-name</code> - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, <code>us-west-2-lax-1</code>) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>message</code> - The Zone message.</p> </li> <li> <p> <code>opt-in-status</code> - The opt-in status (<code>opted-in</code>, and <code>not-opted-in</code> | <code>opt-in-not-required</code>).</p> </li> <li> <p> <code>parent-zoneID</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>parent-zoneName</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>region-name</code> - The name of the Region for the Zone (for example, <code>us-east-1</code>).</p> </li> <li> <p> <code>state</code> - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (<code>available</code> | <code>information</code> | <code>impaired</code> | <code>unavailable</code>).</p> </li> <li> <p> <code>zone-id</code> - The ID of the Availability Zone (for example, <code>use1-az1</code>), the Local Zone (for example, <code>usw2-lax1-az1</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-type</code> - The type of zone, for example, <code>local-zone</code>.</p> </li> <li> <p> <code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>), the Local Zone (for example, <code>us-west-2-lax-1a</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-type</code> - The type of zone, for example, <code>local-zone</code>.</p> </li> </ul>",
+ "documentation":"<p>The filters.</p> <ul> <li> <p> <code>group-name</code> - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, <code>us-west-2-lax-1</code>) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>message</code> - The Zone message.</p> </li> <li> <p> <code>opt-in-status</code> - The opt-in status (<code>opted-in</code>, and <code>not-opted-in</code> | <code>opt-in-not-required</code>).</p> </li> <li> <p> <code>parent-zoneID</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>parent-zoneName</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>region-name</code> - The name of the Region for the Zone (for example, <code>us-east-1</code>).</p> </li> <li> <p> <code>state</code> - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (<code>available</code>).</p> </li> <li> <p> <code>zone-id</code> - The ID of the Availability Zone (for example, <code>use1-az1</code>), the Local Zone (for example, <code>usw2-lax1-az1</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-type</code> - The type of zone, for example, <code>local-zone</code>.</p> </li> <li> <p> <code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>), the Local Zone (for example, <code>us-west-2-lax-1a</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-type</code> - The type of zone, for example, <code>local-zone</code>.</p> </li> </ul>",
"locationName":"Filter"
},
"ZoneNames":{
@@ -15890,7 +15920,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>instance-type</code> - The type of instance for which the Capacity Reservation reserves capacity.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the Capacity Reservation.</p> </li> <li> <p> <code>instance-platform</code> - The type of operating system for which the Capacity Reservation reserves capacity.</p> </li> <li> <p> <code>availability-zone</code> - The Availability Zone of the Capacity Reservation.</p> </li> <li> <p> <code>tenancy</code> - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.</p> </li> <li> <p> <code>state</code> - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code>- The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul> </li> <li> <p> <code>start-date</code> - The date and time at which the Capacity Reservation was started.</p> </li> <li> <p> <code>end-date</code> - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.</p> </li> <li> <p> <code>end-date-type</code> - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p> <ul> <li> <p> <code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p> </li> <li> <p> <code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p> </li> </ul> </li> <li> <p> <code>instance-match-criteria</code> - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p> <ul> <li> <p> <code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p> </li> <li> <p> <code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.</p> </li> </ul> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>instance-type</code> - The type of instance for which the Capacity Reservation reserves capacity.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the Capacity Reservation.</p> </li> <li> <p> <code>instance-platform</code> - The type of operating system for which the Capacity Reservation reserves capacity.</p> </li> <li> <p> <code>availability-zone</code> - The Availability Zone of the Capacity Reservation.</p> </li> <li> <p> <code>tenancy</code> - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:</p> <ul> <li> <p> <code>default</code> - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.</p> </li> <li> <p> <code>dedicated</code> - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p> </li> </ul> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.</p> </li> <li> <p> <code>state</code> - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code>- The Capacity Reservation is active and the capacity is available for your use.</p> </li> <li> <p> <code>expired</code> - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.</p> </li> </ul> </li> <li> <p> <code>start-date</code> - The date and time at which the Capacity Reservation was started.</p> </li> <li> <p> <code>end-date</code> - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.</p> </li> <li> <p> <code>end-date-type</code> - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:</p> <ul> <li> <p> <code>unlimited</code> - The Capacity Reservation remains active until you explicitly cancel it.</p> </li> <li> <p> <code>limited</code> - The Capacity Reservation expires automatically at a specified date and time.</p> </li> </ul> </li> <li> <p> <code>instance-match-criteria</code> - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:</p> <ul> <li> <p> <code>open</code> - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.</p> </li> <li> <p> <code>targeted</code> - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.</p> </li> </ul> </li> <li> <p> <code>placement-group-arn</code> - The ARN of the cluster placement group in which the Capacity Reservation was created.</p> </li> </ul>",
"locationName":"Filter"
},
"DryRun":{
@@ -16255,7 +16285,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>The filters. The following are the possible values:</p> <ul> <li> <p> <code>coip-pool.pool-id</code> </p> </li> </ul> <ul> <li> <p> <code>coip-pool.local-gateway-route-table-id</code> </p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>coip-pool.local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>coip-pool.pool-id</code> - The ID of the address pool.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -16800,12 +16830,12 @@
},
"ErrorCode":{
"shape":"String",
- "documentation":"<p>The error code that indicates why the instance could not be launched. For more information about error codes, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error Codes</a>.</p>",
+ "documentation":"<p>The error code that indicates why the instance could not be launched. For more information about error codes, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error codes</a>.</p>",
"locationName":"errorCode"
},
"ErrorMessage":{
"shape":"String",
- "documentation":"<p>The error message that describes why the instance could not be launched. For more information about error messages, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error Codes</a>.</p>",
+ "documentation":"<p>The error message that describes why the instance could not be launched. For more information about error messages, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html\">Error codes</a>.</p>",
"locationName":"errorMessage"
}
},
@@ -16983,7 +17013,7 @@
},
"FleetIds":{
"shape":"FleetIdSet",
- "documentation":"<p>The ID of the EC2 Fleets.</p>",
+ "documentation":"<p>The IDs of the EC2 Fleets.</p> <note> <p>If a fleet is of type <code>instant</code>, you must specify the fleet ID, otherwise it does not appear in the response.</p> </note>",
"locationName":"FleetId"
},
"Filters":{
@@ -17730,7 +17760,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters. Filter names and values are case-sensitive.</p> <ul> <li> <p> <code>auto-recovery-supported</code> - Indicates whether auto recovery is supported (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>bare-metal</code> - Indicates whether it is a bare metal instance type (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>burstable-performance-supported</code> - Indicates whether it is a burstable performance instance type (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>current-generation</code> - Indicates whether this instance type is the latest generation instance type of an instance family (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps</code> - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.baseline-iops</code> - The baseline input/output storage operations per second for an EBS-optimized instance type.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.baseline-throughput-in-mbps</code> - The baseline throughput performance for an EBS-optimized instance type, in MB/s.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps</code> - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.maximum-iops</code> - The maximum input/output storage operations per second for an EBS-optimized instance type.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.maximum-throughput-in-mbps</code> - The maximum throughput performance for an EBS-optimized instance type, in MB/s.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-support</code> - Indicates whether the instance type is EBS-optimized (<code>supported</code> | <code>unsupported</code> | <code>default</code>).</p> </li> <li> <p> <code>ebs-info.encryption-support</code> - Indicates whether EBS encryption is supported (<code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>ebs-info.nvme-support</code> - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>free-tier-eligible</code> - Indicates whether the instance type is eligible to use in the free tier (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>hibernation-supported</code> - Indicates whether On-Demand hibernation is supported (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor (<code>nitro</code> | <code>xen</code>).</p> </li> <li> <p> <code>instance-storage-info.disk.count</code> - The number of local disks.</p> </li> <li> <p> <code>instance-storage-info.disk.size-in-gb</code> - The storage size of each instance storage disk, in GB.</p> </li> <li> <p> <code>instance-storage-info.disk.type</code> - The storage technology for the local instance storage disks (<code>hdd</code> | <code>ssd</code>).</p> </li> <li> <p> <code>instance-storage-info.encryption-supported</code> - Indicates whether data is encrypted at rest (<code>required</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>instance-storage-info.nvme-support</code> - Indicates whether non-volatile memory express (NVMe) is supported for instance store (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>instance-storage-info.total-size-in-gb</code> - The total amount of storage available from all local instance storage, in GB.</p> </li> <li> <p> <code>instance-storage-supported</code> - Indicates whether the instance type has local instance storage (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>instance-type</code> - The instance type (for example <code>c5.2xlarge</code> or c5*).</p> </li> <li> <p> <code>memory-info.size-in-mib</code> - The memory size.</p> </li> <li> <p> <code>network-info.efa-info.maximum-efa-interfaces</code> - The maximum number of Elastic Fabric Adapters (EFAs) per instance.</p> </li> <li> <p> <code>network-info.efa-supported</code> - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>network-info.ena-support</code> - Indicates whether Elastic Network Adapter (ENA) is supported or required (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>network-info.encryption-in-transit-supported</code> - Indicates whether the instance type automatically encrypts in-transit traffic between instances (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>network-info.ipv4-addresses-per-interface</code> - The maximum number of private IPv4 addresses per network interface.</p> </li> <li> <p> <code>network-info.ipv6-addresses-per-interface</code> - The maximum number of private IPv6 addresses per network interface.</p> </li> <li> <p> <code>network-info.ipv6-supported</code> - Indicates whether the instance type supports IPv6 (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>network-info.maximum-network-interfaces</code> - The maximum number of network interfaces per instance.</p> </li> <li> <p> <code>network-info.network-performance</code> - The network performance (for example, \"25 Gigabit\").</p> </li> <li> <p> <code>processor-info.supported-architecture</code> - The CPU architecture (<code>arm64</code> | <code>i386</code> | <code>x86_64</code>).</p> </li> <li> <p> <code>processor-info.sustained-clock-speed-in-ghz</code> - The CPU clock speed, in GHz.</p> </li> <li> <p> <code>supported-boot-mode</code> - The boot mode (<code>legacy-bios</code> | <code>uefi</code>).</p> </li> <li> <p> <code>supported-root-device-type</code> - The root device type (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p> <code>supported-usage-class</code> - The usage class (<code>on-demand</code> | <code>spot</code>).</p> </li> <li> <p> <code>supported-virtualization-type</code> - The virtualization type (<code>hvm</code> | <code>paravirtual</code>).</p> </li> <li> <p> <code>vcpu-info.default-cores</code> - The default number of cores for the instance type.</p> </li> <li> <p> <code>vcpu-info.default-threads-per-core</code> - The default number of threads per core for the instance type.</p> </li> <li> <p> <code>vcpu-info.default-vcpus</code> - The default number of vCPUs for the instance type.</p> </li> <li> <p> <code>vcpu-info.valid-cores</code> - The number of cores that can be configured for the instance type.</p> </li> <li> <p> <code>vcpu-info.valid-threads-per-core</code> - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".</p> </li> </ul>",
+ "documentation":"<p>One or more filters. Filter names and values are case-sensitive.</p> <ul> <li> <p> <code>auto-recovery-supported</code> - Indicates whether auto recovery is supported (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>bare-metal</code> - Indicates whether it is a bare metal instance type (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>burstable-performance-supported</code> - Indicates whether it is a burstable performance instance type (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>current-generation</code> - Indicates whether this instance type is the latest generation instance type of an instance family (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps</code> - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.baseline-iops</code> - The baseline input/output storage operations per second for an EBS-optimized instance type.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.baseline-throughput-in-mbps</code> - The baseline throughput performance for an EBS-optimized instance type, in MB/s.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps</code> - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.maximum-iops</code> - The maximum input/output storage operations per second for an EBS-optimized instance type.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-info.maximum-throughput-in-mbps</code> - The maximum throughput performance for an EBS-optimized instance type, in MB/s.</p> </li> <li> <p> <code>ebs-info.ebs-optimized-support</code> - Indicates whether the instance type is EBS-optimized (<code>supported</code> | <code>unsupported</code> | <code>default</code>).</p> </li> <li> <p> <code>ebs-info.encryption-support</code> - Indicates whether EBS encryption is supported (<code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>ebs-info.nvme-support</code> - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>free-tier-eligible</code> - Indicates whether the instance type is eligible to use in the free tier (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>hibernation-supported</code> - Indicates whether On-Demand hibernation is supported (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>hypervisor</code> - The hypervisor (<code>nitro</code> | <code>xen</code>).</p> </li> <li> <p> <code>instance-storage-info.disk.count</code> - The number of local disks.</p> </li> <li> <p> <code>instance-storage-info.disk.size-in-gb</code> - The storage size of each instance storage disk, in GB.</p> </li> <li> <p> <code>instance-storage-info.disk.type</code> - The storage technology for the local instance storage disks (<code>hdd</code> | <code>ssd</code>).</p> </li> <li> <p> <code>instance-storage-info.encryption-support</code> - Indicates whether data is encrypted at rest (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>instance-storage-info.nvme-support</code> - Indicates whether non-volatile memory express (NVMe) is supported for instance store (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>instance-storage-info.total-size-in-gb</code> - The total amount of storage available from all local instance storage, in GB.</p> </li> <li> <p> <code>instance-storage-supported</code> - Indicates whether the instance type has local instance storage (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>instance-type</code> - The instance type (for example <code>c5.2xlarge</code> or c5*).</p> </li> <li> <p> <code>memory-info.size-in-mib</code> - The memory size.</p> </li> <li> <p> <code>network-info.efa-info.maximum-efa-interfaces</code> - The maximum number of Elastic Fabric Adapters (EFAs) per instance.</p> </li> <li> <p> <code>network-info.efa-supported</code> - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>network-info.ena-support</code> - Indicates whether Elastic Network Adapter (ENA) is supported or required (<code>required</code> | <code>supported</code> | <code>unsupported</code>).</p> </li> <li> <p> <code>network-info.encryption-in-transit-supported</code> - Indicates whether the instance type automatically encrypts in-transit traffic between instances (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>network-info.ipv4-addresses-per-interface</code> - The maximum number of private IPv4 addresses per network interface.</p> </li> <li> <p> <code>network-info.ipv6-addresses-per-interface</code> - The maximum number of private IPv6 addresses per network interface.</p> </li> <li> <p> <code>network-info.ipv6-supported</code> - Indicates whether the instance type supports IPv6 (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>network-info.maximum-network-cards</code> - The maximum number of network cards per instance.</p> </li> <li> <p> <code>network-info.maximum-network-interfaces</code> - The maximum number of network interfaces per instance.</p> </li> <li> <p> <code>network-info.network-performance</code> - The network performance (for example, \"25 Gigabit\").</p> </li> <li> <p> <code>processor-info.supported-architecture</code> - The CPU architecture (<code>arm64</code> | <code>i386</code> | <code>x86_64</code>).</p> </li> <li> <p> <code>processor-info.sustained-clock-speed-in-ghz</code> - The CPU clock speed, in GHz.</p> </li> <li> <p> <code>supported-boot-mode</code> - The boot mode (<code>legacy-bios</code> | <code>uefi</code>).</p> </li> <li> <p> <code>supported-root-device-type</code> - The root device type (<code>ebs</code> | <code>instance-store</code>).</p> </li> <li> <p> <code>supported-usage-class</code> - The usage class (<code>on-demand</code> | <code>spot</code>).</p> </li> <li> <p> <code>supported-virtualization-type</code> - The virtualization type (<code>hvm</code> | <code>paravirtual</code>).</p> </li> <li> <p> <code>vcpu-info.default-cores</code> - The default number of cores for the instance type.</p> </li> <li> <p> <code>vcpu-info.default-threads-per-core</code> - The default number of threads per core for the instance type.</p> </li> <li> <p> <code>vcpu-info.default-vcpus</code> - The default number of vCPUs for the instance type.</p> </li> <li> <p> <code>vcpu-info.valid-cores</code> - The number of cores that can be configured for the instance type.</p> </li> <li> <p> <code>vcpu-info.valid-threads-per-core</code> - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18174,7 +18204,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-virtual-interface-group-association-id</code> - The ID of the association.</p> </li> <li> <p> <code>local-gateway-route-table-virtual-interface-group-id</code> - The ID of the virtual interface group.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-virtual-interface-group-association-id</code> - The ID of the association.</p> </li> <li> <p> <code>local-gateway-route-table-virtual-interface-group-id</code> - The ID of the virtual interface group.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18216,7 +18246,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-vpc-association-id</code> - The ID of the association.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC.</p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the local gateway route table for the association.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-vpc-association-id</code> - The ID of the association.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway route table for the association.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18258,7 +18288,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of a local gateway route table.</p> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p> </li> <li> <p> <code>state</code> - The state of the local gateway route table.</p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-arn</code> - The Amazon Resource Name (ARN) of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of a local gateway route table.</p> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway route table.</p> </li> <li> <p> <code>state</code> - The state of the local gateway route table.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18300,7 +18330,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-virtual-interface-id</code> - The ID of the virtual interface.</p> </li> <li> <p> <code>local-gateway-virtual-interface-group-id</code> - The ID of the virtual interface group.</p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-virtual-interface-group-id</code> - The ID of the virtual interface group.</p> </li> <li> <p> <code>local-gateway-virtual-interface-id</code> - The ID of the virtual interface.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18342,7 +18372,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-address</code> - The local address.</p> </li> <li> <p> <code>local-bgp-asn</code> - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.</p> </li> <li> <p> <code>local-gateway-id</code> - The ID of the local gateway.</p> </li> <li> <p> <code>local-gateway-virtual-interface-id</code> - The ID of the virtual interface.</p> </li> <li> <p> <code>local-gateway-virtual-interface-group-id</code> - The ID of the virtual interface group.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway virtual interface.</p> </li> <li> <p> <code>peer-address</code> - The peer address.</p> </li> <li> <p> <code>peer-bgp-asn</code> - The peer BGP ASN.</p> </li> <li> <p> <code>vlan</code> - The ID of the VLAN.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18379,12 +18409,12 @@
"members":{
"LocalGatewayIds":{
"shape":"LocalGatewayIdSet",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>local-gateway-route-table-virtual-interface-group-association-id</code> - The ID of the association.</p> </li> <li> <p> <code>local-gateway-route-table-virtual-interface-group-id</code> - The ID of the virtual interface group.</p> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> </ul>",
+ "documentation":"<p>The IDs of the local gateways.</p>",
"locationName":"LocalGatewayId"
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>local-gateway-id</code> - The ID of a local gateway.</p> </li> <li> <p> <code>outpost-arn</code> - The Amazon Resource Name (ARN) of the Outpost.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway.</p> </li> <li> <p> <code>state</code> - The state of the association.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18720,7 +18750,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>The filters. The following are possible values:</p> <ul> <li> <p>PathFound - A Boolean value that indicates whether a feasible path is found.</p> </li> <li> <p>Status - The status of the analysis (running | succeeded | failed).</p> </li> </ul>",
+ "documentation":"<p>The filters. The following are the possible values:</p> <ul> <li> <p>PathFound - A Boolean value that indicates whether a feasible path is found.</p> </li> <li> <p>Status - The status of the analysis (running | succeeded | failed).</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18762,7 +18792,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>The filters. The following are possible values:</p> <ul> <li> <p>Destination - The ID of the resource.</p> </li> <li> <p>DestinationPort - The destination port.</p> </li> <li> <p>Name - The path name.</p> </li> <li> <p>Protocol - The protocol.</p> </li> <li> <p>Source - The ID of the resource.</p> </li> </ul>",
+ "documentation":"<p>The filters. The following are the possible values:</p> <ul> <li> <p>Destination - The ID of the resource.</p> </li> <li> <p>DestinationPort - The destination port.</p> </li> <li> <p>Name - The path name.</p> </li> <li> <p>Protocol - The protocol.</p> </li> <li> <p>Source - The ID of the resource.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -18902,7 +18932,7 @@
"members":{
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>addresses.private-ip-address</code> - The private IPv4 addresses associated with the network interface.</p> </li> <li> <p> <code>addresses.primary</code> - Whether the private IPv4 address is the primary IP address associated with the network interface. </p> </li> <li> <p> <code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).</p> </li> <li> <p> <code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface.</p> </li> <li> <p> <code>association.association-id</code> - The association ID returned when the network interface was associated with an IPv4 address.</p> </li> <li> <p> <code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.</p> </li> <li> <p> <code>association.ip-owner-id</code> - The owner of the Elastic IP address (IPv4) associated with the network interface.</p> </li> <li> <p> <code>association.public-ip</code> - The address of the Elastic IP address (IPv4) bound to the network interface.</p> </li> <li> <p> <code>association.public-dns-name</code> - The public DNS name for the network interface (IPv4).</p> </li> <li> <p> <code>attachment.attachment-id</code> - The ID of the interface attachment.</p> </li> <li> <p> <code>attachment.attach-time</code> - The time that the network interface was attached to an instance.</p> </li> <li> <p> <code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated.</p> </li> <li> <p> <code>attachment.device-index</code> - The device index to which the network interface is attached.</p> </li> <li> <p> <code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</p> </li> <li> <p> <code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</p> </li> <li> <p> <code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p> </li> <li> <p> <code>availability-zone</code> - The Availability Zone of the network interface.</p> </li> <li> <p> <code>description</code> - The description of the network interface.</p> </li> <li> <p> <code>group-id</code> - The ID of a security group associated with the network interface.</p> </li> <li> <p> <code>group-name</code> - The name of a security group associated with the network interface.</p> </li> <li> <p> <code>ipv6-addresses.ipv6-address</code> - An IPv6 address associated with the network interface.</p> </li> <li> <p> <code>mac-address</code> - The MAC address of the network interface.</p> </li> <li> <p> <code>network-interface-id</code> - The ID of the network interface.</p> </li> <li> <p> <code>owner-id</code> - The Amazon Web Services account ID of the network interface owner.</p> </li> <li> <p> <code>private-ip-address</code> - The private IPv4 address or addresses of the network interface.</p> </li> <li> <p> <code>private-dns-name</code> - The private DNS name of the network interface (IPv4).</p> </li> <li> <p> <code>requester-id</code> - The alias or Amazon Web Services account ID of the principal or service that created the network interface.</p> </li> <li> <p> <code>requester-managed</code> - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).</p> </li> <li> <p> <code>source-dest-check</code> - Indicates whether the network interface performs source/destination checking. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the network interface to perform network address translation (NAT) in your VPC. </p> </li> <li> <p> <code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; if a network interface is attached to an instance the status is <code>in-use</code>.</p> </li> <li> <p> <code>subnet-id</code> - The ID of the subnet for the network interface.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC for the network interface.</p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>addresses.private-ip-address</code> - The private IPv4 addresses associated with the network interface.</p> </li> <li> <p> <code>addresses.primary</code> - Whether the private IPv4 address is the primary IP address associated with the network interface. </p> </li> <li> <p> <code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).</p> </li> <li> <p> <code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface.</p> </li> <li> <p> <code>association.association-id</code> - The association ID returned when the network interface was associated with an IPv4 address.</p> </li> <li> <p> <code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.</p> </li> <li> <p> <code>association.ip-owner-id</code> - The owner of the Elastic IP address (IPv4) associated with the network interface.</p> </li> <li> <p> <code>association.public-ip</code> - The address of the Elastic IP address (IPv4) bound to the network interface.</p> </li> <li> <p> <code>association.public-dns-name</code> - The public DNS name for the network interface (IPv4).</p> </li> <li> <p> <code>attachment.attachment-id</code> - The ID of the interface attachment.</p> </li> <li> <p> <code>attachment.attach-time</code> - The time that the network interface was attached to an instance.</p> </li> <li> <p> <code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated.</p> </li> <li> <p> <code>attachment.device-index</code> - The device index to which the network interface is attached.</p> </li> <li> <p> <code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</p> </li> <li> <p> <code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</p> </li> <li> <p> <code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p> </li> <li> <p> <code>availability-zone</code> - The Availability Zone of the network interface.</p> </li> <li> <p> <code>description</code> - The description of the network interface.</p> </li> <li> <p> <code>group-id</code> - The ID of a security group associated with the network interface.</p> </li> <li> <p> <code>group-name</code> - The name of a security group associated with the network interface.</p> </li> <li> <p> <code>ipv6-addresses.ipv6-address</code> - An IPv6 address associated with the network interface.</p> </li> <li> <p> <code>interface-type</code> - The type of network interface (<code>api_gateway_managed</code> | <code>aws_codestar_connections_managed</code> | <code>branch</code> | <code>efa</code> | <code>gateway_load_balancer</code> | <code>gateway_load_balancer_endpoint</code> | <code>global_accelerator_managed</code> | <code>interface</code> | <code>iot_rules_managed</code> | <code>lambda</code> | <code>load_balancer</code> | <code>nat_gateway</code> | <code>network_load_balancer</code> | <code>quicksight</code> | <code>transit_gateway</code> | <code>trunk</code> | <code>vpc_endpoint</code>).</p> </li> <li> <p> <code>mac-address</code> - The MAC address of the network interface.</p> </li> <li> <p> <code>network-interface-id</code> - The ID of the network interface.</p> </li> <li> <p> <code>owner-id</code> - The Amazon Web Services account ID of the network interface owner.</p> </li> <li> <p> <code>private-ip-address</code> - The private IPv4 address or addresses of the network interface.</p> </li> <li> <p> <code>private-dns-name</code> - The private DNS name of the network interface (IPv4).</p> </li> <li> <p> <code>requester-id</code> - The alias or Amazon Web Services account ID of the principal or service that created the network interface.</p> </li> <li> <p> <code>requester-managed</code> - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).</p> </li> <li> <p> <code>source-dest-check</code> - Indicates whether the network interface performs source/destination checking. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the network interface to perform network address translation (NAT) in your VPC. </p> </li> <li> <p> <code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; if a network interface is attached to an instance the status is <code>in-use</code>.</p> </li> <li> <p> <code>subnet-id</code> - The ID of the subnet for the network interface.</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC for the network interface.</p> </li> </ul>",
"locationName":"filter"
},
"DryRun":{
@@ -22728,7 +22758,7 @@
},
"Encrypted":{
"shape":"Boolean",
- "documentation":"<p>Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to <code>true</code> depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters\">Amazon EBS encryption</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances\">Supported instance types</a>.</p> <p>This parameter is not returned by .</p>",
+ "documentation":"<p>Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to <code>true</code> depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters\">Amazon EBS encryption</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances\">Supported instance types</a>.</p> <p>This parameter is not returned by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html\">DescribeImageAttribute</a>.</p>",
"locationName":"encrypted"
}
},
@@ -23766,7 +23796,7 @@
},
"Direction":{
"shape":"String",
- "documentation":"<p>The direction. The following are possible values:</p> <ul> <li> <p>egress</p> </li> <li> <p>ingress</p> </li> </ul>",
+ "documentation":"<p>The direction. The following are the possible values:</p> <ul> <li> <p>egress</p> </li> <li> <p>ingress</p> </li> </ul>",
"locationName":"direction"
},
"ExplanationCode":{
@@ -23933,6 +23963,26 @@
"shape":"AnalysisComponent",
"documentation":"<p>The VPN gateway.</p>",
"locationName":"vpnGateway"
+ },
+ "TransitGateway":{
+ "shape":"AnalysisComponent",
+ "documentation":"<p>The transit gateway.</p>",
+ "locationName":"transitGateway"
+ },
+ "TransitGatewayRouteTable":{
+ "shape":"AnalysisComponent",
+ "documentation":"<p>The transit gateway route table.</p>",
+ "locationName":"transitGatewayRouteTable"
+ },
+ "TransitGatewayRouteTableRoute":{
+ "shape":"TransitGatewayRouteTableRoute",
+ "documentation":"<p>The transit gateway route table route.</p>",
+ "locationName":"transitGatewayRouteTableRoute"
+ },
+ "TransitGatewayAttachment":{
+ "shape":"AnalysisComponent",
+ "documentation":"<p>The transit gateway attachment.</p>",
+ "locationName":"transitGatewayAttachment"
}
},
"documentation":"<p>Describes an explanation code for an unreachable path. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html\">Reachability Analyzer explanation codes</a>.</p>"
@@ -24659,7 +24709,7 @@
},
"ClientToken":{
"shape":"String",
- "documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring Idempotency</a>.</p> <p>Constraints: Maximum 64 ASCII characters</p>",
+ "documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a>.</p> <p>Constraints: Maximum 64 ASCII characters</p>",
"locationName":"clientToken"
},
"ExcessCapacityTerminationPolicy":{
@@ -25532,12 +25582,12 @@
"required":["PoolId"],
"members":{
"PoolId":{
- "shape":"CoipPoolId",
+ "shape":"Ipv4PoolCoipId",
"documentation":"<p>The ID of the address pool.</p>"
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>The filters. The following are the possible values:</p> <ul> <li> <p> <code>coip-address-usage.allocation-id</code> </p> </li> </ul> <ul> <li> <p> <code>coip-address-usage.aws-account-id</code> </p> </li> </ul> <ul> <li> <p> <code>coip-address-usage.aws-service</code> </p> </li> </ul> <ul> <li> <p> <code>coip-address-usage.co-ip</code> </p> </li> </ul>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>coip-address-usage.allocation-id</code> - The allocation ID of the address.</p> </li> <li> <p> <code>coip-address-usage.aws-account-id</code> - The ID of the Amazon Web Services account that is using the customer-owned IP address.</p> </li> <li> <p> <code>coip-address-usage.aws-service</code> - The Amazon Web Services service that is using the customer-owned IP address.</p> </li> <li> <p> <code>coip-address-usage.co-ip</code> - The customer-owned IP address.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -27665,7 +27715,13 @@
},
"BootMode":{
"shape":"AttributeValue",
+ "documentation":"<p>The boot mode.</p>",
"locationName":"bootMode"
+ },
+ "LastLaunchedTime":{
+ "shape":"AttributeValue",
+ "documentation":"<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used, there is a 24-hour delay before that usage is reported.</p> <note> <p> <code>lastLaunchedTime</code> data is available starting April 2017.</p> </note>",
+ "locationName":"lastLaunchedTime"
}
},
"documentation":"<p>Describes an image attribute.</p>"
@@ -27680,7 +27736,8 @@
"productCodes",
"blockDeviceMapping",
"sriovNetSupport",
- "bootMode"
+ "bootMode",
+ "lastLaunchedTime"
]
},
"ImageDiskContainer":{
@@ -29717,7 +29774,7 @@
},
"InterfaceType":{
"shape":"String",
- "documentation":"<p>Describes the type of network interface.</p> <p>Valid values: <code>interface</code> | <code>efa</code> | <code>trunk</code> </p>",
+ "documentation":"<p>The type of network interface.</p> <p>Valid values: <code>interface</code> | <code>efa</code> | <code>trunk</code> </p>",
"locationName":"interfaceType"
},
"Ipv4Prefixes":{
@@ -29878,7 +29935,7 @@
},
"InterfaceType":{
"shape":"String",
- "documentation":"<p>The type of network interface.</p> <p>To create an Elastic Fabric Adapter (EFA), specify <code>efa</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html\">Elastic Fabric Adapter</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Valid values: <code>interface</code> | <code>efa</code> </p>"
+ "documentation":"<p>The type of network interface.</p> <p>Valid values: <code>interface</code> | <code>efa</code> </p>"
},
"NetworkCardIndex":{
"shape":"Integer",
@@ -29980,12 +30037,12 @@
},
"SpotMaxPricePercentageOverLowestPrice":{
"shape":"Integer",
- "documentation":"<p>The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <p>Default: <code>100</code> </p>",
+ "documentation":"<p>The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <note> <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.</p> </note> <p>Default: <code>100</code> </p>",
"locationName":"spotMaxPricePercentageOverLowestPrice"
},
"OnDemandMaxPricePercentageOverLowestPrice":{
"shape":"Integer",
- "documentation":"<p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <p>Default: <code>20</code> </p>",
+ "documentation":"<p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <note> <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.</p> </note> <p>Default: <code>20</code> </p>",
"locationName":"onDemandMaxPricePercentageOverLowestPrice"
},
"BareMetal":{
@@ -30092,11 +30149,11 @@
},
"SpotMaxPricePercentageOverLowestPrice":{
"shape":"Integer",
- "documentation":"<p>The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <p>Default: <code>100</code> </p>"
+ "documentation":"<p>The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <note> <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.</p> </note> <p>Default: <code>100</code> </p>"
},
"OnDemandMaxPricePercentageOverLowestPrice":{
"shape":"Integer",
- "documentation":"<p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <p>Default: <code>20</code> </p>"
+ "documentation":"<p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.</p> <p>The parameter accepts an integer, which Amazon EC2 interprets as a percentage.</p> <p>To turn off price protection, specify a high value, such as <code>999999</code>.</p> <p>This parameter is not supported for <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html\">GetSpotPlacementScores</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html\">GetInstanceTypesFromInstanceRequirements</a>.</p> <note> <p>If you set <code>TargetCapacityUnitType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.</p> </note> <p>Default: <code>20</code> </p>"
},
"BareMetal":{
"shape":"BareMetal",
@@ -31999,7 +32056,7 @@
"locationName":"tagSet"
}
},
- "documentation":"<p>In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.</p> <p>For more information, see <a href=\"/vpc/latest/ipam/how-it-works-ipam.html\">How IPAM works</a> in the <i>Amazon VPC IPAM User Guide</i> </p>"
+ "documentation":"<p>In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.</p> <p>For more information, see <a href=\"/vpc/latest/ipam/how-it-works-ipam.html\">How IPAM works</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>"
},
"IpamScopeId":{"type":"string"},
"IpamScopeSet":{
@@ -32051,6 +32108,7 @@
"delete-failed"
]
},
+ "Ipv4PoolCoipId":{"type":"string"},
"Ipv4PoolEc2Id":{"type":"string"},
"Ipv4PrefixList":{
"type":"list",
@@ -33028,7 +33086,7 @@
},
"InstanceMetadataTags":{
"shape":"LaunchTemplateInstanceMetadataTagsState",
- "documentation":"<p> </p>",
+ "documentation":"<p>Set to <code>enabled</code> to allow access to instance tags from the instance metadata. Set to <code>disabled</code> to turn off access to instance tags from the instance metadata. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS\">Work with instance tags using the instance metadata</a>.</p> <p>Default: <code>disabled</code> </p>",
"locationName":"instanceMetadataTags"
}
},
@@ -33610,7 +33668,7 @@
"members":{
"ResourceType":{
"shape":"ResourceType",
- "documentation":"<p>The type of resource to tag. Currently, the resource types that support tagging on creation are <code>instance</code> and <code>volume</code>. To tag a resource after it has been created, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html\">CreateTags</a>.</p>"
+ "documentation":"<p>The type of resource to tag. Currently, the resource types that support tagging on creation are <code>instance</code>, <code>volume</code>, <code>elastic-gpu</code>, <code>network-interface</code>, and <code>spot-instances-request</code>. To tag a resource after it has been created, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html\">CreateTags</a>.</p>"
},
"Tags":{
"shape":"TagList",
@@ -38085,7 +38143,20 @@
"interface",
"natGateway",
"efa",
- "trunk"
+ "trunk",
+ "load_balancer",
+ "network_load_balancer",
+ "vpc_endpoint",
+ "branch",
+ "transit_gateway",
+ "lambda",
+ "quicksight",
+ "global_accelerator_managed",
+ "api_gateway_managed",
+ "gateway_load_balancer",
+ "gateway_load_balancer_endpoint",
+ "iot_rules_managed",
+ "aws_codestar_connections_managed"
]
},
"NetworkPerformance":{"type":"string"},
@@ -38401,6 +38472,20 @@
"shape":"AnalysisComponent",
"documentation":"<p>The component VPC.</p>",
"locationName":"vpc"
+ },
+ "AdditionalDetails":{
+ "shape":"AdditionalDetailList",
+ "documentation":"<p>The additional details.</p>",
+ "locationName":"additionalDetailSet"
+ },
+ "TransitGateway":{
+ "shape":"AnalysisComponent",
+ "locationName":"transitGateway"
+ },
+ "TransitGatewayRouteTableRoute":{
+ "shape":"TransitGatewayRouteTableRoute",
+ "documentation":"<p>The route in a transit gateway route table.</p>",
+ "locationName":"transitGatewayRouteTableRoute"
}
},
"documentation":"<p>Describes a path component.</p>"
@@ -40469,7 +40554,8 @@
"type":"structure",
"required":[
"IpamPoolId",
- "Cidr"
+ "Cidr",
+ "IpamPoolAllocationId"
],
"members":{
"DryRun":{
@@ -42188,6 +42274,7 @@
"spot-fleet-request",
"spot-instances-request",
"subnet",
+ "subnet-cidr-reservation",
"traffic-mirror-filter",
"traffic-mirror-session",
"traffic-mirror-target",
@@ -43826,7 +43913,7 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>One or more filters.</p>",
+ "documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>route-search.exact-match</code> - The exact match of the specified filter.</p> </li> <li> <p> <code>route-search.longest-prefix-match</code> - The longest prefix that matches the route.</p> </li> <li> <p> <code>route-search.subnet-of-match</code> - The routes with a subnet that match the specified CIDR filter.</p> </li> <li> <p> <code>route-search.supernet-of-match</code> - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify <code>supernet-of-match</code> as 10.0.1.0/30, then the result returns 10.0.1.0/29.</p> </li> <li> <p> <code>state</code> - The state of the route.</p> </li> <li> <p> <code>type</code> - The route type.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@@ -46427,7 +46514,7 @@
},
"Value":{
"shape":"String",
- "documentation":"<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.</p>",
+ "documentation":"<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>",
"locationName":"value"
}
},
@@ -48484,6 +48571,47 @@
"locationName":"item"
}
},
+ "TransitGatewayRouteTableRoute":{
+ "type":"structure",
+ "members":{
+ "DestinationCidr":{
+ "shape":"String",
+ "documentation":"<p>The CIDR block used for destination matches.</p>",
+ "locationName":"destinationCidr"
+ },
+ "State":{
+ "shape":"String",
+ "documentation":"<p>The state of the route.</p>",
+ "locationName":"state"
+ },
+ "RouteOrigin":{
+ "shape":"String",
+ "documentation":"<p>The route origin. The following are the possible values:</p> <ul> <li> <p>static</p> </li> <li> <p>propagated</p> </li> </ul>",
+ "locationName":"routeOrigin"
+ },
+ "PrefixListId":{
+ "shape":"String",
+ "documentation":"<p>The ID of the prefix list.</p>",
+ "locationName":"prefixListId"
+ },
+ "AttachmentId":{
+ "shape":"String",
+ "documentation":"<p>The ID of the route attachment.</p>",
+ "locationName":"attachmentId"
+ },
+ "ResourceId":{
+ "shape":"String",
+ "documentation":"<p>The ID of the resource for the route attachment.</p>",
+ "locationName":"resourceId"
+ },
+ "ResourceType":{
+ "shape":"String",
+ "documentation":"<p>The resource type for the route attachment.</p>",
+ "locationName":"resourceType"
+ }
+ },
+ "documentation":"<p>Describes a route in a transit gateway route table.</p>"
+ },
"TransitGatewayRouteTableState":{
"type":"string",
"enum":[
diff --git a/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/paginators-1.json b/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/paginators-1.json
index cf90801854..3db2db09a8 100644
--- a/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/paginators-1.json
@@ -29,7 +29,10 @@
"imageScanFindings"
],
"output_token": "nextToken",
- "result_key": "imageScanFindings.findings"
+ "result_key": [
+ "imageScanFindings.findings",
+ "imageScanFindings.enhancedFindings"
+ ]
},
"GetLifecyclePolicyPreview": {
"input_token": "nextToken",
diff --git a/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json b/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json
index eb275f5455..0d7f4cf779 100644
--- a/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json
@@ -503,7 +503,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Updates the image scanning configuration for the specified repository.</p>"
+ "documentation":"<important> <p>The <code>PutImageScanningConfiguration</code> API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see <a>PutRegistryScanningConfiguration</a>.</p> </important> <p>Updates the image scanning configuration for the specified repository.</p>"
},
"PutImageTagMutability":{
"name":"PutImageTagMutability",
@@ -1935,6 +1935,10 @@
"artifactMediaType":{
"shape":"MediaType",
"documentation":"<p>The artifact media type of the image.</p>"
+ },
+ "lastRecordedPullTime":{
+ "shape":"RecordedPullTimestamp",
+ "documentation":"<p>The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.</p> <note> <p>Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the <code>lastRecordedPullTime</code> timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the <code>lastRecordedPullTime</code> timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.</p> </note>"
}
},
"documentation":"<p>An object that describes an image returned by a <a>DescribeImages</a> operation.</p>"
@@ -2894,7 +2898,7 @@
"members":{
"scanType":{
"shape":"ScanType",
- "documentation":"<p>The scanning type to set for the registry.</p> <p>By default, the <code>BASIC</code> scan type is used. When basic scanning is set, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed. Alternatively, you can do manual scans of images with basic scanning.</p> <p>When the <code>ENHANCED</code> scan type is set, Amazon Inspector provides automated, continuous scanning of all repositories in your registry.</p>"
+ "documentation":"<p>The scanning type to set for the registry.</p> <p>When a registry scanning configuration is not defined, by default the <code>BASIC</code> scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.</p> <p>When the <code>ENHANCED</code> scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.</p>"
},
"rules":{
"shape":"RegistryScanningRuleList",
@@ -2946,6 +2950,7 @@
"documentation":"<p>Details about the recommended course of action to remediate the finding.</p>"
},
"RecommendationText":{"type":"string"},
+ "RecordedPullTimestamp":{"type":"timestamp"},
"ReferenceUrlsList":{
"type":"list",
"member":{"shape":"Url"}
@@ -3004,7 +3009,7 @@
"members":{
"scanFrequency":{
"shape":"ScanFrequency",
- "documentation":"<p>The frequency that scans are performed at for a private registry.</p>"
+ "documentation":"<p>The frequency that scans are performed at for a private registry. When the <code>ENHANCED</code> scan type is specified, the supported scan frequencies are <code>CONTINUOUS_SCAN</code> and <code>SCAN_ON_PUSH</code>. When the <code>BASIC</code> scan type is specified, the <code>SCAN_ON_PUSH</code> and <code>MANUAL</code> scan frequencies are supported.</p>"
},
"repositoryFilters":{
"shape":"ScanningRepositoryFilterList",
@@ -3389,7 +3394,7 @@
"documentation":"<p>The type associated with the filter.</p>"
}
},
- "documentation":"<p>The details of a scanning repository filter.</p>"
+ "documentation":"<p>The details of a scanning repository filter. For more information on how to use filters, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters\">Using filters</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
},
"ScanningRepositoryFilterList":{
"type":"list",
@@ -3565,10 +3570,10 @@
},
"Value":{
"shape":"TagValue",
- "documentation":"<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a descriptor within a tag category (key).</p>"
+ "documentation":"<p>A <code>value</code> acts as a descriptor within a tag category (key).</p>"
}
},
- "documentation":"<p>The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
+ "documentation":"<p>The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
},
"TagKey":{"type":"string"},
"TagKeyList":{
diff --git a/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json b/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json
index c1285d3e20..047a6e1339 100644
--- a/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json
@@ -63,7 +63,7 @@
{"shape":"PlatformTaskDefinitionIncompatibilityException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Tasks for services that don't use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and the container instance that they're hosted on is reported as healthy by the load balancer.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code> - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p> <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> </ul> <p>You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an <a>UpdateService</a> operation. The default value for a replica service for <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service for <code>minimumHealthyPercent</code> is 0%.</p> <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the <code>RUNNING</code> state, tasks for services that don't use a load balancer are considered healthy . If they're in the <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for services that <i>do</i> use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.</p> <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the number of tasks in a service that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.</p> <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller types and tasks that use the EC2 launch type, the <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the <code>RUNNING</code> state. This is while the container instances are in the <code>DRAINING</code> state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.</p> <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support the task definition of your service. For example, they have the required CPU, memory, ports, and container instance attributes.</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner. This is the case even if you can choose a different placement strategy with the <code>placementStrategy</code> parameter.</p> <ul> <li> <p>Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone based on the previous steps, favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul>"
+ "documentation":"<p>Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Tasks for services that don't use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code> - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p> <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Service Scheduler Concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> </ul> <p>You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. This is done with an <a>UpdateService</a> operation. The default value for a replica service for <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service for <code>minimumHealthyPercent</code> is 0%.</p> <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the <code>RUNNING</code> state, tasks for services that don't use a load balancer are considered healthy . If they're in the <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for services that <i>do</i> use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.</p> <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the number of tasks in a service that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the <code>DRAINING</code> state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.</p> <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller types and tasks that use the EC2 launch type, the <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the <code>RUNNING</code> state. This is while the container instances are in the <code>DRAINING</code> state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.</p> <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html\">Amazon ECS Deployment Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support the task definition of your service. For example, they have the required CPU, memory, ports, and container instance attributes.</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner. This is the case even if you can choose a different placement strategy with the <code>placementStrategy</code> parameter.</p> <ul> <li> <p>Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone based on the previous steps, favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul>"
},
"CreateTaskSet":{
"name":"CreateTaskSet",
@@ -518,7 +518,7 @@
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
- "documentation":"<p>Modifies an account setting. Account settings are set on a per-Region basis.</p> <p>If you change the account setting for the root user, the default settings for all of the IAM users and roles that no individual account setting was specified are reset for. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html\">Account Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.</p> <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If <code>awsvpcTrunking</code> is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html\">Elastic Network Interface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When <code>containerInsights</code> is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If <code>containerInsights</code> is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html\">CloudWatch Container Insights</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Modifies an account setting. Account settings are set on a per-Region basis.</p> <p>If you change the account setting for the root user, the default settings for all of the IAM users and roles that no individual account setting was specified are reset for. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html\">Account Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the IAM user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.</p> <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If <code>awsvpcTrunking</code> is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html\">Elastic Network Interface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When <code>containerInsights</code> is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If <code>containerInsights</code> is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html\">CloudWatch Container Insights</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"PutAccountSettingDefault":{
"name":"PutAccountSettingDefault",
@@ -813,7 +813,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ClusterNotFoundException"}
],
- "documentation":"<p>Modifies the status of an Amazon ECS container instance.</p> <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.</p> <important> <p>A container instance can't be changed to <code>DRAINING</code> until it has reached an <code>ACTIVE</code> status. If the instance is in any other status, an error will be received.</p> </important> <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the <code>PENDING</code> state are stopped immediately.</p> <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and replaced according to the service's deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment configuration of your service using <a>UpdateService</a>.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during task replacement. For example, <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and the container instance they're hosted on is reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.</p> </li> </ul> <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually.</p> <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can verify this using <a>ListTasks</a>.</p> <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.</p>"
+ "documentation":"<p>Modifies the status of an Amazon ECS container instance.</p> <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.</p> <important> <p>A container instance can't be changed to <code>DRAINING</code> until it has reached an <code>ACTIVE</code> status. If the instance is in any other status, an error will be received.</p> </important> <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the <code>PENDING</code> state are stopped immediately.</p> <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and replaced according to the service's deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment configuration of your service using <a>UpdateService</a>.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during task replacement. For example, <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.</p> </li> </ul> <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually.</p> <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can verify this using <a>ListTasks</a>.</p> <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.</p>"
},
"UpdateService":{
"name":"UpdateService",
@@ -834,7 +834,7 @@
{"shape":"PlatformTaskDefinitionIncompatibilityException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<important> <p>Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at <a href=\"https://aws.amazon.com/service-terms\">https://aws.amazon.com/service-terms</a> (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.</p> </important> <p>Modifies the parameters of a service.</p> <p>For services using the rolling update (<code>ECS</code>) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.</p> <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment is created. For more information, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html\">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p> <p>For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set. For more information, see <a>CreateTaskSet</a>.</p> <p>You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter.</p> <p>If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.</p> <note> <p>If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, <code>my_image:latest</code>), you don't need to create a new revision of your task definition. You can update the service using the <code>forceNewDeployment</code> option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.</p> </note> <p>You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and the container instance they're hosted on is reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout. After this, <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.</p> <ul> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul>"
+ "documentation":"<important> <p>Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at <a href=\"https://aws.amazon.com/service-terms\">https://aws.amazon.com/service-terms</a> (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.</p> </important> <p>Modifies the parameters of a service.</p> <p>For services using the rolling update (<code>ECS</code>) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration. </p> <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html\">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p> <p>For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see <a>CreateTaskSet</a>.</p> <p>You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter.</p> <p>If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.</p> <note> <p>If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, <code>my_image:latest</code>), you don't need to create a new revision of your task definition. You can update the service using the <code>forceNewDeployment</code> option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.</p> </note> <p>You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout. After this, <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.</p> <ul> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul> <note> <p>You must have a service-linked role when you update any of the following service properties. If you specified a custom IAM role when you created the service, Amazon ECS automatically replaces the <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn\">roleARN</a> associated with the service with the ARN of your service-linked role. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <ul> <li> <p> <code>loadBalancers,</code> </p> </li> <li> <p> <code>serviceRegistries</code> </p> </li> </ul> </note>"
},
"UpdateServicePrimaryTaskSet":{
"name":"UpdateServicePrimaryTaskSet",
@@ -978,7 +978,7 @@
"documentation":"<p>The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).</p>"
}
},
- "documentation":"<p>An attribute is a name-value pair that's associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"AttributeLimitExceededException":{
"type":"structure",
@@ -1301,7 +1301,7 @@
"documentation":"<p>The value to set for the cluster setting. The supported values are <code>enabled</code> and <code>disabled</code>. If <code>enabled</code> is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the <code>containerInsights</code> account setting is enabled. If a cluster value is specified, it will override the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
}
},
- "documentation":"<p>The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.</p>"
+ "documentation":"<p>The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.</p>"
},
"ClusterSettingName":{
"type":"string",
@@ -1490,15 +1490,15 @@
},
"dependsOn":{
"shape":"ContainerDependencies",
- "documentation":"<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>For tasks using the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul>"
+ "documentation":"<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>For tasks using the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul>"
},
"startTimeout":{
"shape":"BoxedInteger",
- "documentation":"<p>Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a <code>COMPLETE</code>, <code>SUCCESS</code>, or <code>HEALTHY</code> status. If a <code>startTimeout</code> value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a <code>STOPPED</code> state.</p> <note> <p>When the <code>ECS_CONTAINER_START_TIMEOUT</code> container agent configuration variable is used, it's enforced independently from this start timeout value.</p> </note> <p>For tasks using the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> <p>For tasks using the EC2 launch type, your container instances require at least version <code>1.26.0</code> of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version <code>1.26.0-1</code> of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a <code>COMPLETE</code>, <code>SUCCESS</code>, or <code>HEALTHY</code> status. If a <code>startTimeout</code> value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a <code>STOPPED</code> state.</p> <note> <p>When the <code>ECS_CONTAINER_START_TIMEOUT</code> container agent configuration variable is used, it's enforced independently from this start timeout value.</p> </note> <p>For tasks using the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> <p>For tasks using the EC2 launch type, your container instances require at least version <code>1.26.0</code> of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version <code>1.26.0-1</code> of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"stopTimeout":{
"shape":"BoxedInteger",
- "documentation":"<p>Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.</p> <p>For tasks using the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> <p>The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.</p> <p>For tasks that use the EC2 launch type, if the <code>stopTimeout</code> parameter isn't specified, the value set for the Amazon ECS container agent configuration variable <code>ECS_CONTAINER_STOP_TIMEOUT</code> is used. If neither the <code>stopTimeout</code> parameter or the <code>ECS_CONTAINER_STOP_TIMEOUT</code> agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.</p> <p>For tasks using the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> <p>The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.</p> <p>For tasks that use the EC2 launch type, if the <code>stopTimeout</code> parameter isn't specified, the value set for the Amazon ECS container agent configuration variable <code>ECS_CONTAINER_STOP_TIMEOUT</code> is used. If neither the <code>stopTimeout</code> parameter or the <code>ECS_CONTAINER_STOP_TIMEOUT</code> agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"hostname":{
"shape":"String",
@@ -1603,7 +1603,7 @@
"documentation":"<p>The dependency condition of the container. The following are the available conditions and their behavior:</p> <ul> <li> <p> <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.</p> </li> <li> <p> <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.</p> </li> <li> <p> <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the container exits with a <code>zero</code> status. This condition can't be set on an essential container.</p> </li> <li> <p> <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.</p> </li> </ul>"
}
},
- "documentation":"<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>For tasks that use the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> </note>"
+ "documentation":"<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>For tasks that use the Fargate launch type, the task or service requires the following platforms:</p> <ul> <li> <p>Linux platform version <code>1.3.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> </note>"
},
"ContainerInstance":{
"type":"structure",
@@ -1849,11 +1849,11 @@
},
"settings":{
"shape":"ClusterSettings",
- "documentation":"<p>The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
+ "documentation":"<p>The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
},
"configuration":{
"shape":"ClusterConfiguration",
- "documentation":"<p>The execute command configuration for the cluster.</p>"
+ "documentation":"<p>The <code>execute</code> command configuration for the cluster.</p>"
},
"capacityProviders":{
"shape":"StringList",
@@ -1892,7 +1892,7 @@
},
"loadBalancers":{
"shape":"LoadBalancers",
- "documentation":"<p>A load balancer object representing the load balancers to use with your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service uses the rolling update (<code>ECS</code>) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service uses the <code>CODE_DEPLOY</code> deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a <code>targetGroupPair</code>). During a deployment, CodeDeploy determines which task set in your service has the status <code>PRIMARY</code>, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.</p> <p>After you create a service using the <code>ECS</code> deployment controller, the load balancer name or target group ARN, container name, and container port that's specified in the service definition are immutable. If you use the <code>CODE_DEPLOY</code> deployment controller, these values can be changed when updating the service.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that's specified here.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>. This is because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
+ "documentation":"<p>A load balancer object representing the load balancers to use with your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service uses the rolling update (<code>ECS</code>) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service uses the <code>CODE_DEPLOY</code> deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a <code>targetGroupPair</code>). During a deployment, CodeDeploy determines which task set in your service has the status <code>PRIMARY</code>, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.</p> <p>If you use the <code>CODE_DEPLOY</code> deployment controller, these values can be changed when updating the service.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that's specified here.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>. This is because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
},
"serviceRegistries":{
"shape":"ServiceRegistries",
@@ -1940,7 +1940,7 @@
},
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
- "documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of <code>0</code> is used.</p> <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
+ "documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of <code>0</code> is used.</p> <p>If you do not use an Elastic Load Balancing, we recomend that you use the <code>startPeriod</code> in the task definition healtch check parameters. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html\">Health check</a>.</p> <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
@@ -1956,11 +1956,11 @@
},
"enableECSManagedTags":{
"shape":"Boolean",
- "documentation":"<p>Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"propagateTags":{
"shape":"PropagateTags",
- "documentation":"<p>Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation or task creation, use the <a>TagResource</a> API action.</p>"
+ "documentation":"<p>Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the <a>TagResource</a> API action.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
@@ -2273,14 +2273,14 @@
"members":{
"enable":{
"shape":"Boolean",
- "documentation":"<p>Determines whether to enable the deployment circuit breaker logic for the service.</p>"
+ "documentation":"<p>Determines whether to use the deployment circuit breaker logic for the service.</p>"
},
"rollback":{
"shape":"Boolean",
- "documentation":"<p>Determines whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.</p>"
+ "documentation":"<p>Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.</p>"
}
},
- "documentation":"<note> <p>The deployment circuit breaker can only be used for services using the rolling update (<code>ECS</code>) deployment type that aren't behind a Classic Load Balancer.</p> </note> <p>The <b>deployment circuit breaker</b> determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html\">Rolling update</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<note> <p>The deployment circuit breaker can only be used for services using the rolling update (<code>ECS</code>) deployment type that aren't behind a Classic Load Balancer.</p> </note> <p>The <b>deployment circuit breaker</b> determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html\">Rolling update</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"DeploymentConfiguration":{
"type":"structure",
@@ -2742,7 +2742,7 @@
},
"transitEncryption":{
"shape":"EFSTransitEncryption",
- "documentation":"<p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html\">Encrypting Data in Transit</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
+ "documentation":"<p>Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html\">Encrypting Data in Transit</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"
},
"transitEncryptionPort":{
"shape":"BoxedInteger",
@@ -2794,7 +2794,7 @@
"documentation":"<p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is <code>21</code> GiB and the maximum supported value is <code>200</code> GiB.</p>"
}
},
- "documentation":"<p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html\">Fargate task storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p> <note> <p>This parameter is only supported for tasks hosted on Fargate using the following platform versions:</p> <ul> <li> <p>Linux platform version <code>1.4.0</code> or later.</p> </li> <li> <p>Windows platform version <code>1.0.0</code> or later.</p> </li> </ul> </note>"
+ "documentation":"<p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html\">Fargate task storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p> <note> <p>This parameter is only supported for tasks hosted on Fargate using Linux platform version <code>1.4.0</code> or later. This parameter is not supported for Windows containers on Fargate.</p> </note>"
},
"ExecuteCommandConfiguration":{
"type":"structure",
@@ -2823,7 +2823,7 @@
},
"cloudWatchEncryptionEnabled":{
"shape":"Boolean",
- "documentation":"<p>Determines whether to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.</p>"
+ "documentation":"<p>Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be disabled.</p>"
},
"s3BucketName":{
"shape":"String",
@@ -3026,7 +3026,7 @@
"documentation":"<p>The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the <code>startPeriod</code> is disabled.</p> <note> <p>If a health check succeeds within the <code>startPeriod</code>, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.</p> </note>"
}
},
- "documentation":"<p>An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).</p> <p>You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.</p> <p>The following describes the possible <code>healthStatus</code> values for a container:</p> <ul> <li> <p> <code>HEALTHY</code>-The container health check has passed successfully.</p> </li> <li> <p> <code>UNHEALTHY</code>-The container health check has failed.</p> </li> <li> <p> <code>UNKNOWN</code>-The container health check is being evaluated or there's no container health check defined.</p> </li> </ul> <p>The following describes the possible <code>healthStatus</code> values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.</p> <ul> <li> <p> <code>HEALTHY</code>-All essential containers within the task have passed their health checks.</p> </li> <li> <p> <code>UNHEALTHY</code>-One or more essential containers have failed their health check.</p> </li> <li> <p> <code>UNKNOWN</code>-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.</p> </li> </ul> <p>If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.</p> <p>The following are notes about container health check support:</p> <ul> <li> <p>Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a>.</p> </li> <li> <p>Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">Fargate Platform Versions</a>.</p> </li> <li> <p>Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.</p> </li> </ul>"
+ "documentation":"<p>An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).</p> <note> <p>The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.</p> </note> <p>You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.</p> <p>The following describes the possible <code>healthStatus</code> values for a container:</p> <ul> <li> <p> <code>HEALTHY</code>-The container health check has passed successfully.</p> </li> <li> <p> <code>UNHEALTHY</code>-The container health check has failed.</p> </li> <li> <p> <code>UNKNOWN</code>-The container health check is being evaluated or there's no container health check defined.</p> </li> </ul> <p>The following describes the possible <code>healthStatus</code> values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.</p> <ul> <li> <p> <code>HEALTHY</code>-All essential containers within the task have passed their health checks.</p> </li> <li> <p> <code>UNHEALTHY</code>-One or more essential containers have failed their health check.</p> </li> <li> <p> <code>UNKNOWN</code>-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.</p> </li> </ul> <p>If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.</p> <p>The following are notes about container health check support:</p> <ul> <li> <p>Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a>.</p> </li> <li> <p>Container health checks are supported for Fargate tasks if you're using platform version 1.1.0 or greater. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">Fargate Platform Versions</a>.</p> </li> <li> <p>Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.</p> </li> </ul>"
},
"HealthStatus":{
"type":"string",
@@ -3592,7 +3592,7 @@
"documentation":"<p>The port on the container to associate with the load balancer. This port must correspond to a <code>containerPort</code> in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the <code>hostPort</code> of the port mapping.</p>"
}
},
- "documentation":"<p>The load balancer configuration to use with a service or task set.</p> <p>For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.</p>"
+ "documentation":"<p>The load balancer configuration to use with a service or task set.</p> <p>For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.</p> <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers.</p> <p>We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration. </p> <p>A service-linked role is required for services that use multiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"LoadBalancers":{
"type":"list",
@@ -3702,7 +3702,7 @@
"members":{
"status":{
"shape":"ManagedScalingStatus",
- "documentation":"<p>Determines whether to enable managed scaling for the capacity provider.</p>"
+ "documentation":"<p>Determines whether to use managed scaling for the capacity provider.</p>"
},
"targetCapacity":{
"shape":"ManagedScalingTargetCapacity",
@@ -3992,7 +3992,8 @@
"type":"string",
"enum":[
"TASK_DEFINITION",
- "SERVICE"
+ "SERVICE",
+ "NONE"
]
},
"ProxyConfiguration":{
@@ -4012,7 +4013,7 @@
"documentation":"<p>The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.</p> <ul> <li> <p> <code>IgnoredUID</code> - (Required) The user ID (UID) of the proxy container as defined by the <code>user</code> parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If <code>IgnoredGID</code> is specified, this field can be empty.</p> </li> <li> <p> <code>IgnoredGID</code> - (Required) The group ID (GID) of the proxy container as defined by the <code>user</code> parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If <code>IgnoredUID</code> is specified, this field can be empty.</p> </li> <li> <p> <code>AppPorts</code> - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the <code>ProxyIngressPort</code> and <code>ProxyEgressPort</code>.</p> </li> <li> <p> <code>ProxyIngressPort</code> - (Required) Specifies the port that incoming traffic to the <code>AppPorts</code> is directed to.</p> </li> <li> <p> <code>ProxyEgressPort</code> - (Required) Specifies the port that outgoing traffic from the <code>AppPorts</code> is directed to.</p> </li> <li> <p> <code>EgressIgnoredPorts</code> - (Required) The egress traffic going to the specified ports is ignored and not redirected to the <code>ProxyEgressPort</code>. It can be an empty list.</p> </li> <li> <p> <code>EgressIgnoredIPs</code> - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the <code>ProxyEgressPort</code>. It can be an empty list.</p> </li> </ul>"
}
},
- "documentation":"<p>The configuration details for the App Mesh proxy.</p> <p>For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the <code>ecs-init</code> package to enable a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> </p>"
+ "documentation":"<p>The configuration details for the App Mesh proxy.</p> <p>For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the <code>ecs-init</code> package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> </p>"
},
"ProxyConfigurationProperties":{
"type":"list",
@@ -4243,7 +4244,7 @@
},
"proxyConfiguration":{
"shape":"ProxyConfiguration",
- "documentation":"<p>The configuration details for the App Mesh proxy.</p> <p>For tasks hosted on Amazon EC2 instances, the container instances require at least version <code>1.26.0</code> of the container agent and at least version <code>1.26.0-1</code> of the <code>ecs-init</code> package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html\">Amazon ECS-optimized AMI versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>The configuration details for the App Mesh proxy.</p> <p>For tasks hosted on Amazon EC2 instances, the container instances require at least version <code>1.26.0</code> of the container agent and at least version <code>1.26.0-1</code> of the <code>ecs-init</code> package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html\">Amazon ECS-optimized AMI versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"inferenceAccelerators":{
"shape":"InferenceAccelerators",
@@ -4382,11 +4383,11 @@
},
"enableECSManagedTags":{
"shape":"Boolean",
- "documentation":"<p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Specifies whether to use Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
- "documentation":"<p>Determines whether to enable the execute command functionality for the containers in this task. If <code>true</code>, this enables execute command functionality on all containers in the task.</p>"
+ "documentation":"<p>Determines whether to use the execute command functionality for the containers in this task. If <code>true</code>, this enables execute command functionality on all containers in the task.</p> <p>If <code>true</code>, then the task definition must have a task role, or you must provide one as an override.</p>"
},
"group":{
"shape":"String",
@@ -4434,7 +4435,7 @@
},
"taskDefinition":{
"shape":"String",
- "documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to run. If a <code>revision</code> isn't specified, the latest <code>ACTIVE</code> revision is used.</p> <p>The full ARN value must match the value that you specified as the <code>Resource</code> of the IAM principal's permissions policy. For example, if the <code>Resource</code> is arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the <code>taskDefinition</code> ARN value must be <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p>"
+ "documentation":"<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to run. If a <code>revision</code> isn't specified, the latest <code>ACTIVE</code> revision is used.</p> <p>When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.</p> <p>The full ARN value must match the value that you specified as the <code>Resource</code> of the IAM principal's permissions policy.</p> <p>When you specify the policy resource as the latest task definition version (by setting the <code>Resource</code> in the policy to <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>), then set this value to <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p> <p>When you specify the policy resource as a specific task definition version (by setting the <code>Resource</code> in the policy to <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code> or <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>), then set this value to <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources\">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service developer Guide.</p>"
}
}
},
@@ -4510,7 +4511,7 @@
},
"valueFrom":{
"shape":"String",
- "documentation":"<p>The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.</p> <note> <p>If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.</p> </note>"
+ "documentation":"<p>The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.</p> <p>For information about the require Identity and Access Management permissions, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam\">Required IAM permissions for Amazon ECS secrets</a> (for Secrets Manager) or <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html\">Required IAM permissions for Amazon ECS secrets</a> (for Systems Manager Parameter store) in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.</p> </note>"
}
},
"documentation":"<p>An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:</p> <ul> <li> <p>To inject sensitive data into your containers as environment variables, use the <code>secrets</code> container definition parameter.</p> </li> <li> <p>To reference sensitive information in the log configuration of a container, use the <code>secretOptions</code> container definition parameter.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html\">Specifying Sensitive Data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
@@ -4633,7 +4634,7 @@
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
- "documentation":"<p>The scheduling strategy to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Services</a>.</p> <p>There are two service scheduler strategies available.</p> <ul> <li> <p> <code>REPLICA</code>-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.</p> </li> <li> <p> <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one task on each active container instance. This taskmeets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.</p> <note> <p>Fargate tasks don't support the <code>DAEMON</code> scheduling strategy.</p> </note> </li> </ul>"
+ "documentation":"<p>The scheduling strategy to use for the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html\">Services</a>.</p> <p>There are two service scheduler strategies available.</p> <ul> <li> <p> <code>REPLICA</code>-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.</p> </li> <li> <p> <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.</p> <note> <p>Fargate tasks don't support the <code>DAEMON</code> scheduling strategy.</p> </note> </li> </ul>"
},
"deploymentController":{
"shape":"DeploymentController",
@@ -4649,7 +4650,7 @@
},
"enableECSManagedTags":{
"shape":"Boolean",
- "documentation":"<p>Determines whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"propagateTags":{
"shape":"PropagateTags",
@@ -4730,7 +4731,7 @@
"documentation":"<p>The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the <code>bridge</code> or <code>host</code> network mode, you must specify a <code>containerName</code> and <code>containerPort</code> combination from the task definition. If the task definition your service task specifies uses the <code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify either a <code>containerName</code> and <code>containerPort</code> combination or a <code>port</code> value. However, you can't specify both.</p>"
}
},
- "documentation":"<p>The details for the service registry.</p>"
+ "documentation":"<p>The details for the service registry.</p> <p>Each service may be associated with one service registry. Multiple service registries for each service are not supported.</p> <p>When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.</p>"
},
"Services":{
"type":"list",
@@ -4745,7 +4746,7 @@
},
"streamUrl":{
"shape":"String",
- "documentation":"<p>A URL back to managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.</p>"
+ "documentation":"<p>A URL to the managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.</p>"
},
"tokenValue":{
"shape":"SensitiveString",
@@ -4817,7 +4818,7 @@
},
"enableECSManagedTags":{
"shape":"Boolean",
- "documentation":"<p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>Specifies whether to use Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
@@ -5114,7 +5115,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>The target container isn't properly configured with the execute command agent or the container is no longer active or running.</p>",
+ "documentation":"<p>The execute command cannot run. This error can be caused by any of the following configuration issues:</p> <ul> <li> <p>Incorrect IAM permissions</p> </li> <li> <p>The SSM agent is not installed or is not running</p> </li> <li> <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for for Systems Manager Session Manager</p> </li> </ul> <p>For information about how to troubleshoot the issues, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html\">Troubleshooting issues with ECS Exec</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"exception":true
},
"TargetNotFoundException":{
@@ -5241,7 +5242,7 @@
},
"stopCode":{
"shape":"TaskStopCode",
- "documentation":"<p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> might contain additional details.</p>"
+ "documentation":"<p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> might contain additional details.</p> <p>The following are valid values:</p> <ul> <li> <p> <code>TaskFailedToStart</code> </p> </li> <li> <p> <code>EssentialContainerExited</code> </p> </li> <li> <p> <code>UserInitiated</code> </p> </li> <li> <p> <code>TerminationNotice</code> </p> </li> <li> <p> <code>ServiceSchedulerInitiated</code> </p> </li> <li> <p> <code>SpotInterruption</code> </p> </li> </ul>"
},
"stoppedAt":{
"shape":"Timestamp",
@@ -5359,7 +5360,7 @@
},
"proxyConfiguration":{
"shape":"ProxyConfiguration",
- "documentation":"<p>The configuration details for the App Mesh proxy.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the <code>ecs-init</code> package to enable a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version <code>20190301</code> or later, they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
+ "documentation":"<p>The configuration details for the App Mesh proxy.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the <code>ecs-init</code> package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version <code>20190301</code> or later, they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"registeredAt":{
"shape":"Timestamp",
@@ -5776,7 +5777,7 @@
},
"settings":{
"shape":"ClusterSettings",
- "documentation":"<p>The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
+ "documentation":"<p>The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
}
}
},
@@ -5880,7 +5881,7 @@
"members":{
"taskSet":{
"shape":"TaskSet",
- "documentation":"<p>Details about the task set.</p>"
+ "documentation":"<p>etails about the task set.</p>"
}
}
},
@@ -5939,6 +5940,22 @@
"enableExecuteCommand":{
"shape":"BoxedBoolean",
"documentation":"<p>If <code>true</code>, this enables execute command functionality on all task containers.</p> <p>If you do not want to override the value that was set when the service was created, you can set this to <code>null</code> when performing this action.</p>"
+ },
+ "enableECSManagedTags":{
+ "shape":"BoxedBoolean",
+ "documentation":"<p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Only tasks launched after the update will reflect the update. To update the tags on all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS starts new tasks with the updated tags.</p>"
+ },
+ "loadBalancers":{
+ "shape":"LoadBalancers",
+ "documentation":"<p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.</p> <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.</p> <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.</p> <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using <code> <a href=\"https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html\">CreateDeployment</a> </code> through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html\">Register multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p> <p>For services that use the external deployment controller, you can add, update, or remove load balancers by using <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html\">CreateTaskSet</a>. Note that multiple target groups are not supported for external deployments. For more information see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html\">Register multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p> <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p>"
+ },
+ "propagateTags":{
+ "shape":"PropagateTags",
+ "documentation":"<p>Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.</p> <p>Only tasks launched after the update will reflect the update. To update the tags on all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS starts new tasks with the updated tags.</p>"
+ },
+ "serviceRegistries":{
+ "shape":"ServiceRegistries",
+ "documentation":"<p>The details for the service discovery registries to assign to this service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p> <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.</p> <p>You can remove existing <code>serviceRegistries</code> by passing an empty list.</p>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json
index 9de329d482..9b95ac5968 100644
--- a/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json
@@ -2470,7 +2470,8 @@
"InsufficientFreeAddresses",
"AccessDenied",
"InternalFailure",
- "ClusterUnreachable"
+ "ClusterUnreachable",
+ "Ec2SubnetMissingIpv6Assignment"
]
},
"NodegroupResources":{
diff --git a/contrib/python/botocore/py3/botocore/data/elasticache/2015-02-02/service-2.json b/contrib/python/botocore/py3/botocore/data/elasticache/2015-02-02/service-2.json
index dd1de85bea..091cd9c82a 100644
--- a/contrib/python/botocore/py3/botocore/data/elasticache/2015-02-02/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/elasticache/2015-02-02/service-2.json
@@ -1565,7 +1565,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The name of the compute and memory capacity node type for the cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The name of the compute and memory capacity node type for the cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Engine":{
"shape":"String",
@@ -1735,7 +1735,7 @@
},
"CacheParameterGroupFamily":{
"shape":"String",
- "documentation":"<p>The name of the cache parameter group family associated with this cache engine.</p> <p>Valid values are: <code>memcached1.4</code> | <code>memcached1.5</code> | <code>memcached1.6</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> | <code>redis4.0</code> | <code>redis5.0</code> | <code>redis6.0</code> | <code>redis6.2</code> </p>"
+ "documentation":"<p>The name of the cache parameter group family associated with this cache engine.</p> <p>Valid values are: <code>memcached1.4</code> | <code>memcached1.5</code> | <code>memcached1.6</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> | <code>redis4.0</code> | <code>redis5.0</code> | <code>redis6.x</code> </p>"
},
"CacheEngineDescription":{
"shape":"String",
@@ -1805,7 +1805,7 @@
"documentation":"<p>The customer outpost ARN of the cache node.</p>"
}
},
- "documentation":"<p>Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"CacheNodeIdsList":{
"type":"list",
@@ -2434,7 +2434,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Engine":{
"shape":"String",
@@ -2699,7 +2699,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Engine":{
"shape":"String",
@@ -3411,7 +3411,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Duration":{
"shape":"String",
@@ -3445,7 +3445,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward) <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward) <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Duration":{
"shape":"String",
@@ -3758,7 +3758,7 @@
"members":{
"CacheParameterGroupFamily":{
"shape":"String",
- "documentation":"<p>Specifies the name of the cache parameter group family to which the engine default parameters apply.</p> <p>Valid values are: <code>memcached1.4</code> | <code>memcached1.5</code> | <code>memcached1.6</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> | <code>redis4.0</code> | <code>redis5.0</code> | <code>redis6.0</code> | <code>redis6.2</code> </p>"
+ "documentation":"<p>Specifies the name of the cache parameter group family to which the engine default parameters apply.</p> <p>Valid values are: <code>memcached1.4</code> | <code>memcached1.5</code> | <code>memcached1.6</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> | <code>redis4.0</code> | <code>redis5.0</code> | <code>redis6.0</code> | <code>redis6.x</code> </p>"
},
"Marker":{
"shape":"String",
@@ -5750,7 +5750,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The cache node type for the reserved cache nodes.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The cache node type for the reserved cache nodes.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"StartTime":{
"shape":"TStamp",
@@ -5862,7 +5862,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The cache node type for the reserved cache node.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The cache node type for the reserved cache node.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types:</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Duration":{
"shape":"Integer",
@@ -6200,7 +6200,7 @@
},
"CacheNodeType":{
"shape":"String",
- "documentation":"<p>The name of the compute and memory capacity node type for the source cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):</p> <p> <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
+ "documentation":"<p>The name of the compute and memory capacity node type for the source cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T4g node types</b> (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):</p> <p> <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized with data tiering:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6gd node types</b> (available only for Redis engine version 6.2 onward).</p> <p> <code>cache.r6gd.xlarge</code>, <code>cache.r6gd.2xlarge</code>, <code>cache.r6gd.4xlarge</code>, <code>cache.r6gd.8xlarge</code>, <code>cache.r6gd.12xlarge</code>, <code>cache.r6gd.16xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R6g node types</b> (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).</p> <p> <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> </p> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <note> <p>For region availability, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion\">Supported Node Types</a> </p> </note> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
},
"Engine":{
"shape":"String",
diff --git a/contrib/python/botocore/py3/botocore/data/endpoints.json b/contrib/python/botocore/py3/botocore/data/endpoints.json
index f91ac484ee..9c70d4a8f2 100644
--- a/contrib/python/botocore/py3/botocore/data/endpoints.json
+++ b/contrib/python/botocore/py3/botocore/data/endpoints.json
@@ -426,6 +426,27 @@
"us-west-2" : { }
}
},
+ "amplifyuibuilder" : {
+ "endpoints" : {
+ "ap-northeast-1" : { },
+ "ap-northeast-2" : { },
+ "ap-south-1" : { },
+ "ap-southeast-1" : { },
+ "ap-southeast-2" : { },
+ "ca-central-1" : { },
+ "eu-central-1" : { },
+ "eu-north-1" : { },
+ "eu-west-1" : { },
+ "eu-west-2" : { },
+ "eu-west-3" : { },
+ "me-south-1" : { },
+ "sa-east-1" : { },
+ "us-east-1" : { },
+ "us-east-2" : { },
+ "us-west-1" : { },
+ "us-west-2" : { }
+ }
+ },
"api.detective" : {
"defaults" : {
"protocols" : [ "https" ]
@@ -977,6 +998,94 @@
}
}
},
+ "api.tunneling.iot" : {
+ "defaults" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.{region}.{dnsSuffix}",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "endpoints" : {
+ "ap-east-1" : { },
+ "ap-northeast-1" : { },
+ "ap-northeast-2" : { },
+ "ap-south-1" : { },
+ "ap-southeast-1" : { },
+ "ap-southeast-2" : { },
+ "ca-central-1" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.ca-central-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "eu-central-1" : { },
+ "eu-north-1" : { },
+ "eu-west-1" : { },
+ "eu-west-2" : { },
+ "eu-west-3" : { },
+ "fips-ca-central-1" : {
+ "credentialScope" : {
+ "region" : "ca-central-1"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.ca-central-1.amazonaws.com"
+ },
+ "fips-us-east-1" : {
+ "credentialScope" : {
+ "region" : "us-east-1"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.us-east-1.amazonaws.com"
+ },
+ "fips-us-east-2" : {
+ "credentialScope" : {
+ "region" : "us-east-2"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.us-east-2.amazonaws.com"
+ },
+ "fips-us-west-1" : {
+ "credentialScope" : {
+ "region" : "us-west-1"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.us-west-1.amazonaws.com"
+ },
+ "fips-us-west-2" : {
+ "credentialScope" : {
+ "region" : "us-west-2"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.us-west-2.amazonaws.com"
+ },
+ "me-south-1" : { },
+ "sa-east-1" : { },
+ "us-east-1" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.us-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-east-2" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.us-east-2.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-west-1" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.us-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-west-2" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.us-west-2.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ }
+ }
+ },
"apigateway" : {
"endpoints" : {
"af-south-1" : { },
@@ -1141,9 +1250,45 @@
"endpoints" : {
"ap-northeast-1" : { },
"eu-west-1" : { },
- "us-east-1" : { },
- "us-east-2" : { },
- "us-west-2" : { }
+ "fips-us-east-1" : {
+ "credentialScope" : {
+ "region" : "us-east-1"
+ },
+ "deprecated" : true,
+ "hostname" : "apprunner-fips.us-east-1.amazonaws.com"
+ },
+ "fips-us-east-2" : {
+ "credentialScope" : {
+ "region" : "us-east-2"
+ },
+ "deprecated" : true,
+ "hostname" : "apprunner-fips.us-east-2.amazonaws.com"
+ },
+ "fips-us-west-2" : {
+ "credentialScope" : {
+ "region" : "us-west-2"
+ },
+ "deprecated" : true,
+ "hostname" : "apprunner-fips.us-west-2.amazonaws.com"
+ },
+ "us-east-1" : {
+ "variants" : [ {
+ "hostname" : "apprunner-fips.us-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-east-2" : {
+ "variants" : [ {
+ "hostname" : "apprunner-fips.us-east-2.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-west-2" : {
+ "variants" : [ {
+ "hostname" : "apprunner-fips.us-west-2.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ }
}
},
"appstream2" : {
@@ -1394,6 +1539,7 @@
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
+ "ap-southeast-3" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
@@ -1488,8 +1634,21 @@
}
}
},
+ "billingconductor" : {
+ "endpoints" : {
+ "aws-global" : {
+ "credentialScope" : {
+ "region" : "us-east-1"
+ },
+ "hostname" : "billingconductor.us-east-1.amazonaws.com"
+ }
+ },
+ "isRegionalized" : false,
+ "partitionEndpoint" : "aws-global"
+ },
"braket" : {
"endpoints" : {
+ "eu-west-2" : { },
"us-east-1" : { },
"us-west-1" : { },
"us-west-2" : { }
@@ -1802,9 +1961,11 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
+ "ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
+ "ap-southeast-3" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
@@ -3510,6 +3671,7 @@
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
+ "ap-southeast-3" : { },
"ca-central-1" : {
"variants" : [ {
"hostname" : "ebs-fips.ca-central-1.amazonaws.com",
@@ -5416,6 +5578,11 @@
"us-west-2" : { }
}
},
+ "gamesparks" : {
+ "endpoints" : {
+ "us-east-1" : { }
+ }
+ },
"glacier" : {
"defaults" : {
"protocols" : [ "http", "https" ]
@@ -5726,6 +5893,7 @@
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
+ "ap-southeast-3" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
@@ -6337,6 +6505,10 @@
},
"ivs" : {
"endpoints" : {
+ "ap-northeast-1" : { },
+ "ap-northeast-2" : { },
+ "ap-south-1" : { },
+ "eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
@@ -7887,6 +8059,7 @@
},
"mq" : {
"endpoints" : {
+ "af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@@ -7894,6 +8067,7 @@
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
+ "ap-southeast-3" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
@@ -8677,7 +8851,9 @@
},
"profile" : {
"endpoints" : {
+ "af-south-1" : { },
"ap-northeast-1" : { },
+ "ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
@@ -12707,6 +12883,7 @@
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
+ "ap-southeast-3" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
@@ -12849,6 +13026,12 @@
"cn-northwest-1" : { }
}
},
+ "api.tunneling.iot" : {
+ "endpoints" : {
+ "cn-north-1" : { },
+ "cn-northwest-1" : { }
+ }
+ },
"apigateway" : {
"endpoints" : {
"cn-north-1" : { },
@@ -13850,6 +14033,12 @@
}
},
"acm" : {
+ "defaults" : {
+ "variants" : [ {
+ "hostname" : "acm.{region}.{dnsSuffix}",
+ "tags" : [ "fips" ]
+ } ]
+ },
"endpoints" : {
"us-gov-east-1" : {
"credentialScope" : {
@@ -14053,6 +14242,42 @@
}
}
},
+ "api.tunneling.iot" : {
+ "defaults" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.{region}.{dnsSuffix}",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "endpoints" : {
+ "fips-us-gov-east-1" : {
+ "credentialScope" : {
+ "region" : "us-gov-east-1"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com"
+ },
+ "fips-us-gov-west-1" : {
+ "credentialScope" : {
+ "region" : "us-gov-west-1"
+ },
+ "deprecated" : true,
+ "hostname" : "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com"
+ },
+ "us-gov-east-1" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.us-gov-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-west-1" : {
+ "variants" : [ {
+ "hostname" : "api.tunneling.iot-fips.us-gov-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ }
+ }
+ },
"apigateway" : {
"endpoints" : {
"us-gov-east-1" : { },
@@ -14155,6 +14380,12 @@
}
},
"autoscaling" : {
+ "defaults" : {
+ "variants" : [ {
+ "hostname" : "autoscaling.{region}.{dnsSuffix}",
+ "tags" : [ "fips" ]
+ } ]
+ },
"endpoints" : {
"us-gov-east-1" : {
"protocols" : [ "http", "https" ]
@@ -14288,17 +14519,31 @@
},
"cloudtrail" : {
"endpoints" : {
- "us-gov-east-1" : {
+ "fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
+ "deprecated" : true,
"hostname" : "cloudtrail.us-gov-east-1.amazonaws.com"
},
- "us-gov-west-1" : {
+ "fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
+ "deprecated" : true,
"hostname" : "cloudtrail.us-gov-west-1.amazonaws.com"
+ },
+ "us-gov-east-1" : {
+ "variants" : [ {
+ "hostname" : "cloudtrail.us-gov-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-west-1" : {
+ "variants" : [ {
+ "hostname" : "cloudtrail.us-gov-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
}
}
},
@@ -14781,6 +15026,12 @@
}
},
"ec2" : {
+ "defaults" : {
+ "variants" : [ {
+ "hostname" : "ec2.{region}.{dnsSuffix}",
+ "tags" : [ "fips" ]
+ } ]
+ },
"endpoints" : {
"us-gov-east-1" : {
"credentialScope" : {
@@ -15070,17 +15321,31 @@
},
"events" : {
"endpoints" : {
- "us-gov-east-1" : {
+ "fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
+ "deprecated" : true,
"hostname" : "events.us-gov-east-1.amazonaws.com"
},
- "us-gov-west-1" : {
+ "fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
+ "deprecated" : true,
"hostname" : "events.us-gov-west-1.amazonaws.com"
+ },
+ "us-gov-east-1" : {
+ "variants" : [ {
+ "hostname" : "events.us-gov-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-west-1" : {
+ "variants" : [ {
+ "hostname" : "events.us-gov-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
}
}
},
@@ -15718,17 +15983,31 @@
},
"logs" : {
"endpoints" : {
- "us-gov-east-1" : {
+ "fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
+ "deprecated" : true,
"hostname" : "logs.us-gov-east-1.amazonaws.com"
},
- "us-gov-west-1" : {
+ "fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
+ "deprecated" : true,
"hostname" : "logs.us-gov-west-1.amazonaws.com"
+ },
+ "us-gov-east-1" : {
+ "variants" : [ {
+ "hostname" : "logs.us-gov-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-west-1" : {
+ "variants" : [ {
+ "hostname" : "logs.us-gov-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
}
}
},
@@ -15742,6 +16021,36 @@
}
}
},
+ "meetings-chime" : {
+ "endpoints" : {
+ "us-gov-east-1" : {
+ "variants" : [ {
+ "hostname" : "meetings-chime-fips.us-gov-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-east-1-fips" : {
+ "credentialScope" : {
+ "region" : "us-gov-east-1"
+ },
+ "deprecated" : true,
+ "hostname" : "meetings-chime-fips.us-gov-east-1.amazonaws.com"
+ },
+ "us-gov-west-1" : {
+ "variants" : [ {
+ "hostname" : "meetings-chime-fips.us-gov-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-west-1-fips" : {
+ "credentialScope" : {
+ "region" : "us-gov-west-1"
+ },
+ "deprecated" : true,
+ "hostname" : "meetings-chime-fips.us-gov-west-1.amazonaws.com"
+ }
+ }
+ },
"metering.marketplace" : {
"defaults" : {
"credentialScope" : {
@@ -16685,22 +16994,42 @@
},
"sns" : {
"endpoints" : {
- "us-gov-east-1" : {
+ "fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
+ "deprecated" : true,
"hostname" : "sns.us-gov-east-1.amazonaws.com"
},
- "us-gov-west-1" : {
+ "fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
- "hostname" : "sns.us-gov-west-1.amazonaws.com",
- "protocols" : [ "http", "https" ]
+ "deprecated" : true,
+ "hostname" : "sns.us-gov-west-1.amazonaws.com"
+ },
+ "us-gov-east-1" : {
+ "variants" : [ {
+ "hostname" : "sns.us-gov-east-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
+ },
+ "us-gov-west-1" : {
+ "protocols" : [ "http", "https" ],
+ "variants" : [ {
+ "hostname" : "sns.us-gov-west-1.amazonaws.com",
+ "tags" : [ "fips" ]
+ } ]
}
}
},
"sqs" : {
+ "defaults" : {
+ "variants" : [ {
+ "hostname" : "sqs.{region}.{dnsSuffix}",
+ "tags" : [ "fips" ]
+ } ]
+ },
"endpoints" : {
"us-gov-east-1" : {
"credentialScope" : {
@@ -17635,6 +17964,11 @@
"us-iso-east-1" : { }
}
},
+ "tagging" : {
+ "endpoints" : {
+ "us-iso-east-1" : { }
+ }
+ },
"transcribe" : {
"defaults" : {
"protocols" : [ "https" ]
diff --git a/contrib/python/botocore/py3/botocore/data/evidently/2021-02-01/service-2.json b/contrib/python/botocore/py3/botocore/data/evidently/2021-02-01/service-2.json
index 7bbd49c09c..08c04ab945 100644
--- a/contrib/python/botocore/py3/botocore/data/evidently/2021-02-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/evidently/2021-02-01/service-2.json
@@ -112,6 +112,7 @@
"input":{"shape":"DeleteExperimentRequest"},
"output":{"shape":"DeleteExperimentResponse"},
"errors":[
+ {"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ConflictException"},
{"shape":"ServiceUnavailableException"},
@@ -207,6 +208,7 @@
"output":{"shape":"GetExperimentResponse"},
"errors":[
{"shape":"ThrottlingException"},
+ {"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
@@ -258,6 +260,7 @@
"output":{"shape":"GetLaunchResponse"},
"errors":[
{"shape":"ThrottlingException"},
+ {"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
@@ -291,7 +294,8 @@
"output":{"shape":"ListExperimentsResponse"},
"errors":[
{"shape":"ValidationException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"}
],
"documentation":"<p>Returns configuration details about all the experiments in the specified project.</p>"
},
@@ -409,6 +413,7 @@
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
+ {"shape":"ConflictException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
@@ -1313,7 +1318,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"ExperimentReport":{
"type":"structure",
@@ -1527,7 +1532,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"FeatureStatus":{
"type":"string",
@@ -1788,7 +1793,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"GroupToWeightMap":{
"type":"map",
@@ -1975,7 +1980,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"LaunchStatus":{
"type":"string",
@@ -2023,6 +2028,12 @@
"documentation":"<p>The name or ARN of the project to return the experiment list from.</p>",
"location":"uri",
"locationName":"project"
+ },
+ "status":{
+ "shape":"ExperimentStatus",
+ "documentation":"<p>Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.</p>",
+ "location":"querystring",
+ "locationName":"status"
}
}
},
@@ -2097,6 +2108,12 @@
"documentation":"<p>The name or ARN of the project to return the launch list from.</p>",
"location":"uri",
"locationName":"project"
+ },
+ "status":{
+ "shape":"LaunchStatus",
+ "documentation":"<p>Use this optional parameter to limit the returned results to only the launches with the status that you specify here.</p>",
+ "location":"querystring",
+ "locationName":"status"
}
}
},
@@ -2221,6 +2238,11 @@
},
"MetricDefinitionConfig":{
"type":"structure",
+ "required":[
+ "entityIdKey",
+ "name",
+ "valueKey"
+ ],
"members":{
"entityIdKey":{
"shape":"JsonPath",
@@ -2476,7 +2498,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"ProjectRef":{
"type":"string",
@@ -3078,7 +3100,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"TreatmentNameList":{
"type":"list",
@@ -3468,7 +3490,7 @@
"type":"string",
"max":127,
"min":1,
- "pattern":"[-a-zA-Z0-9._]*"
+ "pattern":"^[-a-zA-Z0-9._]*$"
},
"VariationNameList":{
"type":"list",
diff --git a/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/paginators-1.json b/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/paginators-1.json
index 59f6af47df..aa6632a20c 100644
--- a/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/paginators-1.json
@@ -17,6 +17,18 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "datasets"
+ },
+ "ListPermissionGroups": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "limit_key": "maxResults",
+ "result_key": "permissionGroups"
+ },
+ "ListUsers": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "limit_key": "maxResults",
+ "result_key": "users"
}
}
}
diff --git a/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/service-2.json b/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/service-2.json
index 90814ca7fc..9b2657cd69 100644
--- a/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/finspace-data/2020-07-13/service-2.json
@@ -69,6 +69,42 @@
],
"documentation":"<p>Creates a new FinSpace Dataset.</p>"
},
+ "CreatePermissionGroup":{
+ "name":"CreatePermissionGroup",
+ "http":{
+ "method":"POST",
+ "requestUri":"/permission-group"
+ },
+ "input":{"shape":"CreatePermissionGroupRequest"},
+ "output":{"shape":"CreatePermissionGroupResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"LimitExceededException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Creates a group of permissions for various actions that a user can perform in FinSpace.</p>"
+ },
+ "CreateUser":{
+ "name":"CreateUser",
+ "http":{
+ "method":"POST",
+ "requestUri":"/user"
+ },
+ "input":{"shape":"CreateUserRequest"},
+ "output":{"shape":"CreateUserResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"LimitExceededException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Creates a new user in FinSpace.</p>"
+ },
"DeleteDataset":{
"name":"DeleteDataset",
"http":{
@@ -88,6 +124,62 @@
],
"documentation":"<p>Deletes a FinSpace Dataset.</p>"
},
+ "DeletePermissionGroup":{
+ "name":"DeletePermissionGroup",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/permission-group/{permissionGroupId}"
+ },
+ "input":{"shape":"DeletePermissionGroupRequest"},
+ "output":{"shape":"DeletePermissionGroupResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"LimitExceededException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Deletes a permission group. This action is irreversible.</p>"
+ },
+ "DisableUser":{
+ "name":"DisableUser",
+ "http":{
+ "method":"POST",
+ "requestUri":"/user/{userId}/disable"
+ },
+ "input":{"shape":"DisableUserRequest"},
+ "output":{"shape":"DisableUserResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Denies access to the FinSpace web application and API for the specified user.</p>"
+ },
+ "EnableUser":{
+ "name":"EnableUser",
+ "http":{
+ "method":"POST",
+ "requestUri":"/user/{userId}/enable"
+ },
+ "input":{"shape":"EnableUserRequest"},
+ "output":{"shape":"EnableUserResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"LimitExceededException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p> Allows the specified user to access the FinSpace web application and API.</p>"
+ },
"GetChangeset":{
"name":"GetChangeset",
"http":{
@@ -157,6 +249,23 @@
],
"documentation":"<p>Request programmatic credentials to use with FinSpace SDK.</p>"
},
+ "GetUser":{
+ "name":"GetUser",
+ "http":{
+ "method":"GET",
+ "requestUri":"/user/{userId}"
+ },
+ "input":{"shape":"GetUserRequest"},
+ "output":{"shape":"GetUserResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Retrieves details for a specific user.</p>"
+ },
"GetWorkingLocation":{
"name":"GetWorkingLocation",
"http":{
@@ -225,6 +334,56 @@
],
"documentation":"<p>Lists all of the active Datasets that a user has access to.</p>"
},
+ "ListPermissionGroups":{
+ "name":"ListPermissionGroups",
+ "http":{
+ "method":"GET",
+ "requestUri":"/permission-group"
+ },
+ "input":{"shape":"ListPermissionGroupsRequest"},
+ "output":{"shape":"ListPermissionGroupsResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"}
+ ],
+ "documentation":"<p>Lists all available permission groups in FinSpace.</p>"
+ },
+ "ListUsers":{
+ "name":"ListUsers",
+ "http":{
+ "method":"GET",
+ "requestUri":"/user"
+ },
+ "input":{"shape":"ListUsersRequest"},
+ "output":{"shape":"ListUsersResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"}
+ ],
+ "documentation":"<p>Lists all available user accounts in FinSpace.</p>"
+ },
+ "ResetUserPassword":{
+ "name":"ResetUserPassword",
+ "http":{
+ "method":"POST",
+ "requestUri":"/user/{userId}/password"
+ },
+ "input":{"shape":"ResetUserPasswordRequest"},
+ "output":{"shape":"ResetUserPasswordResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.</p>"
+ },
"UpdateChangeset":{
"name":"UpdateChangeset",
"http":{
@@ -260,6 +419,42 @@
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates a FinSpace Dataset.</p>"
+ },
+ "UpdatePermissionGroup":{
+ "name":"UpdatePermissionGroup",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/permission-group/{permissionGroupId}"
+ },
+ "input":{"shape":"UpdatePermissionGroupRequest"},
+ "output":{"shape":"UpdatePermissionGroupResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Modifies the details of a permission group. You cannot modify a <code>permissionGroupID</code>.</p>"
+ },
+ "UpdateUser":{
+ "name":"UpdateUser",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/user/{userId}"
+ },
+ "input":{"shape":"UpdateUserRequest"},
+ "output":{"shape":"UpdateUserResponse"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ValidationException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ConflictException"}
+ ],
+ "documentation":"<p>Modifies the details of the specified user account. You cannot update the <code>userId</code> for a user.</p>"
}
},
"shapes":{
@@ -278,6 +473,29 @@
"min":1,
"pattern":"^alias\\/\\S+"
},
+ "ApiAccess":{
+ "type":"string",
+ "enum":[
+ "ENABLED",
+ "DISABLED"
+ ]
+ },
+ "ApplicationPermission":{
+ "type":"string",
+ "enum":[
+ "CreateDataset",
+ "ManageClusters",
+ "ManageUsersAndGroups",
+ "ManageAttributeSets",
+ "ViewAuditData",
+ "AccessNotebooks",
+ "GetTemporaryCredentials"
+ ]
+ },
+ "ApplicationPermissionList":{
+ "type":"list",
+ "member":{"shape":"ApplicationPermission"}
+ },
"Boolean":{
"type":"boolean",
"documentation":"Common Boolean data type"
@@ -304,7 +522,7 @@
},
"errorCategory":{
"shape":"ErrorCategory",
- "documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> -The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> - Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> - Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> - A user recoverable error has occurred.</p> </li> </ul>"
+ "documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> – The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> – Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> – Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> – One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> – The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> – An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> – Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p> </li> </ul>"
}
},
"documentation":"<p>The structure with error messages.</p>"
@@ -337,7 +555,7 @@
},
"changeType":{
"shape":"ChangeType",
- "documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
+ "documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
},
"sourceParams":{
"shape":"SourceParams",
@@ -349,11 +567,11 @@
},
"createTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"status":{
"shape":"IngestionStatus",
- "documentation":"<p>Status of the Changeset ingestion.</p> <ul> <li> <p> <code>PENDING</code> - Changeset is pending creation.</p> </li> <li> <p> <code>FAILED</code> - Changeset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> - Changeset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> - Changeset creation is running.</p> </li> <li> <p> <code>STOP_REQUESTED</code> - User requested Changeset creation to stop.</p> </li> </ul>"
+ "documentation":"<p>Status of the Changeset ingestion.</p> <ul> <li> <p> <code>PENDING</code> – Changeset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Changeset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Changeset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Changeset creation is running.</p> </li> <li> <p> <code>STOP_REQUESTED</code> – User requested Changeset creation to stop.</p> </li> </ul>"
},
"errorInfo":{
"shape":"ChangesetErrorInfo",
@@ -361,12 +579,12 @@
},
"activeUntilTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"activeFromTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"updatesChangesetId":{
@@ -410,11 +628,11 @@
"members":{
"dataType":{
"shape":"ColumnDataType",
- "documentation":"<p>Data type of a column.</p> <ul> <li> <p> <code>STRING</code> - A String data type.</p> <p> <code>CHAR</code> - A char data type.</p> <p> <code>INTEGER</code> - An integer data type.</p> <p> <code>TINYINT</code> - A tinyint data type.</p> <p> <code>SMALLINT</code> - A smallint data type.</p> <p> <code>BIGINT</code> - A bigint data type.</p> <p> <code>FLOAT</code> - A float data type.</p> <p> <code>DOUBLE</code> - A double data type.</p> <p> <code>DATE</code> - A date data type.</p> <p> <code>DATETIME</code> - A datetime data type.</p> <p> <code>BOOLEAN</code> - A boolean data type.</p> <p> <code>BINARY</code> - A binary data type.</p> </li> </ul>"
+ "documentation":"<p>Data type of a column.</p> <ul> <li> <p> <code>STRING</code> – A String data type.</p> <p> <code>CHAR</code> – A char data type.</p> <p> <code>INTEGER</code> – An integer data type.</p> <p> <code>TINYINT</code> – A tinyint data type.</p> <p> <code>SMALLINT</code> – A smallint data type.</p> <p> <code>BIGINT</code> – A bigint data type.</p> <p> <code>FLOAT</code> – A float data type.</p> <p> <code>DOUBLE</code> – A double data type.</p> <p> <code>DATE</code> – A date data type.</p> <p> <code>DATETIME</code> – A datetime data type.</p> <p> <code>BOOLEAN</code> – A boolean data type.</p> <p> <code>BINARY</code> – A binary data type.</p> </li> </ul>"
},
"columnName":{
"shape":"ColumnName",
- "documentation":"<p>Name for a column.</p>"
+ "documentation":"<p>The name of a column.</p>"
},
"columnDescription":{
"shape":"ColumnDescription",
@@ -448,7 +666,8 @@
"ConflictException":{
"type":"structure",
"members":{
- "message":{"shape":"errorMessage"}
+ "message":{"shape":"errorMessage"},
+ "reason":{"shape":"errorMessage"}
},
"documentation":"<p>The request conflicts with an existing resource.</p>",
"error":{"httpStatusCode":409},
@@ -476,15 +695,15 @@
},
"changeType":{
"shape":"ChangeType",
- "documentation":"<p>Option to indicate how a Changeset will be applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset will be considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset will be considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
+ "documentation":"<p>The option to indicate how a Changeset will be applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset will be considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset will be considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
},
"sourceParams":{
"shape":"SourceParams",
- "documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>"
+ "documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a> section.</p>"
},
"formatParams":{
"shape":"FormatParams",
- "documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
+ "documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> – Parquet source file format.</p> </li> <li> <p> <code>CSV</code> – CSV source file format.</p> </li> <li> <p> <code>JSON</code> – JSON source file format.</p> </li> <li> <p> <code>XML</code> – XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
}
},
"documentation":"The request for a CreateChangeset operation."
@@ -535,7 +754,7 @@
},
"asOfTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Beginning time to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"destinationTypeParams":{
@@ -578,7 +797,7 @@
},
"kind":{
"shape":"DatasetKind",
- "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
+ "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
@@ -613,6 +832,88 @@
},
"documentation":"The response from a CreateDataset operation"
},
+ "CreatePermissionGroupRequest":{
+ "type":"structure",
+ "required":[
+ "name",
+ "applicationPermissions"
+ ],
+ "members":{
+ "name":{
+ "shape":"PermissionGroupName",
+ "documentation":"<p>The name of the permission group.</p>"
+ },
+ "description":{
+ "shape":"PermissionGroupDescription",
+ "documentation":"<p>A brief description for the permission group.</p>"
+ },
+ "applicationPermissions":{
+ "shape":"ApplicationPermissionList",
+ "documentation":"<p>The option to indicate FinSpace application permissions that are granted to a specific group.</p> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "CreatePermissionGroupResponse":{
+ "type":"structure",
+ "members":{
+ "permissionGroupId":{
+ "shape":"PermissionGroupId",
+ "documentation":"<p>The unique identifier for the permission group.</p>"
+ }
+ }
+ },
+ "CreateUserRequest":{
+ "type":"structure",
+ "required":[
+ "emailAddress",
+ "type"
+ ],
+ "members":{
+ "emailAddress":{
+ "shape":"Email",
+ "documentation":"<p>The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>"
+ },
+ "type":{
+ "shape":"UserType",
+ "documentation":"<p>The option to indicate the type of user. Use one of the following options to specify this parameter:</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>"
+ },
+ "firstName":{
+ "shape":"FirstName",
+ "documentation":"<p>The first name of the user that you want to register.</p>"
+ },
+ "lastName":{
+ "shape":"LastName",
+ "documentation":"<p>The last name of the user that you want to register.</p>"
+ },
+ "ApiAccess":{
+ "shape":"ApiAccess",
+ "documentation":"<p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>"
+ },
+ "apiAccessPrincipalArn":{
+ "shape":"RoleArn",
+ "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "CreateUserResponse":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the user.</p>"
+ }
+ }
+ },
"Credentials":{
"type":"structure",
"members":{
@@ -645,11 +946,11 @@
"members":{
"destinationType":{
"shape":"DataViewDestinationType",
- "documentation":"<p>Destination type for a Dataview.</p> <ul> <li> <p> <code>GLUE_TABLE</code> - Glue table destination type.</p> </li> <li> <p> <code>S3</code> - S3 destination type.</p> </li> </ul>"
+ "documentation":"<p>Destination type for a Dataview.</p> <ul> <li> <p> <code>GLUE_TABLE</code> – Glue table destination type.</p> </li> <li> <p> <code>S3</code> – S3 destination type.</p> </li> </ul>"
},
"s3DestinationExportFileFormat":{
"shape":"ExportFileFormat",
- "documentation":"<p>Data view export file format.</p> <ul> <li> <p> <code>PARQUET</code> - Parquet export file format.</p> </li> <li> <p> <code>DELIMITED_TEXT</code> - Delimited text export file format.</p> </li> </ul>"
+ "documentation":"<p>Data view export file format.</p> <ul> <li> <p> <code>PARQUET</code> – Parquet export file format.</p> </li> <li> <p> <code>DELIMITED_TEXT</code> – Delimited text export file format.</p> </li> </ul>"
},
"s3DestinationExportFileFormatOptions":{
"shape":"S3DestinationFormatOptions",
@@ -667,7 +968,7 @@
},
"errorCategory":{
"shape":"ErrorCategory",
- "documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> -The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> - Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> - Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> - A user recoverable error has occurred.</p> </li> </ul>"
+ "documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> – The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> – Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> – Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> – One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> – The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> – An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> – Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p> </li> </ul>"
}
},
"documentation":"<p>The structure with error messages.</p>"
@@ -714,7 +1015,7 @@
},
"asOfTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"partitionColumns":{
@@ -727,7 +1028,7 @@
},
"status":{
"shape":"DataViewStatus",
- "documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> - Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> - Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> - Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> - Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> - Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> - Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> - Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed.</p> </li> </ul>"
+ "documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> – Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> – Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> – Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> – Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> – Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> – Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> – Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p> </li> </ul>"
},
"errorInfo":{
"shape":"DataViewErrorInfo",
@@ -743,11 +1044,11 @@
},
"createTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
}
},
"documentation":"<p>Structure for the summary of a Dataview.</p>"
@@ -769,7 +1070,7 @@
},
"kind":{
"shape":"DatasetKind",
- "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
+ "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
@@ -781,11 +1082,11 @@
},
"createTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"schemaDefinition":{
"shape":"SchemaUnion",
@@ -833,7 +1134,7 @@
"members":{
"name":{
"shape":"OwnerName",
- "documentation":"<p>Name of the Dataset owner.</p>"
+ "documentation":"<p>The name of the Dataset owner.</p>"
},
"phoneNumber":{
"shape":"PhoneNumber",
@@ -893,12 +1194,92 @@
},
"documentation":"The response from an DeleteDataset operation"
},
+ "DeletePermissionGroupRequest":{
+ "type":"structure",
+ "required":["permissionGroupId"],
+ "members":{
+ "permissionGroupId":{
+ "shape":"PermissionGroupId",
+ "documentation":"<p>The unique identifier for the permission group that you want to delete.</p>",
+ "location":"uri",
+ "locationName":"permissionGroupId"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true,
+ "location":"querystring",
+ "locationName":"clientToken"
+ }
+ }
+ },
+ "DeletePermissionGroupResponse":{
+ "type":"structure",
+ "members":{
+ "permissionGroupId":{
+ "shape":"PermissionGroupId",
+ "documentation":"<p>The unique identifier for the deleted permission group.</p>"
+ }
+ }
+ },
+ "DisableUserRequest":{
+ "type":"structure",
+ "required":["userId"],
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the user account that you want to disable.</p>",
+ "location":"uri",
+ "locationName":"userId"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "DisableUserResponse":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the disabled user account.</p>"
+ }
+ }
+ },
"Email":{
"type":"string",
- "documentation":"Email of Dataset Owner",
"max":320,
"min":4,
- "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}"
+ "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}",
+ "sensitive":true
+ },
+ "EnableUserRequest":{
+ "type":"structure",
+ "required":["userId"],
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the user account that you want to enable.</p>",
+ "location":"uri",
+ "locationName":"userId"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "EnableUserResponse":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the enabled user account.</p>"
+ }
+ }
},
"ErrorCategory":{
"type":"string",
@@ -927,6 +1308,13 @@
"DELIMITED_TEXT"
]
},
+ "FirstName":{
+ "type":"string",
+ "max":50,
+ "min":1,
+ "pattern":".*\\S.*",
+ "sensitive":true
+ },
"FormatParams":{
"type":"map",
"key":{"shape":"StringMapKey"},
@@ -972,7 +1360,7 @@
},
"changeType":{
"shape":"ChangeType",
- "documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
+ "documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
},
"sourceParams":{
"shape":"SourceParams",
@@ -984,7 +1372,7 @@
},
"createTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"status":{
"shape":"IngestionStatus",
@@ -996,12 +1384,12 @@
},
"activeUntilTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"activeFromTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"updatesChangesetId":{
@@ -1054,7 +1442,7 @@
},
"asOfTimestamp":{
"shape":"TimestampEpoch",
- "documentation":"<p>Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
+ "documentation":"<p>Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
"box":true
},
"errorInfo":{
@@ -1063,11 +1451,11 @@
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"createTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"sortColumns":{
"shape":"SortColumnList",
@@ -1087,7 +1475,7 @@
},
"status":{
"shape":"DataViewStatus",
- "documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> - Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> - Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> - Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> - Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> - Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> - Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> - Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed.</p> </li> </ul>"
+ "documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> – Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> – Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> – Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> – Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> – Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> – Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> – Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p> </li> </ul>"
}
},
"documentation":"Response from retrieving a dataview, which includes details on the target database and table name"
@@ -1122,7 +1510,7 @@
},
"kind":{
"shape":"DatasetKind",
- "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
+ "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
@@ -1130,11 +1518,11 @@
},
"createTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
- "documentation":"<p>The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
+ "documentation":"<p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
},
"schemaDefinition":{
"shape":"SchemaUnion",
@@ -1146,7 +1534,7 @@
},
"status":{
"shape":"DatasetStatus",
- "documentation":"<p>Status of the Dataset creation.</p> <ul> <li> <p> <code>PENDING</code> - Dataset is pending creation.</p> </li> <li> <p> <code>FAILED</code> - Dataset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> - Dataset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> - Dataset creation is running.</p> </li> </ul>"
+ "documentation":"<p>Status of the Dataset creation.</p> <ul> <li> <p> <code>PENDING</code> – Dataset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Dataset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Dataset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Dataset creation is running.</p> </li> </ul>"
}
},
"documentation":"Response for the GetDataset operation"
@@ -1184,12 +1572,81 @@
},
"documentation":"Response for GetProgrammaticAccessCredentials operation"
},
+ "GetUserRequest":{
+ "type":"structure",
+ "required":["userId"],
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier of the user to get data for.</p>",
+ "location":"uri",
+ "locationName":"userId"
+ }
+ }
+ },
+ "GetUserResponse":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the user account that is retrieved.</p>"
+ },
+ "status":{
+ "shape":"UserStatus",
+ "documentation":"<p>The current status of the user account. </p> <ul> <li> <p> <code>CREATING</code> – The user account creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user account is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user account is currently inactive.</p> </li> </ul>"
+ },
+ "firstName":{
+ "shape":"FirstName",
+ "documentation":"<p>The first name of the user.</p>"
+ },
+ "lastName":{
+ "shape":"LastName",
+ "documentation":"<p>The last name of the user.</p>"
+ },
+ "emailAddress":{
+ "shape":"Email",
+ "documentation":"<p>The email address that is associated with the user.</p>"
+ },
+ "type":{
+ "shape":"UserType",
+ "documentation":"<p>Indicates the type of user. </p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> </ul> <ul> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.</p> </li> </ul>"
+ },
+ "apiAccess":{
+ "shape":"ApiAccess",
+ "documentation":"<p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations. </p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>"
+ },
+ "apiAccessPrincipalArn":{
+ "shape":"RoleArn",
+ "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>"
+ },
+ "createTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds. </p>"
+ },
+ "lastEnabledTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.</p>"
+ },
+ "lastDisabledTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.</p>"
+ },
+ "lastModifiedTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.</p>"
+ },
+ "lastLoginTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>"
+ }
+ }
+ },
"GetWorkingLocationRequest":{
"type":"structure",
"members":{
"locationType":{
"shape":"locationType",
- "documentation":"<p>Specify the type of the working location.</p> <ul> <li> <p> <code>SAGEMAKER</code> - Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</p> </li> <li> <p> <code>INGESTION</code> - Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.</p> </li> </ul>"
+ "documentation":"<p>Specify the type of the working location.</p> <ul> <li> <p> <code>SAGEMAKER</code> – Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</p> </li> <li> <p> <code>INGESTION</code> – Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.</p> </li> </ul>"
}
}
},
@@ -1235,6 +1692,13 @@
"error":{"httpStatusCode":500},
"exception":true
},
+ "LastName":{
+ "type":"string",
+ "max":50,
+ "min":1,
+ "pattern":".*\\S.*",
+ "sensitive":true
+ },
"LimitExceededException":{
"type":"structure",
"members":{
@@ -1263,7 +1727,7 @@
},
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>A token indicating where a results page should begin.</p>",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@@ -1279,7 +1743,7 @@
},
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>A token indicating where a results page should begin.</p>"
+ "documentation":"<p>A token that indicates where a results page should begin.</p>"
}
},
"documentation":"Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria."
@@ -1296,7 +1760,7 @@
},
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>A token indicating where a results page should begin.</p>",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@@ -1315,7 +1779,7 @@
"members":{
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>A token indicating where a results page should begin.</p>"
+ "documentation":"<p>A token that indicates where a results page should begin.</p>"
},
"dataViews":{
"shape":"DataViewList",
@@ -1328,7 +1792,7 @@
"members":{
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>A token indicating where a results page should begin.</p>",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@@ -1351,11 +1815,73 @@
},
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>A token indicating where a results page should begin.</p>"
+ "documentation":"<p>A token that indicates where a results page should begin.</p>"
}
},
"documentation":"Response for the ListDatasets operation"
},
+ "ListPermissionGroupsRequest":{
+ "type":"structure",
+ "required":["maxResults"],
+ "members":{
+ "nextToken":{
+ "shape":"PaginationToken",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>",
+ "location":"querystring",
+ "locationName":"nextToken"
+ },
+ "maxResults":{
+ "shape":"ResultLimit",
+ "documentation":"<p>The maximum number of results per page.</p>",
+ "location":"querystring",
+ "locationName":"maxResults"
+ }
+ }
+ },
+ "ListPermissionGroupsResponse":{
+ "type":"structure",
+ "members":{
+ "permissionGroups":{
+ "shape":"PermissionGroupList",
+ "documentation":"<p>A list of all the permission groups.</p>"
+ },
+ "nextToken":{
+ "shape":"PaginationToken",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>"
+ }
+ }
+ },
+ "ListUsersRequest":{
+ "type":"structure",
+ "required":["maxResults"],
+ "members":{
+ "nextToken":{
+ "shape":"PaginationToken",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>",
+ "location":"querystring",
+ "locationName":"nextToken"
+ },
+ "maxResults":{
+ "shape":"ResultLimit",
+ "documentation":"<p>The maximum number of results per page.</p>",
+ "location":"querystring",
+ "locationName":"maxResults"
+ }
+ }
+ },
+ "ListUsersResponse":{
+ "type":"structure",
+ "members":{
+ "users":{
+ "shape":"UserList",
+ "documentation":"<p>A list of all the user accounts.</p>"
+ },
+ "nextToken":{
+ "shape":"PaginationToken",
+ "documentation":"<p>A token that indicates where a results page should begin.</p>"
+ }
+ }
+ },
"OwnerName":{
"type":"string",
"documentation":"1 - 250 character String",
@@ -1372,18 +1898,73 @@
"member":{"shape":"StringValueLength1to255"},
"documentation":"DataView Partition Column List"
},
+ "Password":{
+ "type":"string",
+ "max":20,
+ "min":8,
+ "pattern":".*\\S.*",
+ "sensitive":true
+ },
+ "PermissionGroup":{
+ "type":"structure",
+ "members":{
+ "permissionGroupId":{
+ "shape":"PermissionGroupId",
+ "documentation":"<p> The unique identifier for the permission group.</p>"
+ },
+ "name":{
+ "shape":"PermissionGroupName",
+ "documentation":"<p>The name of the permission group.</p>"
+ },
+ "description":{
+ "shape":"PermissionGroupDescription",
+ "documentation":"<p> A brief description for the permission group.</p>"
+ },
+ "applicationPermissions":{
+ "shape":"ApplicationPermissionList",
+ "documentation":"<p>Indicates the permissions that are granted to a specific group for accessing the FinSpace application.</p> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>"
+ },
+ "createTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds. </p>"
+ },
+ "lastModifiedTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds. </p>"
+ }
+ },
+ "documentation":"<p>The structure for a permission group.</p>"
+ },
+ "PermissionGroupDescription":{
+ "type":"string",
+ "max":4000,
+ "min":1,
+ "pattern":".*\\S.*",
+ "sensitive":true
+ },
"PermissionGroupId":{
"type":"string",
- "documentation":"Id of the associated PermissionGroup",
"max":26,
- "min":1
+ "min":1,
+ "pattern":".*\\S.*"
+ },
+ "PermissionGroupList":{
+ "type":"list",
+ "member":{"shape":"PermissionGroup"}
+ },
+ "PermissionGroupName":{
+ "type":"string",
+ "max":255,
+ "min":1,
+ "pattern":".*\\S.*",
+ "sensitive":true
},
"PermissionGroupParams":{
"type":"structure",
"members":{
"permissionGroupId":{
"shape":"PermissionGroupId",
- "documentation":"<p>The unique identifier of the PermissionGroup.</p>"
+ "documentation":"<p>The unique identifier for the <code>PermissionGroup</code>.</p>"
},
"datasetPermissions":{
"shape":"ResourcePermissionsList",
@@ -1399,10 +1980,41 @@
"min":10,
"pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$"
},
+ "ResetUserPasswordRequest":{
+ "type":"structure",
+ "required":["userId"],
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier of the user that a temporary password is requested for.</p>",
+ "location":"uri",
+ "locationName":"userId"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "ResetUserPasswordResponse":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier of the user that a new password is generated for.</p>"
+ },
+ "temporaryPassword":{
+ "shape":"Password",
+ "documentation":"<p>A randomly generated temporary password for the requested user account. This password expires in 7 days.</p>"
+ }
+ }
+ },
"ResourceNotFoundException":{
"type":"structure",
"members":{
- "message":{"shape":"errorMessage"}
+ "message":{"shape":"errorMessage"},
+ "reason":{"shape":"errorMessage"}
},
"documentation":"<p>One or more resources can't be found.</p>",
"error":{"httpStatusCode":404},
@@ -1416,7 +2028,7 @@
"documentation":"<p>Permission for a resource.</p>"
}
},
- "documentation":"<p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p> <p>The following is a list of valid dataset permissions that you can apply: </p> <ul> <li> <p> <code>ViewDatasetDetails</code> </p> </li> <li> <p> <code>ReadDatasetDetails</code> </p> </li> <li> <p> <code>AddDatasetData</code> </p> </li> <li> <p> <code>CreateSnapshot</code> </p> </li> <li> <p> <code>EditDatasetMetadata</code> </p> </li> <li> <p> <code>DeleteDataset</code> </p> </li> </ul> <p>For more information on the ataset permissions, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions\">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>"
+ "documentation":"<p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p> <p>The following is a list of valid dataset permissions that you can apply: </p> <ul> <li> <p> <code>ViewDatasetDetails</code> </p> </li> <li> <p> <code>ReadDatasetDetails</code> </p> </li> <li> <p> <code>AddDatasetData</code> </p> </li> <li> <p> <code>CreateSnapshot</code> </p> </li> <li> <p> <code>EditDatasetMetadata</code> </p> </li> <li> <p> <code>DeleteDataset</code> </p> </li> </ul> <p>For more information on the dataset permissions, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions\">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>"
},
"ResourcePermissionsList":{
"type":"list",
@@ -1429,6 +2041,12 @@
"max":100,
"min":1
},
+ "RoleArn":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$"
+ },
"S3DestinationFormatOptions":{
"type":"map",
"key":{"shape":"StringMapKey"},
@@ -1542,7 +2160,7 @@
},
"formatParams":{
"shape":"FormatParams",
- "documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
+ "documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> – Parquet source file format.</p> </li> <li> <p> <code>CSV</code> – CSV source file format.</p> </li> <li> <p> <code>JSON</code> – JSON source file format.</p> </li> <li> <p> <code>XML</code> – XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
}
},
"documentation":"Request to update an existing changeset."
@@ -1586,7 +2204,7 @@
},
"kind":{
"shape":"DatasetKind",
- "documentation":"<p>The format in which the Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
+ "documentation":"<p>The format in which the Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
@@ -1613,10 +2231,178 @@
},
"documentation":"The response from an UpdateDataset operation"
},
+ "UpdatePermissionGroupRequest":{
+ "type":"structure",
+ "required":["permissionGroupId"],
+ "members":{
+ "permissionGroupId":{
+ "shape":"PermissionGroupId",
+ "documentation":"<p>The unique identifier for the permission group to update.</p>",
+ "location":"uri",
+ "locationName":"permissionGroupId"
+ },
+ "name":{
+ "shape":"PermissionGroupName",
+ "documentation":"<p>The name of the permission group.</p>"
+ },
+ "description":{
+ "shape":"PermissionGroupDescription",
+ "documentation":"<p>A brief description for the permission group.</p>"
+ },
+ "applicationPermissions":{
+ "shape":"ApplicationPermissionList",
+ "documentation":"<p>The permissions that are granted to a specific group for accessing the FinSpace application.</p> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "UpdatePermissionGroupResponse":{
+ "type":"structure",
+ "members":{
+ "permissionGroupId":{
+ "shape":"PermissionGroupId",
+ "documentation":"<p>The unique identifier for the updated permission group.</p>"
+ }
+ }
+ },
+ "UpdateUserRequest":{
+ "type":"structure",
+ "required":["userId"],
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the user account to update.</p>",
+ "location":"uri",
+ "locationName":"userId"
+ },
+ "type":{
+ "shape":"UserType",
+ "documentation":"<p>The option to indicate the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code>– A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.</p> </li> </ul>"
+ },
+ "firstName":{
+ "shape":"FirstName",
+ "documentation":"<p>The first name of the user.</p>"
+ },
+ "lastName":{
+ "shape":"LastName",
+ "documentation":"<p>The last name of the user.</p>"
+ },
+ "apiAccess":{
+ "shape":"ApiAccess",
+ "documentation":"<p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>"
+ },
+ "apiAccessPrincipalArn":{
+ "shape":"RoleArn",
+ "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>"
+ },
+ "clientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
+ "idempotencyToken":true
+ }
+ }
+ },
+ "UpdateUserResponse":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier of the updated user account.</p>"
+ }
+ }
+ },
+ "User":{
+ "type":"structure",
+ "members":{
+ "userId":{
+ "shape":"UserId",
+ "documentation":"<p>The unique identifier for the user.</p>"
+ },
+ "status":{
+ "shape":"UserStatus",
+ "documentation":"<p>The current status of the user account. </p> <ul> <li> <p> <code>CREATING</code> – The user account creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user account is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user account is currently inactive.</p> </li> </ul>"
+ },
+ "firstName":{
+ "shape":"FirstName",
+ "documentation":"<p>The first name of the user.</p>"
+ },
+ "lastName":{
+ "shape":"LastName",
+ "documentation":"<p> The last name of the user.</p>"
+ },
+ "emailAddress":{
+ "shape":"Email",
+ "documentation":"<p>The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>"
+ },
+ "type":{
+ "shape":"UserType",
+ "documentation":"<p> Indicates the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.</p> </li> </ul>"
+ },
+ "apiAccess":{
+ "shape":"ApiAccess",
+ "documentation":"<p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>"
+ },
+ "apiAccessPrincipalArn":{
+ "shape":"RoleArn",
+ "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>"
+ },
+ "createTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds. </p>"
+ },
+ "lastEnabledTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p> Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds. </p>"
+ },
+ "lastDisabledTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.</p>"
+ },
+ "lastModifiedTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time the user account was updated. The value is determined as epoch time in milliseconds. </p>"
+ },
+ "lastLoginTime":{
+ "shape":"TimestampEpoch",
+ "documentation":"<p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds. </p>"
+ }
+ },
+ "documentation":"<p>The details of the user account.</p>"
+ },
+ "UserId":{
+ "type":"string",
+ "max":26,
+ "min":1,
+ "pattern":".*\\S.*"
+ },
+ "UserList":{
+ "type":"list",
+ "member":{"shape":"User"}
+ },
+ "UserStatus":{
+ "type":"string",
+ "enum":[
+ "CREATING",
+ "ENABLED",
+ "DISABLED"
+ ]
+ },
+ "UserType":{
+ "type":"string",
+ "enum":[
+ "SUPER_USER",
+ "APP_USER"
+ ]
+ },
"ValidationException":{
"type":"structure",
"members":{
- "message":{"shape":"errorMessage"}
+ "message":{"shape":"errorMessage"},
+ "reason":{"shape":"errorMessage"}
},
"documentation":"<p>The input fails to satisfy the constraints specified by an AWS service.</p>",
"error":{"httpStatusCode":400},
diff --git a/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json b/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json
index c8d7023bc4..7259e73377 100644
--- a/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json
@@ -363,6 +363,12 @@
"min":1,
"pattern":"[\\S]+"
},
+ "CloudWatchLogGroupArn":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"[\\S]+"
+ },
"ConflictException":{
"type":"structure",
"members":{
@@ -404,6 +410,25 @@
"key":{"shape":"ExperimentTemplateActionName"},
"value":{"shape":"CreateExperimentTemplateActionInput"}
},
+ "CreateExperimentTemplateLogConfigurationInput":{
+ "type":"structure",
+ "required":["logSchemaVersion"],
+ "members":{
+ "cloudWatchLogsConfiguration":{
+ "shape":"ExperimentTemplateCloudWatchLogsLogConfigurationInput",
+ "documentation":"<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
+ "s3Configuration":{
+ "shape":"ExperimentTemplateS3LogConfigurationInput",
+ "documentation":"<p>The configuration for experiment logging to Amazon S3.</p>"
+ },
+ "logSchemaVersion":{
+ "shape":"LogSchemaVersion",
+ "documentation":"<p>The schema version.</p>"
+ }
+ },
+ "documentation":"<p>Specifies the configuration for experiment logging.</p>"
+ },
"CreateExperimentTemplateRequest":{
"type":"structure",
"required":[
@@ -442,6 +467,10 @@
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags to apply to the experiment template.</p>"
+ },
+ "logConfiguration":{
+ "shape":"CreateExperimentTemplateLogConfigurationInput",
+ "documentation":"<p>The configuration for experiment logging.</p>"
}
}
},
@@ -585,6 +614,10 @@
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the experiment.</p>"
+ },
+ "logConfiguration":{
+ "shape":"ExperimentLogConfiguration",
+ "documentation":"<p>The configuration for experiment logging.</p>"
}
},
"documentation":"<p>Describes an experiment.</p>"
@@ -710,12 +743,54 @@
"max":64,
"pattern":"[\\S]+"
},
+ "ExperimentCloudWatchLogsLogConfiguration":{
+ "type":"structure",
+ "members":{
+ "logGroupArn":{
+ "shape":"CloudWatchLogGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
"ExperimentEndTime":{"type":"timestamp"},
"ExperimentId":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
+ "ExperimentLogConfiguration":{
+ "type":"structure",
+ "members":{
+ "cloudWatchLogsConfiguration":{
+ "shape":"ExperimentCloudWatchLogsLogConfiguration",
+ "documentation":"<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
+ "s3Configuration":{
+ "shape":"ExperimentS3LogConfiguration",
+ "documentation":"<p>The configuration for experiment logging to Amazon S3.</p>"
+ },
+ "logSchemaVersion":{
+ "shape":"LogSchemaVersion",
+ "documentation":"<p>The schema version.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration for experiment logging.</p>"
+ },
+ "ExperimentS3LogConfiguration":{
+ "type":"structure",
+ "members":{
+ "bucketName":{
+ "shape":"S3BucketName",
+ "documentation":"<p>The name of the destination bucket.</p>"
+ },
+ "prefix":{
+ "shape":"S3ObjectKey",
+ "documentation":"<p>The bucket prefix.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration for experiment logging to Amazon S3.</p>"
+ },
"ExperimentStartTime":{"type":"timestamp"},
"ExperimentState":{
"type":"structure",
@@ -926,6 +1001,10 @@
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the experiment template.</p>"
+ },
+ "logConfiguration":{
+ "shape":"ExperimentTemplateLogConfiguration",
+ "documentation":"<p>The configuration for experiment logging.</p>"
}
},
"documentation":"<p>Describes an experiment template.</p>"
@@ -1005,6 +1084,27 @@
"max":64,
"pattern":"[\\S]+"
},
+ "ExperimentTemplateCloudWatchLogsLogConfiguration":{
+ "type":"structure",
+ "members":{
+ "logGroupArn":{
+ "shape":"CloudWatchLogGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
+ "ExperimentTemplateCloudWatchLogsLogConfigurationInput":{
+ "type":"structure",
+ "required":["logGroupArn"],
+ "members":{
+ "logGroupArn":{
+ "shape":"CloudWatchLogGroupArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.</p>"
+ }
+ },
+ "documentation":"<p>Specifies the configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
"ExperimentTemplateDescription":{
"type":"string",
"max":512,
@@ -1015,6 +1115,53 @@
"max":64,
"pattern":"[\\S]+"
},
+ "ExperimentTemplateLogConfiguration":{
+ "type":"structure",
+ "members":{
+ "cloudWatchLogsConfiguration":{
+ "shape":"ExperimentTemplateCloudWatchLogsLogConfiguration",
+ "documentation":"<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
+ "s3Configuration":{
+ "shape":"ExperimentTemplateS3LogConfiguration",
+ "documentation":"<p>The configuration for experiment logging to Amazon S3.</p>"
+ },
+ "logSchemaVersion":{
+ "shape":"LogSchemaVersion",
+ "documentation":"<p>The schema version.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration for experiment logging.</p>"
+ },
+ "ExperimentTemplateS3LogConfiguration":{
+ "type":"structure",
+ "members":{
+ "bucketName":{
+ "shape":"S3BucketName",
+ "documentation":"<p>The name of the destination bucket.</p>"
+ },
+ "prefix":{
+ "shape":"S3ObjectKey",
+ "documentation":"<p>The bucket prefix.</p>"
+ }
+ },
+ "documentation":"<p>Describes the configuration for experiment logging to Amazon S3.</p>"
+ },
+ "ExperimentTemplateS3LogConfigurationInput":{
+ "type":"structure",
+ "required":["bucketName"],
+ "members":{
+ "bucketName":{
+ "shape":"S3BucketName",
+ "documentation":"<p>The name of the destination bucket.</p>"
+ },
+ "prefix":{
+ "shape":"S3ObjectKey",
+ "documentation":"<p>The bucket prefix.</p>"
+ }
+ },
+ "documentation":"<p>Specifies the configuration for experiment logging to Amazon S3.</p>"
+ },
"ExperimentTemplateStopCondition":{
"type":"structure",
"members":{
@@ -1428,6 +1575,7 @@
}
}
},
+ "LogSchemaVersion":{"type":"integer"},
"NextToken":{
"type":"string",
"max":1024,
@@ -1460,6 +1608,18 @@
"min":20,
"pattern":"[\\S]+"
},
+ "S3BucketName":{
+ "type":"string",
+ "max":63,
+ "min":3,
+ "pattern":"[\\S]+"
+ },
+ "S3ObjectKey":{
+ "type":"string",
+ "max":1024,
+ "min":1,
+ "pattern":"[\\s\\S]+"
+ },
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
@@ -1707,6 +1867,24 @@
"key":{"shape":"ExperimentTemplateActionName"},
"value":{"shape":"UpdateExperimentTemplateActionInputItem"}
},
+ "UpdateExperimentTemplateLogConfigurationInput":{
+ "type":"structure",
+ "members":{
+ "cloudWatchLogsConfiguration":{
+ "shape":"ExperimentTemplateCloudWatchLogsLogConfigurationInput",
+ "documentation":"<p>The configuration for experiment logging to Amazon CloudWatch Logs.</p>"
+ },
+ "s3Configuration":{
+ "shape":"ExperimentTemplateS3LogConfigurationInput",
+ "documentation":"<p>The configuration for experiment logging to Amazon S3.</p>"
+ },
+ "logSchemaVersion":{
+ "shape":"LogSchemaVersion",
+ "documentation":"<p>The schema version.</p>"
+ }
+ },
+ "documentation":"<p>Specifies the configuration for experiment logging.</p>"
+ },
"UpdateExperimentTemplateRequest":{
"type":"structure",
"required":["id"],
@@ -1736,6 +1914,10 @@
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.</p>"
+ },
+ "logConfiguration":{
+ "shape":"UpdateExperimentTemplateLogConfigurationInput",
+ "documentation":"<p>The configuration for experiment logging.</p>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/fms/2018-01-01/service-2.json b/contrib/python/botocore/py3/botocore/data/fms/2018-01-01/service-2.json
index c3f19ef312..20d53ae454 100644
--- a/contrib/python/botocore/py3/botocore/data/fms/2018-01-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/fms/2018-01-01/service-2.json
@@ -626,10 +626,19 @@
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type. This is in the format shown in the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services Resource Types Reference</a>. For example: <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code>, <code>AWS::CloudFront::Distribution</code>, or <code>AWS::NetworkFirewall::FirewallPolicy</code>.</p>"
+ },
+ "Metadata":{
+ "shape":"ComplianceViolatorMetadata",
+ "documentation":"<p>Metadata about the resource that doesn't comply with the policy scope.</p>"
}
},
"documentation":"<p>Details of the resource that is not protected by the policy.</p>"
},
+ "ComplianceViolatorMetadata":{
+ "type":"map",
+ "key":{"shape":"LengthBoundedString"},
+ "value":{"shape":"LengthBoundedString"}
+ },
"ComplianceViolators":{
"type":"list",
"member":{"shape":"ComplianceViolator"}
@@ -1022,6 +1031,50 @@
"type":"list",
"member":{"shape":"ExpectedRoute"}
},
+ "FMSPolicyUpdateFirewallCreationConfigAction":{
+ "type":"structure",
+ "members":{
+ "Description":{
+ "shape":"LengthBoundedString",
+ "documentation":"<p>Describes the remedial action.</p>"
+ },
+ "FirewallCreationConfig":{
+ "shape":"ManagedServiceData",
+ "documentation":"<p>A <code>FirewallCreationConfig</code> that you can copy into your current policy's <a href=\"https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_SecurityServicePolicyData.html\">SecurityServiceData</a> in order to remedy scope violations.</p>"
+ }
+ },
+ "documentation":"<p>Contains information about the actions that you can take to remediate scope violations caused by your policy's <code>FirewallCreationConfig</code>. <code>FirewallCreationConfig</code> is an optional configuration that you can use to choose which Availability Zones Firewall Manager creates Network Firewall endpoints in.</p>"
+ },
+ "FirewallDeploymentModel":{
+ "type":"string",
+ "enum":["CENTRALIZED"]
+ },
+ "FirewallSubnetIsOutOfScopeViolation":{
+ "type":"structure",
+ "members":{
+ "FirewallSubnetId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The ID of the firewall subnet that violates the policy scope.</p>"
+ },
+ "VpcId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The VPC ID of the firewall subnet that violates the policy scope.</p>"
+ },
+ "SubnetAvailabilityZone":{
+ "shape":"LengthBoundedString",
+ "documentation":"<p>The Availability Zone of the firewall subnet that violates the policy scope.</p>"
+ },
+ "SubnetAvailabilityZoneId":{
+ "shape":"LengthBoundedString",
+ "documentation":"<p>The Availability Zone ID of the firewall subnet that violates the policy scope.</p>"
+ },
+ "VpcEndpointId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The VPC endpoint ID of the firewall subnet that violates the policy scope.</p>"
+ }
+ },
+ "documentation":"<p>Contains details about the firewall subnet that violates the policy scope.</p>"
+ },
"GetAdminAccountRequest":{
"type":"structure",
"members":{
@@ -1481,7 +1534,7 @@
"type":"string",
"max":8192,
"min":1,
- "pattern":".*"
+ "pattern":"^((?!\\\\[nr]).)+"
},
"MemberAccounts":{
"type":"list",
@@ -1743,6 +1796,16 @@
},
"documentation":"<p>Violation detail for Network Firewall for an Availability Zone that's missing the expected Firewall Manager managed subnet.</p>"
},
+ "NetworkFirewallPolicy":{
+ "type":"structure",
+ "members":{
+ "FirewallDeploymentModel":{
+ "shape":"FirewallDeploymentModel",
+ "documentation":"<p>Defines the deployment model to use for the firewall policy. To use a distributed model, set <a href=\"https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html\">PolicyOption</a> to <code>NULL</code>.</p>"
+ }
+ },
+ "documentation":"<p>Configures the firewall policy deployment model of Network Firewall. For information about Network Firewall deployment models, see <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/architectures.html\">Network Firewall example architectures with routing</a> in the <i>Network Firewall Developer Guide</i>.</p>"
+ },
"NetworkFirewallPolicyDescription":{
"type":"structure",
"members":{
@@ -1914,7 +1977,7 @@
},
"ExcludeResourceTags":{
"shape":"Boolean",
- "documentation":"<p>If set to <code>True</code>, resources with the tags that are specified in the <code>ResourceTag</code> array are not in scope of the policy. If set to <code>False</code>, and the <code>ResourceTag</code> array is not null, only resources with the specified tags are in scope of the policy.</p>"
+ "documentation":"<p>If set to <code>True</code>, resources with the tags that are specified in the <code>ResourceTag</code> array are not in scope of the policy. If set to <code>False</code>, and the <code>ResourceTag</code> array is not null, only resources with the specified tags are in scope of the policy.</p> <p> This option isn't available for the centralized deployment model when creating policies to configure Network Firewall. </p>"
},
"RemediationEnabled":{
"shape":"Boolean",
@@ -1926,11 +1989,11 @@
},
"IncludeMap":{
"shape":"CustomerPolicyScopeMap",
- "documentation":"<p>Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.</p> <p>You can specify inclusions or exclusions, but not both. If you specify an <code>IncludeMap</code>, Firewall Manager applies the policy to all accounts specified by the <code>IncludeMap</code>, and does not evaluate any <code>ExcludeMap</code> specifications. If you do not specify an <code>IncludeMap</code>, then Firewall Manager applies the policy to all accounts except for those specified by the <code>ExcludeMap</code>.</p> <p>You can specify account IDs, OUs, or a combination: </p> <ul> <li> <p>Specify account IDs by setting the key to <code>ACCOUNT</code>. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”]}</code>.</p> </li> <li> <p>Specify OUs by setting the key to <code>ORG_UNIT</code>. For example, the following is a valid map: <code>{“ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> <li> <p>Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> </ul>"
+ "documentation":"<p>Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.</p> <p>You can specify inclusions or exclusions, but not both. If you specify an <code>IncludeMap</code>, Firewall Manager applies the policy to all accounts specified by the <code>IncludeMap</code>, and does not evaluate any <code>ExcludeMap</code> specifications. If you do not specify an <code>IncludeMap</code>, then Firewall Manager applies the policy to all accounts except for those specified by the <code>ExcludeMap</code>.</p> <p>You can specify account IDs, OUs, or a combination: </p> <ul> <li> <p>Specify account IDs by setting the key to <code>ACCOUNT</code>. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”]}</code>.</p> </li> <li> <p>Specify OUs by setting the key to <code>ORG_UNIT</code>. For example, the following is a valid map: <code>{“ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> <li> <p>Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> </ul> <p> This option isn't available for the centralized deployment model when creating policies to configure Network Firewall. </p>"
},
"ExcludeMap":{
"shape":"CustomerPolicyScopeMap",
- "documentation":"<p>Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.</p> <p>You can specify inclusions or exclusions, but not both. If you specify an <code>IncludeMap</code>, Firewall Manager applies the policy to all accounts specified by the <code>IncludeMap</code>, and does not evaluate any <code>ExcludeMap</code> specifications. If you do not specify an <code>IncludeMap</code>, then Firewall Manager applies the policy to all accounts except for those specified by the <code>ExcludeMap</code>.</p> <p>You can specify account IDs, OUs, or a combination: </p> <ul> <li> <p>Specify account IDs by setting the key to <code>ACCOUNT</code>. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”]}</code>.</p> </li> <li> <p>Specify OUs by setting the key to <code>ORG_UNIT</code>. For example, the following is a valid map: <code>{“ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> <li> <p>Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> </ul>"
+ "documentation":"<p>Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.</p> <p>You can specify inclusions or exclusions, but not both. If you specify an <code>IncludeMap</code>, Firewall Manager applies the policy to all accounts specified by the <code>IncludeMap</code>, and does not evaluate any <code>ExcludeMap</code> specifications. If you do not specify an <code>IncludeMap</code>, then Firewall Manager applies the policy to all accounts except for those specified by the <code>ExcludeMap</code>.</p> <p>You can specify account IDs, OUs, or a combination: </p> <ul> <li> <p>Specify account IDs by setting the key to <code>ACCOUNT</code>. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”]}</code>.</p> </li> <li> <p>Specify OUs by setting the key to <code>ORG_UNIT</code>. For example, the following is a valid map: <code>{“ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> <li> <p>Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: <code>{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}</code>.</p> </li> </ul> <p> This option isn't available for the centralized deployment model when creating policies to configure Network Firewall. </p>"
}
},
"documentation":"<p>An Firewall Manager policy.</p>"
@@ -2020,6 +2083,16 @@
"min":36,
"pattern":"^[a-z0-9A-Z-]{36}$"
},
+ "PolicyOption":{
+ "type":"structure",
+ "members":{
+ "NetworkFirewallPolicy":{
+ "shape":"NetworkFirewallPolicy",
+ "documentation":"<p>Defines the deployment model to use for the firewall policy.</p>"
+ }
+ },
+ "documentation":"<p>Contains the Network Firewall firewall policy options to configure a centralized deployment model.</p>"
+ },
"PolicySummary":{
"type":"structure",
"members":{
@@ -2325,6 +2398,10 @@
"EC2CreateRouteTableAction":{
"shape":"EC2CreateRouteTableAction",
"documentation":"<p>Information about the CreateRouteTable action in the Amazon EC2 API.</p>"
+ },
+ "FMSPolicyUpdateFirewallCreationConfigAction":{
+ "shape":"FMSPolicyUpdateFirewallCreationConfigAction",
+ "documentation":"<p>The remedial action to take when updating a firewall configuration.</p>"
}
},
"documentation":"<p>Information about an individual action you can take to remediate a violation.</p>"
@@ -2499,6 +2576,14 @@
"PossibleRemediationActions":{
"shape":"PossibleRemediationActions",
"documentation":"<p>A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.</p>"
+ },
+ "FirewallSubnetIsOutOfScopeViolation":{
+ "shape":"FirewallSubnetIsOutOfScopeViolation",
+ "documentation":"<p>Contains details about the firewall subnet that violates the policy scope.</p>"
+ },
+ "RouteHasOutOfScopeEndpointViolation":{
+ "shape":"RouteHasOutOfScopeEndpointViolation",
+ "documentation":"<p>Contains details about the route endpoint that violates the policy scope.</p>"
}
},
"documentation":"<p>Violation detail based on resource type.</p>"
@@ -2529,6 +2614,60 @@
},
"documentation":"<p>Describes a route in a route table.</p>"
},
+ "RouteHasOutOfScopeEndpointViolation":{
+ "type":"structure",
+ "members":{
+ "SubnetId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The ID of the subnet associated with the route that violates the policy scope.</p>"
+ },
+ "VpcId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The VPC ID of the route that violates the policy scope.</p>"
+ },
+ "RouteTableId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The ID of the route table.</p>"
+ },
+ "ViolatingRoutes":{
+ "shape":"Routes",
+ "documentation":"<p>The list of routes that violate the route table.</p>"
+ },
+ "SubnetAvailabilityZone":{
+ "shape":"LengthBoundedString",
+ "documentation":"<p>The subnet's Availability Zone.</p>"
+ },
+ "SubnetAvailabilityZoneId":{
+ "shape":"LengthBoundedString",
+ "documentation":"<p>The ID of the subnet's Availability Zone.</p>"
+ },
+ "CurrentFirewallSubnetRouteTable":{
+ "shape":"ResourceId",
+ "documentation":"<p>The route table associated with the current firewall subnet.</p>"
+ },
+ "FirewallSubnetId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The ID of the firewall subnet.</p>"
+ },
+ "FirewallSubnetRoutes":{
+ "shape":"Routes",
+ "documentation":"<p>The list of firewall subnet routes.</p>"
+ },
+ "InternetGatewayId":{
+ "shape":"ResourceId",
+ "documentation":"<p>The ID of the Internet Gateway.</p>"
+ },
+ "CurrentInternetGatewayRouteTable":{
+ "shape":"ResourceId",
+ "documentation":"<p>The current route table associated with the Internet Gateway.</p>"
+ },
+ "InternetGatewayRoutes":{
+ "shape":"Routes",
+ "documentation":"<p>The routes in the route table associated with the Internet Gateway.</p>"
+ }
+ },
+ "documentation":"<p>Contains details about the route endpoint that violates the policy scope.</p>"
+ },
"Routes":{
"type":"list",
"member":{"shape":"Route"}
@@ -2599,7 +2738,11 @@
},
"ManagedServiceData":{
"shape":"ManagedServiceData",
- "documentation":"<p>Details about the service that are specific to the service type, in JSON format. </p> <ul> <li> <p>Example: <code>DNS_FIREWALL</code> </p> <p> <code>\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"</code> </p> <note> <p>Valid values for <code>preProcessRuleGroups</code> are between 1 and 99. Valid values for <code>postProcessRuleGroups</code> are between 9901 and 10000.</p> </note> </li> <li> <p>Example: <code>NETWORK_FIREWALL</code> </p> <p> <code>\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\\\",\\\"priority\\\":10}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:pass\\\",\\\"custom1\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"custom2\\\",\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"custom1\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension1\\\"}]}}},{\\\"actionName\\\":\\\"custom2\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"dimension2\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":true,\\\"allowedIPV4CidrList\\\":[\\\"10.24.34.0/28\\\"]} }\"</code> </p> </li> <li> <p>Specification for <code>SHIELD_ADVANCED</code> for Amazon CloudFront distributions </p> <p> <code>\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false}\"</code> </p> <p>For example: <code>\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\", \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"</code> </p> <p>The default value for <code>automaticResponseStatus</code> is <code>IGNORED</code>. The value for <code>automaticResponseAction</code> is only required when <code>automaticResponseStatus</code> is set to <code>ENABLED</code>. The default value for <code>overrideCustomerWebaclClassic</code> is <code>false</code>.</p> <p>For other resource types that you can protect with a Shield Advanced policy, this <code>ManagedServiceData</code> configuration is an empty string.</p> </li> <li> <p>Example: <code>WAFV2</code> </p> <p> <code>\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"</code> </p> <p>In the <code>loggingConfiguration</code>, you can specify one <code>logDestinationConfigs</code>, you can optionally provide up to 20 <code>redactedFields</code>, and the <code>RedactedFieldType</code> must be one of <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or <code>METHOD</code>.</p> </li> <li> <p>Example: <code>WAF Classic</code> </p> <p> <code>\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"</code> </p> </li> <li> <p>Example: <code>SECURITY_GROUPS_COMMON</code> </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"</code> </p> </li> <li> <p>Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"</code> </p> </li> <li> <p>Example: <code>SECURITY_GROUPS_CONTENT_AUDIT</code> </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"</code> </p> <p>The security group action for content audit can be <code>ALLOW</code> or <code>DENY</code>. For <code>ALLOW</code>, all in-scope security group rules must be within the allowed range of the policy's security group rules. For <code>DENY</code>, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.</p> </li> <li> <p>Example: <code>SECURITY_GROUPS_USAGE_AUDIT</code> </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"</code> </p> </li> </ul>"
+ "documentation":"<p>Details about the service that are specific to the service type, in JSON format. </p> <ul> <li> <p>Example: <code>DNS_FIREWALL</code> </p> <p> <code>\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"</code> </p> <note> <p>Valid values for <code>preProcessRuleGroups</code> are between 1 and 99. Valid values for <code>postProcessRuleGroups</code> are between 9901 and 10000.</p> </note> </li> <li> <p>Example: <code>NETWORK_FIREWALL</code> - Centralized deployment model.</p> <p> <code>\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"</code> </p> <p> To use the centralized deployment model, you must set <a href=\"https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html\">PolicyOption</a> to <code>CENTRALIZED</code>. </p> </li> <li> <p>Example: <code>NETWORK_FIREWALL</code> - Distributed deployment model with automatic Availability Zone configuration. With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. </p> <p> <code>\"{ \\\"type\\\": \\\"NETWORK_FIREWALL\\\", \\\"networkFirewallStatelessRuleGroupReferences\\\": [ { \\\"resourceARN\\\": \\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\", \\\"priority\\\": 1 } ], \\\"networkFirewallStatelessDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ], \\\"networkFirewallStatelessCustomActions\\\": [ { \\\"actionName\\\": \\\"customActionName\\\", \\\"actionDefinition\\\": { \\\"publishMetricAction\\\": { \\\"dimensions\\\": [ { \\\"value\\\": \\\"metricdimensionvalue\\\" } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\": [ { \\\"resourceARN\\\": \\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ], \\\"networkFirewallOrchestrationConfig\\\": { \\\"singleFirewallEndpointPerVPC\\\": false, \\\"allowedIPV4CidrList\\\": [ \\\"10.0.0.0/28\\\", \\\"192.168.0.0/28\\\" ], \\\"routeManagementAction\\\": \\\"OFF\\\" }, \\\"networkFirewallLoggingConfiguration\\\": { \\\"logDestinationConfigs\\\": [ { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"ALERT\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } }, { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"FLOW\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\": true } }\"</code> </p> <p> To use the distributed deployment model, you must set <a href=\"https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html\">PolicyOption</a> to <code>NULL</code>. </p> </li> <li> <p>Example: <code>NETWORK_FIREWALL</code> - Distributed deployment model with automatic Availability Zone configuration, and route management. </p> <p> <code>\"{ \\\"type\\\": \\\"NETWORK_FIREWALL\\\", \\\"networkFirewallStatelessRuleGroupReferences\\\": [ { \\\"resourceARN\\\": \\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\", \\\"priority\\\": 1 } ], \\\"networkFirewallStatelessDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ], \\\"networkFirewallStatelessCustomActions\\\": [ { \\\"actionName\\\": \\\"customActionName\\\", \\\"actionDefinition\\\": { \\\"publishMetricAction\\\": { \\\"dimensions\\\": [ { \\\"value\\\": \\\"metricdimensionvalue\\\" } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\": [ { \\\"resourceARN\\\": \\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ], \\\"networkFirewallOrchestrationConfig\\\": { \\\"singleFirewallEndpointPerVPC\\\": false, \\\"allowedIPV4CidrList\\\": [ \\\"10.0.0.0/28\\\", \\\"192.168.0.0/28\\\" ], \\\"routeManagementAction\\\": \\\"MONITOR\\\", \\\"routeManagementTargetTypes\\\": [ \\\"InternetGateway\\\" ] }, \\\"networkFirewallLoggingConfiguration\\\": { \\\"logDestinationConfigs\\\": [ { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"ALERT\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } }, { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"FLOW\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\": true } }\"</code> </p> </li> <li> <p>Example: <code>NETWORK_FIREWALL</code> - Distributed deployment model with custom Availability Zone configuration. With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring <code>firewallCreationConfig</code>. </p> <p> <code>\"{ \\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}], \\\"networkFirewallStatelessDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\", \\\"fragmentcustomactionname\\\" ], \\\"networkFirewallStatelessCustomActions\\\":[ { \\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ { \\\"value\\\":\\\"metricdimensionvalue\\\" } ] } } }, { \\\"actionName\\\":\\\"fragmentcustomactionname\\\", \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ { \\\"value\\\":\\\"fragmentmetricdimensionvalue\\\" } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\":[ { \\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ], \\\"networkFirewallOrchestrationConfig\\\":{ \\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ { \\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1a\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] }, { ¯\\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1b\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] } ] } }, \\\"singleFirewallEndpointPerVPC\\\":false, \\\"allowedIPV4CidrList\\\":null, \\\"routeManagementAction\\\":\\\"OFF\\\", \\\"networkFirewallLoggingConfiguration\\\":{ \\\"logDestinationConfigs\\\":[ { \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"ALERT\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } }, { \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"FLOW\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\":boolean } }\"</code> </p> </li> <li> <p>Example: <code>NETWORK_FIREWALL</code> - Distributed deployment model with custom Availability Zone configuration, and route management. </p> <p> <code>\"{ \\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}], \\\"networkFirewallStatelessDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\", \\\"fragmentcustomactionname\\\" ], \\\"networkFirewallStatelessCustomActions\\\":[ { \\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ { \\\"value\\\":\\\"metricdimensionvalue\\\" } ] } } }, { \\\"actionName\\\":\\\"fragmentcustomactionname\\\", \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ { \\\"value\\\":\\\"fragmentmetricdimensionvalue\\\" } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\":[ { \\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ], \\\"networkFirewallOrchestrationConfig\\\":{ \\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ { \\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1a\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] }, { ¯\\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1b\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] } ] } }, \\\"singleFirewallEndpointPerVPC\\\":false, \\\"allowedIPV4CidrList\\\":null, \\\"routeManagementAction\\\":\\\"MONITOR\\\", \\\"routeManagementTargetTypes\\\":[ \\\"InternetGateway\\\" ], \\\"routeManagementConfig\\\":{ \\\"allowCrossAZTrafficIfNoEndpoint\\\":true } }, \\\"networkFirewallLoggingConfiguration\\\":{ \\\"logDestinationConfigs\\\":[ { \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"ALERT\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } }, { \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"FLOW\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\":boolean } }\"</code> </p> </li> <li> <p>Specification for <code>SHIELD_ADVANCED</code> for Amazon CloudFront distributions </p> <p> <code>\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false}\"</code> </p> <p>For example: <code>\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\", \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"</code> </p> <p>The default value for <code>automaticResponseStatus</code> is <code>IGNORED</code>. The value for <code>automaticResponseAction</code> is only required when <code>automaticResponseStatus</code> is set to <code>ENABLED</code>. The default value for <code>overrideCustomerWebaclClassic</code> is <code>false</code>.</p> <p>For other resource types that you can protect with a Shield Advanced policy, this <code>ManagedServiceData</code> configuration is an empty string.</p> </li> <li> <p>Example: <code>WAFV2</code> </p> <p> <code>\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"</code> </p> <p>In the <code>loggingConfiguration</code>, you can specify one <code>logDestinationConfigs</code>, you can optionally provide up to 20 <code>redactedFields</code>, and the <code>RedactedFieldType</code> must be one of <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or <code>METHOD</code>.</p> </li> <li> <p>Example: <code>WAF Classic</code> </p> <p> <code>\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"</code> </p> </li> <li> <p>Example: <code>SECURITY_GROUPS_COMMON</code> </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"</code> </p> </li> <li> <p>Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"</code> </p> </li> <li> <p>Example: <code>SECURITY_GROUPS_CONTENT_AUDIT</code> </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"</code> </p> <p>The security group action for content audit can be <code>ALLOW</code> or <code>DENY</code>. For <code>ALLOW</code>, all in-scope security group rules must be within the allowed range of the policy's security group rules. For <code>DENY</code>, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.</p> </li> <li> <p>Example: <code>SECURITY_GROUPS_USAGE_AUDIT</code> </p> <p> <code>\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"</code> </p> </li> </ul>"
+ },
+ "PolicyOption":{
+ "shape":"PolicyOption",
+ "documentation":"<p>Contains the Network Firewall firewall policy options to configure a centralized deployment model.</p>"
}
},
"documentation":"<p>Details about the security service that is being used to protect the resources.</p>"
@@ -2812,7 +2955,7 @@
},
"ResourceTags":{
"shape":"TagList",
- "documentation":"<p>The <code>ResourceTag</code> objects associated with the resource.</p>"
+ "documentation":"<p>The <code>ResourceTag</code> objects associated with the resource.</p> <p> This option isn't available for the centralized deployment model when creating policies to configure Network Firewall. </p>"
},
"ResourceDescription":{
"shape":"LengthBoundedString",
@@ -2848,7 +2991,9 @@
"INTERNET_TRAFFIC_NOT_INSPECTED",
"BLACK_HOLE_ROUTE_DETECTED",
"BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET",
- "RESOURCE_MISSING_DNS_FIREWALL"
+ "RESOURCE_MISSING_DNS_FIREWALL",
+ "FIREWALL_SUBNET_IS_OUT_OF_SCOPE",
+ "ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT"
]
},
"ViolationTarget":{
diff --git a/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json b/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json
index 911056387d..1a2ab9e18e 100644
--- a/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json
@@ -171,7 +171,7 @@
{"shape":"InternalServerError"},
{"shape":"MissingFileSystemConfiguration"}
],
- "documentation":"<p>Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.</p> <p>If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token with the specified by the file system exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file system with the specified client request token doesn't exist, this operation does the following:</p> <ul> <li> <p>Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the file system.</p> </li> </ul> <p>Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.</p> <p>By using the idempotent operation, you can retry a <code>CreateFileSystemFromBackup</code> call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.</p> <note> <p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's lifecycle state is still <code>CREATING</code>. You can check the file-system creation status by calling the <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html\"> DescribeFileSystems</a> operation, which returns the file system state along with other information.</p> </note>"
+ "documentation":"<p>Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.</p> <p>If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file system with the specified client request token doesn't exist, this operation does the following:</p> <ul> <li> <p>Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the file system.</p> </li> </ul> <p>Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.</p> <p>By using the idempotent operation, you can retry a <code>CreateFileSystemFromBackup</code> call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.</p> <note> <p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's lifecycle state is still <code>CREATING</code>. You can check the file-system creation status by calling the <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html\"> DescribeFileSystems</a> operation, which returns the file system state along with other information.</p> </note>"
},
"CreateSnapshot":{
"name":"CreateSnapshot",
@@ -187,7 +187,7 @@
{"shape":"ServiceLimitExceeded"},
{"shape":"InternalServerError"}
],
- "documentation":"<p>Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.</p> <p>If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns <code>IncompatibleParameterError</code>. If a snapshot with the specified client request token doesn't exist, <code>CreateSnapshot</code> does the following: </p> <ul> <li> <p>Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the snapshot.</p> </li> </ul> <p>By using the idempotent operation, you can retry a <code>CreateSnapshot</code> operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.</p> <p>The <code>CreateSnapshot</code> operation returns while the snapshot's lifecycle state is still <code>CREATING</code>. You can check the snapshot creation status by calling the <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html\">DescribeSnapshots</a> operation, which returns the snapshot state along with other information. </p>",
+ "documentation":"<p>Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.</p> <p>If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns <code>IncompatibleParameterError</code>. If a snapshot with the specified client request token doesn't exist, <code>CreateSnapshot</code> does the following:</p> <ul> <li> <p>Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the snapshot.</p> </li> </ul> <p>By using the idempotent operation, you can retry a <code>CreateSnapshot</code> operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.</p> <p>The <code>CreateSnapshot</code> operation returns while the snapshot's lifecycle state is still <code>CREATING</code>. You can check the snapshot creation status by calling the <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html\">DescribeSnapshots</a> operation, which returns the snapshot state along with other information.</p>",
"idempotent":true
},
"CreateStorageVirtualMachine":{
@@ -227,7 +227,7 @@
{"shape":"StorageVirtualMachineNotFound"},
{"shape":"UnsupportedOperation"}
],
- "documentation":"<p>Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage volume.</p>"
+ "documentation":"<p>Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.</p>"
},
"CreateVolumeFromBackup":{
"name":"CreateVolumeFromBackup",
@@ -318,7 +318,7 @@
{"shape":"InternalServerError"},
{"shape":"SnapshotNotFound"}
],
- "documentation":"<p>Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup. </p> <p>The <code>DeleteSnapshot</code> operation returns instantly. The snapshot appears with the lifecycle status of <code>DELETING</code> until the deletion is complete.</p>",
+ "documentation":"<p>Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup. </p> <p>The <code>DeleteSnapshot</code> operation returns instantly. The snapshot appears with the lifecycle status of <code>DELETING</code> until the deletion is complete.</p>",
"idempotent":true
},
"DeleteStorageVirtualMachine":{
@@ -447,7 +447,7 @@
{"shape":"InternalServerError"},
{"shape":"SnapshotNotFound"}
],
- "documentation":"<p>Returns the description of specific Amazon FSx snapshots, if a <code>SnapshotIds</code> value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.</p> <p>When retrieving all snapshots, you can optionally specify the <code>MaxResults</code> parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </p> <p>Use this operation in an iterative process to retrieve a list of your snapshots. <code>DescribeSnapshots</code> is called first without a <code>NextToken</code> value. Then the operation continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code> value.</p> <p>When using this operation, keep the following in mind:</p> <ul> <li> <p>The operation might return fewer than the <code>MaxResults</code> value of snapshot descriptions while still including a <code>NextToken</code> value.</p> </li> <li> <p>The order of snapshots returned in the response of one <code>DescribeSnapshots</code> call and the order of backups returned across the responses of a multi-call iteration is unspecified. </p> </li> </ul>"
+ "documentation":"<p>Returns the description of specific Amazon FSx for OpenZFS snapshots, if a <code>SnapshotIds</code> value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.</p> <p>When retrieving all snapshots, you can optionally specify the <code>MaxResults</code> parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response. </p> <p>Use this operation in an iterative process to retrieve a list of your snapshots. <code>DescribeSnapshots</code> is called first without a <code>NextToken</code> value. Then the operation continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code> value.</p> <p>When using this operation, keep the following in mind:</p> <ul> <li> <p>The operation might return fewer than the <code>MaxResults</code> value of snapshot descriptions while still including a <code>NextToken</code> value.</p> </li> <li> <p>The order of snapshots returned in the response of one <code>DescribeSnapshots</code> call and the order of backups returned across the responses of a multi-call iteration is unspecified. </p> </li> </ul>"
},
"DescribeStorageVirtualMachines":{
"name":"DescribeStorageVirtualMachines",
@@ -631,7 +631,7 @@
{"shape":"SnapshotNotFound"},
{"shape":"InternalServerError"}
],
- "documentation":"<p>Updates the name of a snapshot. </p>",
+ "documentation":"<p>Updates the name of an Amazon FSx for OpenZFS snapshot.</p>",
"idempotent":true
},
"UpdateStorageVirtualMachine":{
@@ -1195,7 +1195,7 @@
"FileSystemId":{"shape":"FileSystemId"},
"FileSystemPath":{
"shape":"Namespace",
- "documentation":"<p>A path on the file system that points to a high-level directory (such as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>) that will be mapped 1-1 with <code>DataRepositoryPath</code>. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path <code>/ns1/</code>, then you cannot link another data repository with file system path <code>/ns1/ns2</code>.</p> <p>This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.</p>"
+ "documentation":"<p>A path on the file system that points to a high-level directory (such as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>) that will be mapped 1-1 with <code>DataRepositoryPath</code>. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path <code>/ns1/</code>, then you cannot link another data repository with file system path <code>/ns1/ns2</code>.</p> <p>This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.</p> <note> <p>If you specify only a forward slash (<code>/</code>) as the file system path, you can link only 1 data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system.</p> </note>"
},
"DataRepositoryPath":{
"shape":"ArchivePath",
@@ -1347,7 +1347,7 @@
},
"AutoImportPolicy":{
"shape":"AutoImportPolicyType",
- "documentation":"<p> (Optional) Available with <code>Scratch</code> and <code>Persistent_1</code> deployment types. When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. <code>AutoImportPolicy</code> can have the following values:</p> <ul> <li> <p> <code>NONE</code> - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.</p> </li> <li> <p> <code>NEW</code> - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. </p> </li> <li> <p> <code>NEW_CHANGED</code> - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.</p> </li> <li> <p> <code>NEW_CHANGED_DELETED</code> - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html\"> Automatically import updates from your S3 bucket</a>.</p> <note> <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type. Instead, use <code>CreateDataRepositoryAssociation\"</code> to create a data repository association to link your Lustre file system to a data repository.</p> </note>"
+ "documentation":"<p> (Optional) Available with <code>Scratch</code> and <code>Persistent_1</code> deployment types. When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. <code>AutoImportPolicy</code> can have the following values:</p> <ul> <li> <p> <code>NONE</code> - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.</p> </li> <li> <p> <code>NEW</code> - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. </p> </li> <li> <p> <code>NEW_CHANGED</code> - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.</p> </li> <li> <p> <code>NEW_CHANGED_DELETED</code> - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3\"> Automatically import updates from your S3 bucket</a>.</p> <note> <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type. Instead, use <code>CreateDataRepositoryAssociation</code> to create a data repository association to link your Lustre file system to a data repository.</p> </note>"
},
"PerUnitStorageThroughput":{
"shape":"PerUnitStorageThroughput",
@@ -1389,7 +1389,7 @@
},
"EndpointIpAddressRange":{
"shape":"IpAddressRange",
- "documentation":"<p>Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.</p>"
+ "documentation":"<p>Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.</p> <important> <p>The Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger.</p> </important>"
},
"FsxAdminPassword":{
"shape":"AdminPassword",
@@ -1434,7 +1434,7 @@
"DailyAutomaticBackupStartTime":{"shape":"DailyTime"},
"DeploymentType":{
"shape":"OpenZFSDeploymentType",
- "documentation":"<p>Specifies the file system deployment type. Amazon FSx for OpenZFS supports <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> is a file system configured for a single Availability Zone (AZ) of redundancy.</p>"
+ "documentation":"<p>Specifies the file system deployment type. Amazon FSx for OpenZFS supports <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> deployment type is configured for redundancy within a single Availability Zone.</p>"
},
"ThroughputCapacity":{
"shape":"MegabytesPerSecond",
@@ -1447,7 +1447,7 @@
"documentation":"<p>The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume. </p>"
}
},
- "documentation":"<p>The OpenZFS configuration properties for the file system that you are creating.</p>"
+ "documentation":"<p>The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.</p>"
},
"CreateFileSystemRequest":{
"type":"structure",
@@ -1616,23 +1616,27 @@
"members":{
"ParentVolumeId":{
"shape":"VolumeId",
- "documentation":"<p>The ID of the volume to use as the parent volume. </p>"
+ "documentation":"<p>The ID of the volume to use as the parent volume of the volume that you are creating.</p>"
},
"StorageCapacityReservationGiB":{
- "shape":"IntegerNoMax",
- "documentation":"<p>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.</p>"
+ "shape":"IntegerNoMaxFromNegativeOne",
+ "documentation":"<p>Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting <code>StorageCapacityReservationGiB</code> guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To <i>not</i> specify a storage capacity reservation, set this to <code>0</code> or <code>-1</code>. For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties\">Volume properties</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
},
"StorageCapacityQuotaGiB":{
- "shape":"IntegerNoMax",
- "documentation":"<p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.</p>"
+ "shape":"IntegerNoMaxFromNegativeOne",
+ "documentation":"<p>Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set <code>StorageCapacityReservationGiB</code>. To <i>not</i> specify a storage capacity quota, set this to <code>-1</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties\">Volume properties</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
+ },
+ "RecordSizeKiB":{
+ "shape":"IntegerRecordSizeKiB",
+ "documentation":"<p>Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance\"> ZFS Record size</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
},
"DataCompressionType":{
"shape":"OpenZFSDataCompressionType",
- "documentation":"<p>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</p> </li> </ul>"
+ "documentation":"<p>Specifies the method used to compress the data on the volume. The compression type is <code>NONE</code> by default.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume. <code>NONE</code> is the default.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.</p> </li> <li> <p> <code>LZ4</code> - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.</p> </li> </ul> <p>For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs\"> Tips for maximizing performance</a> File system and volume settings in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
},
"CopyTagsToSnapshots":{
"shape":"Flag",
- "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code>, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. </p>"
+ "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code>, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.</p>"
},
"OriginSnapshot":{
"shape":"CreateOpenZFSOriginSnapshotConfiguration",
@@ -1640,18 +1644,18 @@
},
"ReadOnly":{
"shape":"ReadOnly",
- "documentation":"<p>A Boolean value indicating whether the volume is read-only. </p>"
+ "documentation":"<p>A Boolean value indicating whether the volume is read-only.</p>"
},
"NfsExports":{
"shape":"OpenZFSNfsExports",
- "documentation":"<p>The configuration object for mounting a Network File System (NFS) file system. </p>"
+ "documentation":"<p>The configuration object for mounting a Network File System (NFS) file system.</p>"
},
"UserAndGroupQuotas":{
"shape":"OpenZFSUserAndGroupQuotas",
- "documentation":"<p>An object specifying how much storage users or groups can use on the volume. </p>"
+ "documentation":"<p>An object specifying how much storage users or groups can use on the volume.</p>"
}
},
- "documentation":"<p>Specifies the configuration of the OpenZFS volume that you are creating.</p>"
+ "documentation":"<p>Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.</p>"
},
"CreateSnapshotRequest":{
"type":"structure",
@@ -1848,7 +1852,7 @@
"FailureDetails":{"shape":"DataRepositoryFailureDetails"},
"FileSystemPath":{
"shape":"Namespace",
- "documentation":"<p>A path on the file system that points to a high-level directory (such as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>) that will be mapped 1-1 with <code>DataRepositoryPath</code>. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path <code>/ns1/</code>, then you cannot link another data repository with file system path <code>/ns1/ns2</code>.</p> <p>This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory. </p>"
+ "documentation":"<p>A path on the file system that points to a high-level directory (such as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>) that will be mapped 1-1 with <code>DataRepositoryPath</code>. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path <code>/ns1/</code>, then you cannot link another data repository with file system path <code>/ns1/ns2</code>.</p> <p>This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.</p> <note> <p>If you specify only a forward slash (<code>/</code>) as the file system path, you can link only 1 data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system.</p> </note>"
},
"DataRepositoryPath":{
"shape":"ArchivePath",
@@ -2217,11 +2221,27 @@
"members":{
"SkipFinalBackup":{
"shape":"Flag",
- "documentation":"<p>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the <code>DeleteFileSystem</code> operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this value to do so. </p>"
+ "documentation":"<p>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the <code>DeleteFileSystem</code> operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to <code>true</code>.</p>"
},
- "FinalBackupTags":{"shape":"Tags"}
+ "FinalBackupTags":{
+ "shape":"Tags",
+ "documentation":"<p>A list of tags to apply to the file system's final backup.</p>"
+ },
+ "Options":{
+ "shape":"DeleteFileSystemOpenZFSOptions",
+ "documentation":"<p>To delete a file system if there are child volumes present below the root volume, use the string <code>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</code>. If your file system has child volumes and you don't use this option, the delete request will fail.</p>"
+ }
},
- "documentation":"<p>The configuration object for the OpenZFS file system used in the <code>DeleteFileSystem</code> operation.</p>"
+ "documentation":"<p>The configuration object for the Amazon FSx for OpenZFS file system used in the <code>DeleteFileSystem</code> operation.</p>"
+ },
+ "DeleteFileSystemOpenZFSOption":{
+ "type":"string",
+ "enum":["DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"]
+ },
+ "DeleteFileSystemOpenZFSOptions":{
+ "type":"list",
+ "member":{"shape":"DeleteFileSystemOpenZFSOption"},
+ "max":1
},
"DeleteFileSystemOpenZFSResponse":{
"type":"structure",
@@ -3047,6 +3067,16 @@
"max":2147483647,
"min":0
},
+ "IntegerNoMaxFromNegativeOne":{
+ "type":"integer",
+ "max":2147483647,
+ "min":-1
+ },
+ "IntegerRecordSizeKiB":{
+ "type":"integer",
+ "max":1024,
+ "min":4
+ },
"InternalServerError":{
"type":"structure",
"members":{
@@ -3343,7 +3373,7 @@
"type":"string",
"max":4096,
"min":1,
- "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4096}$"
+ "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$"
},
"NetBiosAlias":{
"type":"string",
@@ -3405,7 +3435,7 @@
},
"EndpointIpAddressRange":{
"shape":"IpAddressRange",
- "documentation":"<p>The IP address range in which the endpoints to access your file system are created.</p>"
+ "documentation":"<p>The IP address range in which the endpoints to access your file system are created.</p> <important> <p>The Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger. If you do not specify this optional parameter, Amazon FSx will automatically select a CIDR block for you.</p> </important>"
},
"Endpoints":{
"shape":"FileSystemEndpoints",
@@ -3488,11 +3518,11 @@
"members":{
"Clients":{
"shape":"OpenZFSClients",
- "documentation":"<p>A value that specifies who can mount the file system. You can provide a wildcard character (<code>*</code>), an IP address (<code>0.0.0.0</code>), or a CIDR address (<code>192.0.2.0/24</code>. By default, Amazon FSx uses the wildcard character when specifying the client. </p>"
+ "documentation":"<p>A value that specifies who can mount the file system. You can provide a wildcard character (<code>*</code>), an IP address (<code>0.0.0.0</code>), or a CIDR address (<code>192.0.2.0/24</code>). By default, Amazon FSx uses the wildcard character when specifying the client. </p>"
},
"Options":{
"shape":"OpenZFSNfsExportOptions",
- "documentation":"<p>The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the <a href=\"https://linux.die.net/man/5/exports\">exports(5) - Linux man page</a>. When choosing your options, consider the following:</p> <ul> <li> <p> <code>crossmount</code> is used by default. If you don't specify <code>crossmount</code> when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.</p> </li> <li> <p> <code>sync</code> is used by default. If you instead specify <code>async</code>, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. </p> </li> </ul>"
+ "documentation":"<p>The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the <a href=\"https://linux.die.net/man/5/exports\">exports(5) - Linux man page</a>. When choosing your options, consider the following:</p> <ul> <li> <p> <code>crossmnt</code> is used by default. If you don't specify <code>crossmnt</code> when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.</p> </li> <li> <p> <code>sync</code> is used by default. If you instead specify <code>async</code>, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data. </p> </li> </ul>"
}
},
"documentation":"<p>Specifies who can mount the file system and the options that can be used while mounting the file system.</p>"
@@ -3518,9 +3548,13 @@
"OpenZFSCreateRootVolumeConfiguration":{
"type":"structure",
"members":{
+ "RecordSizeKiB":{
+ "shape":"IntegerRecordSizeKiB",
+ "documentation":"<p>Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs\"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
+ },
"DataCompressionType":{
"shape":"OpenZFSDataCompressionType",
- "documentation":"<p>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the ZStandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</p> </li> </ul>"
+ "documentation":"<p>Specifies the method used to compress the data on the volume. The compression type is <code>NONE</code> by default.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume. <code>NONE</code> is the default.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.</p> </li> <li> <p> <code>LZ4</code> - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.</p> </li> </ul>"
},
"NfsExports":{
"shape":"OpenZFSNfsExports",
@@ -3532,7 +3566,7 @@
},
"CopyTagsToSnapshots":{
"shape":"Flag",
- "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. </p>"
+ "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. </p>"
},
"ReadOnly":{
"shape":"ReadOnly",
@@ -3545,7 +3579,8 @@
"type":"string",
"enum":[
"NONE",
- "ZSTD"
+ "ZSTD",
+ "LZ4"
]
},
"OpenZFSDeploymentType":{
@@ -3571,7 +3606,7 @@
},
"ThroughputCapacity":{
"shape":"MegabytesPerSecond",
- "documentation":"<p>The throughput of an Amazon FSx file system, measured in megabytes per second (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). </p>"
+ "documentation":"<p>The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.</p>"
},
"WeeklyMaintenanceStartTime":{"shape":"WeeklyTime"},
"DiskIopsConfiguration":{"shape":"DiskIopsConfiguration"},
@@ -3591,7 +3626,7 @@
"documentation":"<p>A list of configuration objects that contain the client and options for mounting the OpenZFS file system. </p>"
}
},
- "documentation":"<p>The Network File System NFS) configurations for mounting an Amazon FSx for OpenZFS file system. </p>"
+ "documentation":"<p>The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system. </p>"
},
"OpenZFSNfsExportOption":{
"type":"string",
@@ -3675,13 +3710,17 @@
"shape":"IntegerNoMax",
"documentation":"<p>The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.</p>"
},
+ "RecordSizeKiB":{
+ "shape":"IntegerRecordSizeKiB",
+ "documentation":"<p>The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
+ },
"DataCompressionType":{
"shape":"OpenZFSDataCompressionType",
- "documentation":"<p>The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</p> </li> </ul>"
+ "documentation":"<p>Specifies the method used to compress the data on the volume. The compression type is <code>NONE</code> by default.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume. <code>NONE</code> is the default.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.</p> </li> <li> <p> <code>LZ4</code> - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.</p> </li> </ul>"
},
"CopyTagsToSnapshots":{
"shape":"Flag",
- "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. </p>"
+ "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.</p>"
},
"OriginSnapshot":{
"shape":"OpenZFSOriginSnapshotConfiguration",
@@ -3697,7 +3736,7 @@
},
"UserAndGroupQuotas":{
"shape":"OpenZFSUserAndGroupQuotas",
- "documentation":"<p>An object specifying how much storage users or groups can use on the volume. </p>"
+ "documentation":"<p>An object specifying how much storage users or groups can use on the volume.</p>"
}
},
"documentation":"<p>The configuration of an Amazon FSx for OpenZFS volume.</p>"
@@ -4022,6 +4061,7 @@
"shape":"SnapshotLifecycle",
"documentation":"<p>The lifecycle status of the snapshot.</p> <ul> <li> <p> <code>PENDING</code> - Amazon FSx hasn't started creating the snapshot.</p> </li> <li> <p> <code>CREATING</code> - Amazon FSx is creating the snapshot.</p> </li> <li> <p> <code>DELETING</code> - Amazon FSx is deleting the snapshot.</p> </li> <li> <p> <code>AVAILABLE</code> - The snapshot is fully available.</p> </li> </ul>"
},
+ "LifecycleTransitionReason":{"shape":"LifecycleTransitionReason"},
"Tags":{"shape":"Tags"},
"AdministrativeActions":{
"shape":"AdministrativeActions",
@@ -4259,7 +4299,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
- "documentation":"<p>No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.</p>",
+ "documentation":"<p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>",
"exception":true
},
"StorageVirtualMachineRootVolumeSecurityStyle":{
@@ -4562,16 +4602,16 @@
"AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"},
"CopyTagsToBackups":{
"shape":"Flag",
- "documentation":"<p>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. </p>"
+ "documentation":"<p>A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.</p>"
},
"CopyTagsToVolumes":{
"shape":"Flag",
- "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. </p>"
+ "documentation":"<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.</p>"
},
"DailyAutomaticBackupStartTime":{"shape":"DailyTime"},
"ThroughputCapacity":{
"shape":"MegabytesPerSecond",
- "documentation":"<p>The throughput of an Amazon FSx file system, measured in megabytes per second (MBps), in 2 to the nth increments, between 2^3 (8) and 2^12 (4096). </p>"
+ "documentation":"<p>The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.</p>"
},
"WeeklyMaintenanceStartTime":{"shape":"WeeklyTime"},
"DiskIopsConfiguration":{"shape":"DiskIopsConfiguration"}
@@ -4678,16 +4718,20 @@
"type":"structure",
"members":{
"StorageCapacityReservationGiB":{
- "shape":"IntegerNoMax",
- "documentation":"<p>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.</p>"
+ "shape":"IntegerNoMaxFromNegativeOne",
+ "documentation":"<p>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of <code>-1</code> to unset a volume's storage capacity reservation.</p>"
},
"StorageCapacityQuotaGiB":{
- "shape":"IntegerNoMax",
- "documentation":"<p/> <p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.</p>"
+ "shape":"IntegerNoMaxFromNegativeOne",
+ "documentation":"<p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of <code>-1</code> to unset a volume's storage capacity quota.</p>"
+ },
+ "RecordSizeKiB":{
+ "shape":"IntegerRecordSizeKiB",
+ "documentation":"<p>Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs\"> Tips for maximizing performance</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>"
},
"DataCompressionType":{
"shape":"OpenZFSDataCompressionType",
- "documentation":"<p/> <p>Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the <code>DataCompressionType</code> value of their parent volume.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.</p> </li> </ul>"
+ "documentation":"<p>Specifies the method used to compress the data on the volume. The compression type is <code>NONE</code> by default.</p> <ul> <li> <p> <code>NONE</code> - Doesn't compress the data on the volume. <code>NONE</code> is the default.</p> </li> <li> <p> <code>ZSTD</code> - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.</p> </li> <li> <p> <code>LZ4</code> - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.</p> </li> </ul>"
},
"NfsExports":{
"shape":"OpenZFSNfsExports",
@@ -4717,7 +4761,7 @@
},
"Name":{
"shape":"SnapshotName",
- "documentation":"<p>The name of the snapshot to update. </p>"
+ "documentation":"<p>The name of the snapshot to update.</p>"
},
"SnapshotId":{
"shape":"SnapshotId",
@@ -4919,7 +4963,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
- "documentation":"<p>No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.</p>",
+ "documentation":"<p>No Amazon FSx volumes were found based upon the supplied parameters.</p>",
"exception":true
},
"VolumePath":{
diff --git a/contrib/python/botocore/py3/botocore/data/gamelift/2015-10-01/service-2.json b/contrib/python/botocore/py3/botocore/data/gamelift/2015-10-01/service-2.json
index bb760b708e..0582ef402e 100644
--- a/contrib/python/botocore/py3/botocore/data/gamelift/2015-10-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/gamelift/2015-10-01/service-2.json
@@ -62,7 +62,7 @@
{"shape":"LimitExceededException"},
{"shape":"TaggingFailedException"}
],
- "documentation":"<p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build. </p> <p>Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. </p> <p>To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling <code>UpdateAlias</code>.</p> <p> <b>Related actions</b> </p> <p> <a>CreateAlias</a> | <a>ListAliases</a> | <a>DescribeAlias</a> | <a>UpdateAlias</a> | <a>DeleteAlias</a> | <a>ResolveAlias</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build. </p> <p>Amazon Web Services supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. </p> <p>To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling <code>UpdateAlias</code>.</p> <p> <b>Related actions</b> </p> <p> <a>CreateAlias</a> | <a>ListAliases</a> | <a>DescribeAlias</a> | <a>UpdateAlias</a> | <a>DeleteAlias</a> | <a>ResolveAlias</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateBuild":{
"name":"CreateBuild",
@@ -79,7 +79,7 @@
{"shape":"TaggingFailedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Creates a new Amazon GameLift build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon GameLift. </p> <important> <p>When setting up a new game build for GameLift, we recommend using the AWS CLI command <b> <a href=\"https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html\">upload-build</a> </b>. This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource. </p> </important> <p>The <code>CreateBuild</code> operation can used in the following scenarios:</p> <ul> <li> <p>To create a new game build with build files that are in an Amazon S3 location under an AWS account that you control. To use this option, you must first give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, call <code>CreateBuild</code> and specify a build name, operating system, and the Amazon S3 storage location of your game build.</p> </li> <li> <p>To directly upload your build files to a GameLift Amazon S3 location. To use this option, first call <code>CreateBuild</code> and specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html\">Uploading Objects</a> in the <i>Amazon S3 Developer Guide</i>. Build files can be uploaded to the GameLift Amazon S3 location once only; that can't be updated. </p> </li> </ul> <p>If successful, this operation creates a new build resource with a unique build ID and places it in <code>INITIALIZED</code> status. A build must be in <code>READY</code> status before you can create fleets with it.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\">Uploading Your Game</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build\"> Create a Build with Files in Amazon S3</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateBuild</a> | <a>ListBuilds</a> | <a>DescribeBuild</a> | <a>UpdateBuild</a> | <a>DeleteBuild</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates a new Amazon Web Services build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon Web Services. </p> <important> <p>When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI command <b> <a href=\"https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html\">upload-build</a> </b>. This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource. </p> </important> <p>The <code>CreateBuild</code> operation can used in the following scenarios:</p> <ul> <li> <p>To create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you must first give Amazon Web Services access to the Amazon S3 bucket. With permissions in place, call <code>CreateBuild</code> and specify a build name, operating system, and the Amazon S3 storage location of your game build.</p> </li> <li> <p>To directly upload your build files to a GameLift Amazon S3 location. To use this option, first call <code>CreateBuild</code> and specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html\">Uploading Objects</a> in the <i>Amazon S3 Developer Guide</i>. Build files can be uploaded to the GameLift Amazon S3 location once only; that can't be updated. </p> </li> </ul> <p>If successful, this operation creates a new build resource with a unique build ID and places it in <code>INITIALIZED</code> status. A build must be in <code>READY</code> status before you can create fleets with it.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\">Uploading Your Game</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build\"> Create a Build with Files in Amazon S3</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateBuild</a> | <a>ListBuilds</a> | <a>DescribeBuild</a> | <a>UpdateBuild</a> | <a>DeleteBuild</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateFleet":{
"name":"CreateFleet",
@@ -99,7 +99,7 @@
{"shape":"TaggingFailedException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.</p> <p>Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following AWS Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.</p> <p>To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.</p> <p>If successful, this operation creates a new Fleet resource and places it in <code>NEW</code> status, which prompts GameLift to initiate the <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html\">fleet creation workflow</a>. You can track fleet creation by checking fleet status using <a>DescribeFleetAttributes</a> and <a>DescribeFleetLocationAttributes</a>/, or by monitoring fleet creation events using <a>DescribeFleetEvents</a>. As soon as the fleet status changes to <code>ACTIVE</code>, you can enable automatic scaling for the fleet with <a>PutScalingPolicy</a> and set capacity for the home Region with <a>UpdateFleetCapacity</a>. When the status of each remote location reaches <code>ACTIVE</code>, you can set capacity by location using <a>UpdateFleetCapacity</a>.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up fleets</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation\">Debug fleet creation issues</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Multi-location fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> | <a>UpdateFleetCapacity</a> | <a>PutScalingPolicy</a> | <a>DescribeEC2InstanceLimits</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetLocationAttributes</a> | <a>UpdateFleetAttributes</a> | <a>StopFleetActions</a> | <a>DeleteFleet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.</p> <p>Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.</p> <p>To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.</p> <p>If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. </p> <p>If successful, this operation creates a new Fleet resource and places it in <code>NEW</code> status, which prompts GameLift to initiate the <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html\">fleet creation workflow</a>. You can track fleet creation by checking fleet status using <a>DescribeFleetAttributes</a> and <a>DescribeFleetLocationAttributes</a>/, or by monitoring fleet creation events using <a>DescribeFleetEvents</a>. As soon as the fleet status changes to <code>ACTIVE</code>, you can enable automatic scaling for the fleet with <a>PutScalingPolicy</a> and set capacity for the home Region with <a>UpdateFleetCapacity</a>. When the status of each remote location reaches <code>ACTIVE</code>, you can set capacity by location using <a>UpdateFleetCapacity</a>.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up fleets</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation\">Debug fleet creation issues</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Multi-location fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> | <a>UpdateFleetCapacity</a> | <a>PutScalingPolicy</a> | <a>DescribeEC2InstanceLimits</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetLocationAttributes</a> | <a>UpdateFleetAttributes</a> | <a>StopFleetActions</a> | <a>DeleteFleet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateFleetLocations":{
"name":"CreateFleetLocations",
@@ -117,7 +117,7 @@
{"shape":"InvalidFleetStatusException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. </p> <note> <p>This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in AWS Regions that support this feature (see <a>CreateFleet</a> for the complete list) and were created after the feature was released in March 2021.</p> </note> <p>To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. </p> <p>If successful, this operation returns the list of added locations with their status set to <code>NEW</code>. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using <a>DescribeFleetEvents</a>. Alternatively, you can poll location status by calling <a>DescribeFleetLocationAttributes</a>. After a location status becomes <code>ACTIVE</code>, you can adjust the location's capacity as needed with <a>UpdateFleetCapacity</a>.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up fleets</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Multi-location fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleetLocations</a> | <a>DescribeFleetLocationAttributes</a> | <a>DescribeFleetLocationCapacity</a> | <a>DescribeFleetLocationUtilization</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetCapacity</a> | <a>DescribeFleetUtilization</a> | <a>UpdateFleetCapacity</a> | <a>StopFleetActions</a> | <a>DeleteFleetLocations</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. </p> <note> <p>This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature (see <a>CreateFleet</a> for the complete list) and were created after the feature was released in March 2021.</p> </note> <p>To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. </p> <p>If successful, this operation returns the list of added locations with their status set to <code>NEW</code>. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using <a>DescribeFleetEvents</a>. Alternatively, you can poll location status by calling <a>DescribeFleetLocationAttributes</a>. After a location status becomes <code>ACTIVE</code>, you can adjust the location's capacity as needed with <a>UpdateFleetCapacity</a>.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up fleets</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Multi-location fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleetLocations</a> | <a>DescribeFleetLocationAttributes</a> | <a>DescribeFleetLocationCapacity</a> | <a>DescribeFleetLocationUtilization</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetCapacity</a> | <a>DescribeFleetUtilization</a> | <a>UpdateFleetCapacity</a> | <a>StopFleetActions</a> | <a>DeleteFleetLocations</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateGameServerGroup":{
"name":"CreateGameServerGroup",
@@ -134,7 +134,7 @@
{"shape":"InternalServiceException"},
{"shape":"LimitExceededException"}
],
- "documentation":"<p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p> <p>Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.</p> <p>Before creating a new game server group, you must have the following: </p> <ul> <li> <p>An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\"> Launching an Instance from a Launch Template</a> in the <i>Amazon EC2 User Guide</i>. </p> </li> <li> <p>An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html\">Create IAM roles for cross-service interaction</a> in the <i>GameLift FleetIQ Developer Guide</i>.</p> </li> </ul> <p>To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.</p> <p>Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html\">GameLift FleetIQ Guide</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameServerGroup</a> | <a>ListGameServerGroups</a> | <a>DescribeGameServerGroup</a> | <a>UpdateGameServerGroup</a> | <a>DeleteGameServerGroup</a> | <a>ResumeGameServerGroup</a> | <a>SuspendGameServerGroup</a> | <a>DescribeGameServerInstances</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html\">All APIs by task</a> </p>"
+ "documentation":"<p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p> <p>Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.</p> <p>Before creating a new game server group, you must have the following: </p> <ul> <li> <p>An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\"> Launching an Instance from a Launch Template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> </li> <li> <p>An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html\">Create IAM roles for cross-service interaction</a> in the <i>GameLift FleetIQ Developer Guide</i>.</p> </li> </ul> <p>To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.</p> <p>Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html\">GameLift FleetIQ Guide</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameServerGroup</a> | <a>ListGameServerGroups</a> | <a>DescribeGameServerGroup</a> | <a>UpdateGameServerGroup</a> | <a>DeleteGameServerGroup</a> | <a>ResumeGameServerGroup</a> | <a>SuspendGameServerGroup</a> | <a>DescribeGameServerInstances</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html\">All APIs by task</a> </p>"
},
"CreateGameSession":{
"name":"CreateGameSession",
@@ -157,7 +157,7 @@
{"shape":"IdempotentParameterMismatchException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with </p> <p>with <a>StartGameSessionPlacement</a>, which uses FleetIQ algorithms and queues to optimize the placement process.</p> <p>When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in <code>ACTIVE</code> status before a game session can be created in it. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration. </p> </li> <li> <p>To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration. </p> </li> </ul> <p>If successful, a workflow is initiated to start a new game session. A <code>GameSession</code> object is returned containing the game session configuration and status. When the status is <code>ACTIVE</code>, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using <a>UpdateGameSession</a> to change the game session's player session creation policy.</p> <p>Game session logs are retained for all active game sessions for 14 days. To access the logs, call <a>GetGameSessionLogUrl</a> to download the log files.</p> <p> <i>Available in GameLift Local.</i> </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a game session</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with </p> <p>with <a>StartGameSessionPlacement</a>, which uses FleetIQ algorithms and queues to optimize the placement process.</p> <p>When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in <code>ACTIVE</code> status before a game session can be created in it. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration. </p> </li> <li> <p>To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration. </p> </li> </ul> <p>If successful, a workflow is initiated to start a new game session. A <code>GameSession</code> object is returned containing the game session configuration and status. When the status is <code>ACTIVE</code>, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using <a>UpdateGameSession</a> to change the game session's player session creation policy.</p> <p>Game session logs are retained for all active game sessions for 14 days. To access the logs, call <a>GetGameSessionLogUrl</a> to download the log files.</p> <p> <i>Available in Amazon Web Services Local.</i> </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a game session</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateGameSessionQueue":{
"name":"CreateGameSessionQueue",
@@ -175,7 +175,7 @@
{"shape":"NotFoundException"},
{"shape":"TaggingFailedException"}
],
- "documentation":"<p>Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session. </p> <p>A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and AWS Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.</p> <p>The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.</p> <p>To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.</p> <p>If successful, a new <code>GameSessionQueue</code> object is returned with an assigned queue ARN. New game session requests, which are submitted to the queue with <a>StartGameSessionPlacement</a> or <a>StartMatchmaking</a>, reference a queue's name or ARN. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html\"> Design a game session queue</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html\"> Create a game session queue</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSessionQueue</a> | <a>DescribeGameSessionQueues</a> | <a>UpdateGameSessionQueue</a> | <a>DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session. </p> <p>A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.</p> <p>The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.</p> <p>To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.</p> <p>If successful, a new <code>GameSessionQueue</code> object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html\">StartGameSessionPlacement</a> or <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html\">StartMatchmaking</a>, reference a queue's name or ARN. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html\"> Design a game session queue</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html\"> Create a game session queue</a> </p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html\">CreateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html\">DescribeGameSessionQueues</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html\">UpdateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html\">DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateMatchmakingConfiguration":{
"name":"CreateMatchmakingConfiguration",
@@ -193,7 +193,7 @@
{"shape":"UnsupportedRegionException"},
{"shape":"TaggingFailedException"}
],
- "documentation":"<p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests (<a>StartMatchmaking</a> or <a>StartMatchBackfill</a>) identify the matchmaking configuration to use and provide player attributes consistent with that configuration. </p> <p>To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.</p> <p>In addition, you must set up an Amazon Simple Notification Service (SNS) topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. An alternative method, continuously polling ticket status with <a>DescribeMatchmaking</a>, is only suitable for games in development with low matchmaking usage.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html\"> Design a FlexMatch matchmaker</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html\"> Set up FlexMatch event notification</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateMatchmakingConfiguration</a> | <a>DescribeMatchmakingConfigurations</a> | <a>UpdateMatchmakingConfiguration</a> | <a>DeleteMatchmakingConfiguration</a> | <a>CreateMatchmakingRuleSet</a> | <a>DescribeMatchmakingRuleSets</a> | <a>ValidateMatchmakingRuleSet</a> | <a>DeleteMatchmakingRuleSet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests (<a>StartMatchmaking</a> or <a>StartMatchBackfill</a>) identify the matchmaking configuration to use and provide player attributes consistent with that configuration. </p> <p>To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.</p> <p>In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. An alternative method, continuously polling ticket status with <a>DescribeMatchmaking</a>, is only suitable for games in development with low matchmaking usage.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html\"> Design a FlexMatch matchmaker</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html\"> Set up FlexMatch event notification</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateMatchmakingConfiguration</a> | <a>DescribeMatchmakingConfigurations</a> | <a>UpdateMatchmakingConfiguration</a> | <a>DeleteMatchmakingConfiguration</a> | <a>CreateMatchmakingRuleSet</a> | <a>DescribeMatchmakingRuleSets</a> | <a>ValidateMatchmakingRuleSet</a> | <a>DeleteMatchmakingRuleSet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateMatchmakingRuleSet":{
"name":"CreateMatchmakingRuleSet",
@@ -228,7 +228,7 @@
{"shape":"InvalidRequestException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. You can add a group of players to a game session with <a>CreatePlayerSessions</a>. </p> <p>To create a player session, specify a game session ID, player ID, and optionally a set of player data. </p> <p>If successful, a slot is reserved in the game session for the player and a new <a>PlayerSession</a> object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated. </p> <p> <i>Available in Amazon GameLift Local.</i> </p> <p> <b>Related actions</b> </p> <p> <a>CreatePlayerSession</a> | <a>CreatePlayerSessions</a> | <a>DescribePlayerSessions</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. You can add a group of players to a game session with <a>CreatePlayerSessions</a>. </p> <p>To create a player session, specify a game session ID, player ID, and optionally a set of player data. </p> <p>If successful, a slot is reserved in the game session for the player and a new <a>PlayerSession</a> object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated. </p> <p>The maximum number of players per game session is 200. It is not adjustable. </p> <p> <i>Available in Amazon Web Services Local.</i> </p> <p> <b>Related actions</b> </p> <p> <a>CreatePlayerSession</a> | <a>CreatePlayerSessions</a> | <a>DescribePlayerSessions</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreatePlayerSessions":{
"name":"CreatePlayerSessions",
@@ -247,7 +247,7 @@
{"shape":"InvalidRequestException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. To add a single player to a game session, use <a>CreatePlayerSession</a>. </p> <p>To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID. </p> <p>If successful, a slot is reserved in the game session for each player, and new <a>PlayerSession</a> objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.</p> <p> <i>Available in Amazon GameLift Local.</i> </p> <p> <b>Related actions</b> </p> <p> <a>CreatePlayerSession</a> | <a>CreatePlayerSessions</a> | <a>DescribePlayerSessions</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. To add a single player to a game session, use <a>CreatePlayerSession</a>. </p> <p>To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID. </p> <p>If successful, a slot is reserved in the game session for each player, and new <a>PlayerSession</a> objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.</p> <p>The maximum number of players per game session is 200. It is not adjustable. </p> <p> <i>Available in Amazon Web Services Local.</i> </p> <p> <b>Related actions</b> </p> <p> <a>CreatePlayerSession</a> | <a>CreatePlayerSessions</a> | <a>DescribePlayerSessions</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateScript":{
"name":"CreateScript",
@@ -264,7 +264,7 @@
{"shape":"TaggingFailedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. </p> <p>To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: </p> <ul> <li> <p>A locally available directory. Use the <i>ZipFile</i> parameter for this option.</p> </li> <li> <p>An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the <i>StorageLocation</i> parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket. </p> </li> </ul> <p>If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon GameLift Realtime Servers</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html\">Set Up a Role for Amazon GameLift Access</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. </p> <p>To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: </p> <ul> <li> <p>A locally available directory. Use the <i>ZipFile</i> parameter for this option.</p> </li> <li> <p>An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the <i>StorageLocation</i> parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon Web Services service to access your S3 bucket. </p> </li> </ul> <p>If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon Web Services-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon Web Services accesses the file at this storage location as needed for deployment.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon Web Services Realtime Servers</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html\">Set Up a Role for Amazon Web Services Access</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateVpcPeeringAuthorization":{
"name":"CreateVpcPeeringAuthorization",
@@ -280,7 +280,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call <a>CreateVpcPeeringConnection</a> to establish the peering connection. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with Amazon GameLift Fleets</a>.</p> <p>You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.</p> <p>To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. </p> <p>To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift. </p> <p>The authorization remains valid for 24 hours unless it is canceled by a call to <a>DeleteVpcPeeringAuthorization</a>. You must create or delete the peering connection while the authorization is valid. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Requests authorization to create or delete a peer connection between the VPC for your Amazon Web Services fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've received authorization, call <a>CreateVpcPeeringConnection</a> to establish the peering connection. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with Amazon Web Services Fleets</a>.</p> <p>You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon Web Services fleets. You cannot peer with VPCs that are in different Regions.</p> <p>To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon Web Services fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon Web Services. If successful, VPC peering is authorized for the specified VPC. </p> <p>To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon Web Services fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon Web Services. </p> <p>The authorization remains valid for 24 hours unless it is canceled by a call to <a>DeleteVpcPeeringAuthorization</a>. You must create or delete the peering connection while the authorization is valid. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"CreateVpcPeeringConnection":{
"name":"CreateVpcPeeringConnection",
@@ -296,7 +296,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with Amazon GameLift Fleets</a>.</p> <p>Before calling this operation to establish the peering connection, you first need to call <a>CreateVpcPeeringAuthorization</a> and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. </p> <p>To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a <a>VpcPeeringConnection</a> request is created. You can use continuous polling to track the request's status using <a>DescribeVpcPeeringConnections</a>, or by monitoring fleet events for success or failure using <a>DescribeFleetEvents</a>. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon Web Services fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon Web Services fleets. You cannot peer with VPCs that are in different Regions. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with Amazon Web Services Fleets</a>.</p> <p>Before calling this operation to establish the peering connection, you first need to call <a>CreateVpcPeeringAuthorization</a> and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. </p> <p>To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon Web Services fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a <a>VpcPeeringConnection</a> request is created. You can use continuous polling to track the request's status using <a>DescribeVpcPeeringConnections</a>, or by monitoring fleet events for success or failure using <a>DescribeFleetEvents</a>. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DeleteAlias":{
"name":"DeleteAlias",
@@ -395,7 +395,7 @@
{"shape":"UnauthorizedException"},
{"shape":"TaggingFailedException"}
],
- "documentation":"<p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a>StartGameSessionPlacement</a> requests that reference the queue will fail. To delete a queue, specify the queue name.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html\"> Using Multi-Region Queues</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSessionQueue</a> | <a>DescribeGameSessionQueues</a> | <a>UpdateGameSessionQueue</a> | <a>DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html\">StartGameSessionPlacement</a> requests that reference the queue will fail. To delete a queue, specify the queue name.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html\"> Using Multi-Region Queues</a> </p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html\">CreateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html\">DescribeGameSessionQueues</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html\">UpdateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html\">DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DeleteMatchmakingConfiguration":{
"name":"DeleteMatchmakingConfiguration",
@@ -460,7 +460,7 @@
{"shape":"TaggingFailedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). </p> <p>To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon GameLift Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). </p> <p>To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon Web Services Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DeleteVpcPeeringAuthorization":{
"name":"DeleteVpcPeeringAuthorization",
@@ -492,7 +492,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling <a>DescribeVpcPeeringAuthorizations</a> or request a new one using <a>CreateVpcPeeringAuthorization</a>. </p> <p>Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling <a>DescribeVpcPeeringAuthorizations</a> or request a new one using <a>CreateVpcPeeringAuthorization</a>. </p> <p>Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon Web Services fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DeregisterGameServer":{
"name":"DeregisterGameServer",
@@ -555,7 +555,7 @@
{"shape":"UnauthorizedException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>The GameLift service limits and current utilization for an AWS Region or location. Instance limits control the number of instances, per instance type, per location, that your AWS account can use. Learn more at <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a>. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p> <p>Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an AWS Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results: </p> <ul> <li> <p>Request specifies the Region <code>ap-northeast-1</code> with no location. The result is limits and usage data on all instance types that are deployed in <code>us-east-2</code>, by all of the fleets that reside in <code>ap-northeast-1</code>. </p> </li> <li> <p>Request specifies the Region <code>us-east-1</code> with location <code>ca-central-1</code>. The result is limits and usage data on all instance types that are deployed in <code>ca-central-1</code>, by all of the fleets that reside in <code>us-east-2</code>. These limits do not affect fleets in any other Regions that deploy instances to <code>ca-central-1</code>.</p> </li> <li> <p>Request specifies the Region <code>eu-west-1</code> with location <code>ca-central-1</code>. The result is limits and usage data on all instance types that are deployed in <code>ca-central-1</code>, by all of the fleets that reside in <code>eu-west-1</code>.</p> </li> </ul> <p>This operation can be used in the following ways:</p> <ul> <li> <p>To get limit and usage data for all instance types that are deployed in an AWS Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.</p> </li> <li> <p>To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different AWS Region: Provide both the AWS Region and the remote location. Optionally, specify a single instance type to retrieve information for.</p> </li> </ul> <p>If successful, an <code>EC2InstanceLimits</code> object is returned with limits and usage data for each requested instance type.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up GameLift fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> | <a>UpdateFleetCapacity</a> | <a>PutScalingPolicy</a> | <a>DescribeEC2InstanceLimits</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetLocationAttributes</a> | <a>UpdateFleetAttributes</a> | <a>StopFleetActions</a> | <a>DeleteFleet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a>. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p> <p>Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results: </p> <ul> <li> <p>Request specifies the Region <code>ap-northeast-1</code> with no location. The result is limits and usage data on all instance types that are deployed in <code>us-east-2</code>, by all of the fleets that reside in <code>ap-northeast-1</code>. </p> </li> <li> <p>Request specifies the Region <code>us-east-1</code> with location <code>ca-central-1</code>. The result is limits and usage data on all instance types that are deployed in <code>ca-central-1</code>, by all of the fleets that reside in <code>us-east-2</code>. These limits do not affect fleets in any other Regions that deploy instances to <code>ca-central-1</code>.</p> </li> <li> <p>Request specifies the Region <code>eu-west-1</code> with location <code>ca-central-1</code>. The result is limits and usage data on all instance types that are deployed in <code>ca-central-1</code>, by all of the fleets that reside in <code>eu-west-1</code>.</p> </li> </ul> <p>This operation can be used in the following ways:</p> <ul> <li> <p>To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.</p> </li> <li> <p>To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.</p> </li> </ul> <p>If successful, an <code>EC2InstanceLimits</code> object is returned with limits and usage data for each requested instance type.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up GameLift fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> | <a>UpdateFleetCapacity</a> | <a>PutScalingPolicy</a> | <a>DescribeEC2InstanceLimits</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetLocationAttributes</a> | <a>UpdateFleetAttributes</a> | <a>StopFleetActions</a> | <a>DeleteFleet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeFleetAttributes":{
"name":"DescribeFleetAttributes",
@@ -752,7 +752,7 @@
{"shape":"TerminalRoutingStrategyException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use <a>SearchGameSessions</a> to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use <a>DescribeGameSessions</a>. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.</p> </li> <li> <p>To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.</p> </li> <li> <p>To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the AWS Region defined in the request.</p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>GameSessionDetail</code> object is returned for each game session that matches the request.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find\">Find a game session</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use <a>SearchGameSessions</a> to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use <a>DescribeGameSessions</a>. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.</p> </li> <li> <p>To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.</p> </li> <li> <p>To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.</p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>GameSessionDetail</code> object is returned for each game session that matches the request.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find\">Find a game session</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeGameSessionPlacement":{
"name":"DescribeGameSessionPlacement",
@@ -768,7 +768,7 @@
{"shape":"NotFoundException"},
{"shape":"UnauthorizedException"}
],
- "documentation":"<p>Retrieves information, including current status, about a game session placement request. </p> <p>To get game session placement details, specify the placement ID.</p> <p>If successful, a <a>GameSessionPlacement</a> object is returned.</p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves information, including current status, about a game session placement request. </p> <p>To get game session placement details, specify the placement ID.</p> <p>This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with <code>DescribeGameSessionPlacement</code> should only be used for games in development with low game session usage. </p> <p>If successful, a <a>GameSessionPlacement</a> object is returned.</p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeGameSessionQueues":{
"name":"DescribeGameSessionQueues",
@@ -784,7 +784,7 @@
{"shape":"NotFoundException"},
{"shape":"UnauthorizedException"}
],
- "documentation":"<p>Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a <a>GameSessionQueue</a> object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html\"> View Your Queues</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSessionQueue</a> | <a>DescribeGameSessionQueues</a> | <a>UpdateGameSessionQueue</a> | <a>DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a <a>GameSessionQueue</a> object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html\"> View Your Queues</a> </p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html\">CreateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html\">DescribeGameSessionQueues</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html\">UpdateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html\">DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeGameSessions":{
"name":"DescribeGameSessions",
@@ -802,7 +802,7 @@
{"shape":"TerminalRoutingStrategyException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use <a>SearchGameSessions</a> to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use <a>DescribeGameSessionDetails</a>.</p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.</p> </li> <li> <p>To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.</p> </li> <li> <p>To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the AWS Region defined in the request.</p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>GameSession</code> object is returned for each game session that matches the request.</p> <p> <i>Available in GameLift Local.</i> </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find\">Find a game session</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use <a>SearchGameSessions</a> to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use <a>DescribeGameSessionDetails</a>.</p> <p>This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with <code>DescribeGameSessions</code> should only be used for games in development with low game session usage. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.</p> </li> <li> <p>To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.</p> </li> <li> <p>To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.</p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>GameSession</code> object is returned for each game session that matches the request.</p> <p>This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with <a>DescribeGameSessions</a> should only be used for games in development with low matchmaking usage.</p> <p> <i>Available in Amazon Web Services Local.</i> </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find\">Find a game session</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeInstances":{
"name":"DescribeInstances",
@@ -834,7 +834,7 @@
{"shape":"InternalServiceException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. </p> <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.</p> <p>This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with <a>DescribeMatchmaking</a> should only be used for games in development with low matchmaking usage.</p> <p/> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html\"> Add FlexMatch to a game client</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html\"> Set Up FlexMatch event notification</a> </p> <p> <b>Related actions</b> </p> <p> <a>StartMatchmaking</a> | <a>DescribeMatchmaking</a> | <a>StopMatchmaking</a> | <a>AcceptMatch</a> | <a>StartMatchBackfill</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. </p> <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.</p> <p>This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously polling ticket status with <a>DescribeMatchmaking</a> should only be used for games in development with low matchmaking usage.</p> <p/> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html\"> Add FlexMatch to a game client</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html\"> Set Up FlexMatch event notification</a> </p> <p> <b>Related actions</b> </p> <p> <a>StartMatchmaking</a> | <a>DescribeMatchmaking</a> | <a>StopMatchmaking</a> | <a>AcceptMatch</a> | <a>StartMatchBackfill</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeMatchmakingConfigurations":{
"name":"DescribeMatchmakingConfigurations",
@@ -881,7 +881,7 @@
{"shape":"InvalidRequestException"},
{"shape":"UnauthorizedException"}
],
- "documentation":"<p>Retrieves properties for one or more player sessions. </p> <p>This action can be used in the following ways: </p> <ul> <li> <p>To retrieve a specific player session, provide the player session ID only.</p> </li> <li> <p>To retrieve all player sessions in a game session, provide the game session ID only.</p> </li> <li> <p>To retrieve all player sessions for a specific player, provide a player ID only.</p> </li> </ul> <p>To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>PlayerSession</code> object is returned for each session that matches the request.</p> <p> <i>Available in Amazon GameLift Local.</i> </p> <p> <b>Related actions</b> </p> <p> <a>CreatePlayerSession</a> | <a>CreatePlayerSessions</a> | <a>DescribePlayerSessions</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves properties for one or more player sessions. </p> <p>This action can be used in the following ways: </p> <ul> <li> <p>To retrieve a specific player session, provide the player session ID only.</p> </li> <li> <p>To retrieve all player sessions in a game session, provide the game session ID only.</p> </li> <li> <p>To retrieve all player sessions for a specific player, provide a player ID only.</p> </li> </ul> <p>To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>PlayerSession</code> object is returned for each session that matches the request.</p> <p> <i>Available in Amazon Web Services Local.</i> </p> <p> <b>Related actions</b> </p> <p> <a>CreatePlayerSession</a> | <a>CreatePlayerSessions</a> | <a>DescribePlayerSessions</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeRuntimeConfiguration":{
"name":"DescribeRuntimeConfiguration",
@@ -930,7 +930,7 @@
{"shape":"InternalServiceException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Retrieves properties for a Realtime script. </p> <p>To request a script record, specify the script ID. If successful, an object containing the script properties is returned.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon GameLift Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves properties for a Realtime script. </p> <p>To request a script record, specify the script ID. If successful, an object containing the script properties is returned.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon Web Services Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeVpcPeeringAuthorizations":{
"name":"DescribeVpcPeeringAuthorizations",
@@ -945,7 +945,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"DescribeVpcPeeringConnections":{
"name":"DescribeVpcPeeringConnections",
@@ -961,7 +961,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. </p> <p>To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. </p> <p>To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon Web Services fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. </p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"GetGameSessionLogUrl":{
"name":"GetGameSessionLogUrl",
@@ -977,7 +977,7 @@
{"shape":"UnauthorizedException"},
{"shape":"InvalidRequestException"}
],
- "documentation":"<p>Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.</p> <note> <p>See the <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift\">AWS Service Limits</a> page for maximum log file sizes. Log files that exceed this limit are not saved.</p> </note> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.</p> <note> <p>See the <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift\">Amazon Web Services Service Limits</a> page for maximum log file sizes. Log files that exceed this limit are not saved.</p> </note> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"GetInstanceAccess":{
"name":"GetInstanceAccess",
@@ -993,7 +993,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. </p> <p>To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a <code>.pem</code> file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples for this operation. </p> <p>To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling <a>DescribeInstances</a>. If successful, an <a>InstanceAccess</a> object is returned that contains the instance's IP address and a set of credentials.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html\">Remotely Access Fleet Instances</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html\">Debug Fleet Issues</a> </p> <p> <b>Related actions</b> </p> <p> <a>DescribeInstances</a> | <a>GetInstanceAccess</a> | <a>DescribeEC2InstanceLimits</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. </p> <p>To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a <code>.pem</code> file before using. If you're making this request using the CLI, saving the secret can be handled as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples for this operation. </p> <p>To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling <a>DescribeInstances</a>. If successful, an <a>InstanceAccess</a> object is returned that contains the instance's IP address and a set of credentials.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html\">Remotely Access Fleet Instances</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html\">Debug Fleet Issues</a> </p> <p> <b>Related actions</b> </p> <p> <a>DescribeInstances</a> | <a>GetInstanceAccess</a> | <a>DescribeEC2InstanceLimits</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ListAliases":{
"name":"ListAliases",
@@ -1008,7 +1008,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.</p> <note> <p>Returned aliases are not listed in any particular order.</p> </note> <p> <b>Related actions</b> </p> <p> <a>CreateAlias</a> | <a>ListAliases</a> | <a>DescribeAlias</a> | <a>UpdateAlias</a> | <a>DeleteAlias</a> | <a>ResolveAlias</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.</p> <note> <p>Returned aliases are not listed in any particular order.</p> </note> <p> <b>Related actions</b> </p> <p> <a>CreateAlias</a> | <a>ListAliases</a> | <a>DescribeAlias</a> | <a>UpdateAlias</a> | <a>DeleteAlias</a> | <a>ResolveAlias</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ListBuilds":{
"name":"ListBuilds",
@@ -1023,7 +1023,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Retrieves build resources for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the <code>Status</code> parameter. Use the pagination parameters to retrieve results in a set of sequential pages. </p> <note> <p>Build resources are not listed in any particular order.</p> </note> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\"> Upload a Custom Server Build</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateBuild</a> | <a>ListBuilds</a> | <a>DescribeBuild</a> | <a>UpdateBuild</a> | <a>DeleteBuild</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the <code>Status</code> parameter. Use the pagination parameters to retrieve results in a set of sequential pages. </p> <note> <p>Build resources are not listed in any particular order.</p> </note> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\"> Upload a Custom Server Build</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateBuild</a> | <a>ListBuilds</a> | <a>DescribeBuild</a> | <a>UpdateBuild</a> | <a>DeleteBuild</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ListFleets":{
"name":"ListFleets",
@@ -1039,7 +1039,7 @@
{"shape":"InvalidRequestException"},
{"shape":"UnauthorizedException"}
],
- "documentation":"<p>Retrieves a collection of fleet resources in an AWS Region. You can call this operation to get fleets in a previously selected default Region (see <a href=\"https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html\">https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html</a>or specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.</p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To get a list of all fleets in a Region, don't provide a build or script identifier. </p> </li> <li> <p>To get a list of all fleets where a specific custom game build is deployed, provide the build ID.</p> </li> <li> <p>To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID. </p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.</p> <note> <p>Fleet resources are not listed in a particular order.</p> </note> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up GameLift fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> | <a>UpdateFleetCapacity</a> | <a>PutScalingPolicy</a> | <a>DescribeEC2InstanceLimits</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetLocationAttributes</a> | <a>UpdateFleetAttributes</a> | <a>StopFleetActions</a> | <a>DeleteFleet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see <a href=\"https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html\">https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html</a>or specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.</p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To get a list of all fleets in a Region, don't provide a build or script identifier. </p> </li> <li> <p>To get a list of all fleets where a specific custom game build is deployed, provide the build ID.</p> </li> <li> <p>To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID. </p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.</p> <note> <p>Fleet resources are not listed in a particular order.</p> </note> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\">Setting up GameLift fleets</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> | <a>UpdateFleetCapacity</a> | <a>PutScalingPolicy</a> | <a>DescribeEC2InstanceLimits</a> | <a>DescribeFleetAttributes</a> | <a>DescribeFleetLocationAttributes</a> | <a>UpdateFleetAttributes</a> | <a>StopFleetActions</a> | <a>DeleteFleet</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ListGameServerGroups":{
"name":"ListGameServerGroups",
@@ -1054,7 +1054,7 @@
{"shape":"UnauthorizedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p> <p>Retrieves information on all game servers groups that exist in the current AWS account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html\">GameLift FleetIQ Guide</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameServerGroup</a> | <a>ListGameServerGroups</a> | <a>DescribeGameServerGroup</a> | <a>UpdateGameServerGroup</a> | <a>DeleteGameServerGroup</a> | <a>ResumeGameServerGroup</a> | <a>SuspendGameServerGroup</a> | <a>DescribeGameServerInstances</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html\">All APIs by task</a> </p>"
+ "documentation":"<p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p> <p>Retrieves information on all game servers groups that exist in the current Amazon Web Services account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html\">GameLift FleetIQ Guide</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameServerGroup</a> | <a>ListGameServerGroups</a> | <a>DescribeGameServerGroup</a> | <a>UpdateGameServerGroup</a> | <a>DeleteGameServerGroup</a> | <a>ResumeGameServerGroup</a> | <a>SuspendGameServerGroup</a> | <a>DescribeGameServerInstances</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html\">All APIs by task</a> </p>"
},
"ListGameServers":{
"name":"ListGameServers",
@@ -1084,7 +1084,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Retrieves script records for all Realtime scripts that are associated with the AWS account in use. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon GameLift Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon Web Services Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@@ -1100,7 +1100,7 @@
{"shape":"TaggingFailedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p> Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize AWS resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p> <ul> <li> <p>Build</p> </li> <li> <p>Script</p> </li> <li> <p>Fleet</p> </li> <li> <p>Alias</p> </li> <li> <p>GameSessionQueue</p> </li> <li> <p>MatchmakingConfiguration</p> </li> <li> <p>MatchmakingRuleSet</p> </li> </ul> <p>To list tags for a resource, specify the unique ARN value for the resource.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> in the <i>AWS General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> AWS Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p> Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p> <ul> <li> <p>Build</p> </li> <li> <p>Script</p> </li> <li> <p>Fleet</p> </li> <li> <p>Alias</p> </li> <li> <p>GameSessionQueue</p> </li> <li> <p>MatchmakingConfiguration</p> </li> <li> <p>MatchmakingRuleSet</p> </li> </ul> <p>To list tags for a resource, specify the unique ARN value for the resource.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> Amazon Web Services Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
@@ -1116,7 +1116,7 @@
{"shape":"UnauthorizedException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. </p> <p>Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.</p> <p>You can temporarily suspend all scaling policies for a fleet by calling <a>StopFleetActions</a> with the fleet action AUTO_SCALING. To resume scaling policies, call <a>StartFleetActions</a> with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with <a>DeleteScalingPolicy</a>.</p> <p>Learn more about how to work with auto-scaling in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html\">Set Up Fleet Automatic Scaling</a>.</p> <p> <b>Target-based policy</b> </p> <p>A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target. </p> <p>For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer. </p> <p>To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a <a>TargetConfiguration</a> object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.</p> <p> <b>Rule-based policy</b> </p> <p>A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. </p> <p>For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"</p> <p>A policy's rule statement has the following structure:</p> <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code> <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p> <p>To implement the example, the rule statement would look like this:</p> <p>If <code>[PercentIdleInstances]</code> is <code>[GreaterThanThreshold]</code> <code>[20]</code> for <code>[15]</code> minutes, then <code>[PercentChangeInCapacity]</code> to/by <code>[10]</code>.</p> <p>To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetCapacity</a> | <a>UpdateFleetCapacity</a> | <a>DescribeEC2InstanceLimits</a> | <a>PutScalingPolicy</a> | <a>DescribeScalingPolicies</a> | <a>DeleteScalingPolicy</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon Web Services to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. </p> <p>Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.</p> <p>You can temporarily suspend all scaling policies for a fleet by calling <a>StopFleetActions</a> with the fleet action AUTO_SCALING. To resume scaling policies, call <a>StartFleetActions</a> with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with <a>DeleteScalingPolicy</a>.</p> <p>Learn more about how to work with auto-scaling in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html\">Set Up Fleet Automatic Scaling</a>.</p> <p> <b>Target-based policy</b> </p> <p>A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon Web Services to take whatever action is needed to maintain that target. </p> <p>For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon Web Services to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon Web Services will start new instances or stop unused instances in order to return to the 10% buffer. </p> <p>To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a <a>TargetConfiguration</a> object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.</p> <p> <b>Rule-based policy</b> </p> <p>A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. </p> <p>For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"</p> <p>A policy's rule statement has the following structure:</p> <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code> <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p> <p>To implement the example, the rule statement would look like this:</p> <p>If <code>[PercentIdleInstances]</code> is <code>[GreaterThanThreshold]</code> <code>[20]</code> for <code>[15]</code> minutes, then <code>[PercentChangeInCapacity]</code> to/by <code>[10]</code>.</p> <p>To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetCapacity</a> | <a>UpdateFleetCapacity</a> | <a>DescribeEC2InstanceLimits</a> | <a>PutScalingPolicy</a> | <a>DescribeScalingPolicies</a> | <a>DeleteScalingPolicy</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"RegisterGameServer":{
"name":"RegisterGameServer",
@@ -1149,7 +1149,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see <a>CreateBuild</a>.</p> <p>To request new credentials, specify the build ID as returned with an initial <code>CreateBuild</code> request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build\"> Create a Build with Files in S3</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateBuild</a> | <a>ListBuilds</a> | <a>DescribeBuild</a> | <a>UpdateBuild</a> | <a>DeleteBuild</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon Web Services's Amazon S3. This is done as part of the build creation process; see <a>CreateBuild</a>.</p> <p>To request new credentials, specify the build ID as returned with an initial <code>CreateBuild</code> request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build\"> Create a Build with Files in S3</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateBuild</a> | <a>ListBuilds</a> | <a>DescribeBuild</a> | <a>UpdateBuild</a> | <a>DeleteBuild</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ResolveAlias":{
"name":"ResolveAlias",
@@ -1200,7 +1200,7 @@
{"shape":"TerminalRoutingStrategyException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order. </p> <p>When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.</p> </li> <li> <p>To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.</p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>GameSession</code> object is returned for each game session that matches the request. Search finds game sessions that are in <code>ACTIVE</code> status only. To retrieve information on game sessions in other statuses, use <a>DescribeGameSessions</a>.</p> <p>You can search or sort by the following game session attributes:</p> <ul> <li> <p> <b>gameSessionId</b> -- A unique identifier for the game session. You can use either a <code>GameSessionId</code> or <code>GameSessionArn</code> value. </p> </li> <li> <p> <b>gameSessionName</b> -- Name assigned to a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>. Game session names do not need to be unique to a game session.</p> </li> <li> <p> <b>gameSessionProperties</b> -- Custom data defined in a game session's <code>GameProperty</code> parameter. <code>GameProperty</code> values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair \"gameMode:brawl\", specify the following: <code>gameSessionProperties.gameMode = \"brawl\"</code>. All custom data values are searched as strings.</p> </li> <li> <p> <b>maximumSessions</b> -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>.</p> </li> <li> <p> <b>creationTimeMillis</b> -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.</p> </li> <li> <p> <b>playerSessionCount</b> -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.</p> </li> <li> <p> <b>hasAvailablePlayerSessions</b> -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. </p> </li> </ul> <note> <p>Returned values for <code>playerSessionCount</code> and <code>hasAvailablePlayerSessions</code> change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join. </p> </note> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order. </p> <p>This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status with <code>DescribeGameSessions</code> should only be used for games in development with low game session usage. </p> <p>When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations. </p> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.</p> </li> <li> <p>To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.</p> </li> </ul> <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a <code>GameSession</code> object is returned for each game session that matches the request. Search finds game sessions that are in <code>ACTIVE</code> status only. To retrieve information on game sessions in other statuses, use <a>DescribeGameSessions</a>.</p> <p>You can search or sort by the following game session attributes:</p> <ul> <li> <p> <b>gameSessionId</b> -- A unique identifier for the game session. You can use either a <code>GameSessionId</code> or <code>GameSessionArn</code> value. </p> </li> <li> <p> <b>gameSessionName</b> -- Name assigned to a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>. Game session names do not need to be unique to a game session.</p> </li> <li> <p> <b>gameSessionProperties</b> -- Custom data defined in a game session's <code>GameProperty</code> parameter. <code>GameProperty</code> values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair \"gameMode:brawl\", specify the following: <code>gameSessionProperties.gameMode = \"brawl\"</code>. All custom data values are searched as strings.</p> </li> <li> <p> <b>maximumSessions</b> -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>.</p> </li> <li> <p> <b>creationTimeMillis</b> -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.</p> </li> <li> <p> <b>playerSessionCount</b> -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.</p> </li> <li> <p> <b>hasAvailablePlayerSessions</b> -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. </p> </li> </ul> <note> <p>Returned values for <code>playerSessionCount</code> and <code>hasAvailablePlayerSessions</code> change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join. </p> </note> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"StartFleetActions":{
"name":"StartFleetActions",
@@ -1233,7 +1233,7 @@
{"shape":"NotFoundException"},
{"shape":"UnauthorizedException"}
],
- "documentation":"<p>Places a request for a new game session in a queue (see <a>CreateGameSessionQueue</a>). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.</p> <p>A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.</p> <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.</p> <p>Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players. </p> <p>To place a new game session request, specify the following:</p> <ul> <li> <p>The queue name and a set of game session properties and settings</p> </li> <li> <p>A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request</p> </li> <li> <p>(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)</p> </li> <li> <p>Latency data for all players (if you want to optimize game play for the players)</p> </li> </ul> <p>If successful, a new game session placement is created.</p> <p>To track the status of a placement request, call <a>DescribeGameSessionPlacement</a> and check the request's status. If the status is <code>FULFILLED</code>, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Places a request for a new game session in a queue (see <a>CreateGameSessionQueue</a>). When processing a placement request, Amazon Web Services searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.</p> <p>A game session placement request can also request player sessions. When a new game session is successfully created, Amazon Web Services creates a player session for each player included in the request.</p> <p>When placing a game session, by default Amazon Web Services tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.</p> <p>Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon Web Services uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon Web Services calculates each Region's average lag for all players and reorders to get the best game play across all players. </p> <p>To place a new game session request, specify the following:</p> <ul> <li> <p>The queue name and a set of game session properties and settings</p> </li> <li> <p>A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request</p> </li> <li> <p>(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)</p> </li> <li> <p>Latency data for all players (if you want to optimize game play for the players)</p> </li> </ul> <p>If successful, a new game session placement is created.</p> <p>To track the status of a placement request, call <a>DescribeGameSessionPlacement</a> and check the request's status. If the status is <code>FULFILLED</code>, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"StartMatchBackfill":{
"name":"StartMatchBackfill",
@@ -1249,7 +1249,7 @@
{"shape":"InternalServiceException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements. </p> <p>When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a <a>GameSession</a> identifier. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the <code>GameSession</code> resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.</p> <p>When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.</p> <p>To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html\"> Backfill existing games with FlexMatch</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html\"> Matchmaking events</a> (reference)</p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html\"> How GameLift FlexMatch works</a> </p> <p> <b>Related actions</b> </p> <p> <a>StartMatchmaking</a> | <a>DescribeMatchmaking</a> | <a>StopMatchmaking</a> | <a>AcceptMatch</a> | <a>StartMatchBackfill</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements. </p> <p>When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a <a>GameSession</a> identifier. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the <code>GameSession</code> resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.</p> <p>When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.</p> <p>To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.</p> <p>Only game sessions created by FlexMatch are supported for match backfill.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html\"> Backfill existing games with FlexMatch</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html\"> Matchmaking events</a> (reference)</p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html\"> How GameLift FlexMatch works</a> </p> <p> <b>Related actions</b> </p> <p> <a>StartMatchmaking</a> | <a>DescribeMatchmaking</a> | <a>StopMatchmaking</a> | <a>AcceptMatch</a> | <a>StartMatchBackfill</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"StartMatchmaking":{
"name":"StartMatchmaking",
@@ -1265,7 +1265,7 @@
{"shape":"InternalServiceException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match. </p> <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to <code>QUEUED</code>. </p> <p>Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service (SNS), which is defined in the matchmaking configuration.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html\"> Add FlexMatch to a game client</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html\"> Set Up FlexMatch event notification</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html\"> How GameLift FlexMatch works</a> </p> <p> <b>Related actions</b> </p> <p> <a>StartMatchmaking</a> | <a>DescribeMatchmaking</a> | <a>StopMatchmaking</a> | <a>AcceptMatch</a> | <a>StartMatchBackfill</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match. </p> <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to <code>QUEUED</code>. </p> <p>Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html\"> Add FlexMatch to a game client</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html\"> Set Up FlexMatch event notification</a> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html\"> How GameLift FlexMatch works</a> </p> <p> <b>Related actions</b> </p> <p> <a>StartMatchmaking</a> | <a>DescribeMatchmaking</a> | <a>StopMatchmaking</a> | <a>AcceptMatch</a> | <a>StartMatchBackfill</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"StopFleetActions":{
"name":"StopFleetActions",
@@ -1346,7 +1346,7 @@
{"shape":"TaggingFailedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p> Assigns a tag to a GameLift resource. AWS resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize AWS cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p> <ul> <li> <p>Build</p> </li> <li> <p>Script</p> </li> <li> <p>Fleet</p> </li> <li> <p>Alias</p> </li> <li> <p>GameSessionQueue</p> </li> <li> <p>MatchmakingConfiguration</p> </li> <li> <p>MatchmakingRuleSet</p> </li> </ul> <p>To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> in the <i>AWS General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> AWS Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p> Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p> <ul> <li> <p>Build</p> </li> <li> <p>Script</p> </li> <li> <p>Fleet</p> </li> <li> <p>Alias</p> </li> <li> <p>GameSessionQueue</p> </li> <li> <p>MatchmakingConfiguration</p> </li> <li> <p>MatchmakingRuleSet</p> </li> </ul> <p>To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> Amazon Web Services Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"UntagResource":{
"name":"UntagResource",
@@ -1362,7 +1362,7 @@
{"shape":"TaggingFailedException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize AWS resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p> <ul> <li> <p>Build</p> </li> <li> <p>Script</p> </li> <li> <p>Fleet</p> </li> <li> <p>Alias</p> </li> <li> <p>GameSessionQueue</p> </li> <li> <p>MatchmakingConfiguration</p> </li> <li> <p>MatchmakingRuleSet</p> </li> </ul> <p>To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> in the <i>AWS General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> AWS Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p> <ul> <li> <p>Build</p> </li> <li> <p>Script</p> </li> <li> <p>Fleet</p> </li> <li> <p>Alias</p> </li> <li> <p>GameSessionQueue</p> </li> <li> <p>MatchmakingConfiguration</p> </li> <li> <p>MatchmakingRuleSet</p> </li> </ul> <p>To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> Amazon Web Services Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"UpdateAlias":{
"name":"UpdateAlias",
@@ -1433,7 +1433,7 @@
{"shape":"UnauthorizedException"},
{"shape":"UnsupportedRegionException"}
],
- "documentation":"<p>Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties: </p> <ul> <li> <p>Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling. </p> </li> <li> <p>Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call <a>DescribeEC2InstanceLimits</a> to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.</p> </li> </ul> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the <code>Location</code> parameter. The fleet must be in <code>ACTIVE</code> status. </p> </li> <li> <p>To update capacity for a fleet's remote location, include the <code>Location</code> parameter set to the location to be updated. The location must be in <code>ACTIVE</code> status.</p> </li> </ul> <p>If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling <a>DescribeFleetCapacity</a> or <a>DescribeFleetLocationCapacity</a>. If the requested desired instance count is higher than the instance type's limit, the <code>LimitExceeded</code> exception occurs.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html\">Scaling fleet capacity</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleetLocations</a> | <a>UpdateFleetAttributes</a> | <a>UpdateFleetCapacity</a> | <a>UpdateFleetPortSettings</a> | <a>UpdateRuntimeConfiguration</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a>PutScalingPolicy</a> | <a>DeleteFleet</a> | <a>DeleteFleetLocations</a> | <a>DeleteScalingPolicy</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties: </p> <ul> <li> <p>Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling. </p> </li> <li> <p>Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call <a>DescribeEC2InstanceLimits</a> to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.</p> </li> </ul> <p>This operation can be used in the following ways: </p> <ul> <li> <p>To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the <code>Location</code> parameter. The fleet must be in <code>ACTIVE</code> status. </p> </li> <li> <p>To update capacity for a fleet's remote location, include the <code>Location</code> parameter set to the location to be updated. The location must be in <code>ACTIVE</code> status.</p> </li> </ul> <p>If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling <a>DescribeFleetCapacity</a> or <a>DescribeFleetLocationCapacity</a>. If the requested desired instance count is higher than the instance type's limit, the <code>LimitExceeded</code> exception occurs.</p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html\">Scaling fleet capacity</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleetLocations</a> | <a>UpdateFleetAttributes</a> | <a>UpdateFleetCapacity</a> | <a>UpdateFleetPortSettings</a> | <a>UpdateRuntimeConfiguration</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a>PutScalingPolicy</a> | <a>DeleteFleet</a> | <a>DeleteFleetLocations</a> | <a>DeleteScalingPolicy</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"UpdateFleetPortSettings":{
"name":"UpdateFleetPortSettings",
@@ -1518,7 +1518,7 @@
{"shape":"NotFoundException"},
{"shape":"UnauthorizedException"}
],
- "documentation":"<p>Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html\"> Using Multi-Region Queues</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSessionQueue</a> | <a>DescribeGameSessionQueues</a> | <a>UpdateGameSessionQueue</a> | <a>DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html\"> Using Multi-Region Queues</a> </p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html\">CreateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html\">DescribeGameSessionQueues</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html\">UpdateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html\">DeleteGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"UpdateMatchmakingConfiguration":{
"name":"UpdateMatchmakingConfiguration",
@@ -1567,7 +1567,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
- "documentation":"<p>Updates Realtime script metadata and content.</p> <p>To update script metadata, specify the script ID and provide updated name and/or version values. </p> <p>To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the <i>Version</i> parameter to track updates to the script.</p> <p>If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon GameLift Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Updates Realtime script metadata and content.</p> <p>To update script metadata, specify the script ID and provide updated name and/or version values. </p> <p>To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the <i>Version</i> parameter to track updates to the script.</p> <p>If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon Web Services service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html\">Amazon Web Services Realtime Servers</a> </p> <p> <b>Related actions</b> </p> <p> <a>CreateScript</a> | <a>ListScripts</a> | <a>DescribeScript</a> | <a>UpdateScript</a> | <a>DeleteScript</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"ValidateMatchmakingRuleSet":{
"name":"ValidateMatchmakingRuleSet",
@@ -1695,7 +1695,7 @@
},
"SL":{
"shape":"StringList",
- "documentation":"<p>For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.</p>"
+ "documentation":"<p>For a list of up to 100 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.</p>"
},
"SDM":{
"shape":"StringDoubleMap",
@@ -1715,18 +1715,18 @@
"members":{
"AccessKeyId":{
"shape":"NonEmptyString",
- "documentation":"<p>Temporary key allowing access to the Amazon GameLift S3 account.</p>"
+ "documentation":"<p>Temporary key allowing access to the Amazon Web Services S3 account.</p>"
},
"SecretAccessKey":{
"shape":"NonEmptyString",
- "documentation":"<p>Temporary secret key allowing access to the Amazon GameLift S3 account.</p>"
+ "documentation":"<p>Temporary secret key allowing access to the Amazon Web Services S3 account.</p>"
},
"SessionToken":{
"shape":"NonEmptyString",
"documentation":"<p>Token used to associate a specific build ID with the files uploaded using these credentials.</p>"
}
},
- "documentation":"<p>Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling <a>RequestUploadCredentials</a>.</p>",
+ "documentation":"<p>Temporary access credentials used for uploading game build files to Amazon Web Services. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling <a>RequestUploadCredentials</a>.</p>",
"sensitive":true
},
"BackfillMode":{
@@ -1770,7 +1770,7 @@
},
"SizeOnDisk":{
"shape":"PositiveLong",
- "documentation":"<p>File size of the uploaded game build, expressed in bytes. When the build status is <code>INITIALIZED</code>, this value is 0.</p>"
+ "documentation":"<p>File size of the uploaded game build, expressed in bytes. When the build status is <code>INITIALIZED</code> or when using a custom Amazon S3 storage location, this value is 0.</p>"
},
"OperatingSystem":{
"shape":"OperatingSystem",
@@ -1890,7 +1890,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -1918,7 +1918,7 @@
},
"StorageLocation":{
"shape":"S3Location",
- "documentation":"<p>Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.</p>"
+ "documentation":"<p>Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon Web Services to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.</p> <p>If a <code>StorageLocation</code> is specified, the size of your file can be found in your Amazon S3 bucket. Amazon Web Services will report a <code>SizeOnDisk</code> of 0. </p>"
},
"OperatingSystem":{
"shape":"OperatingSystem",
@@ -1926,7 +1926,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -1940,7 +1940,7 @@
},
"UploadCredentials":{
"shape":"AwsCredentials",
- "documentation":"<p>This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call <a>RequestUploadCredentials</a>. </p>"
+ "documentation":"<p>This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon Web Services. Credentials have a limited life span. To refresh these credentials, call <a>RequestUploadCredentials</a>. </p>"
},
"StorageLocation":{
"shape":"S3Location",
@@ -1986,7 +1986,7 @@
},
"EC2InstanceType":{
"shape":"EC2InstanceType",
- "documentation":"<p>The GameLift-supported EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions of EC2 instance types.</p>"
+ "documentation":"<p>The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types.</p>"
},
"EC2InboundPermissions":{
"shape":"IpPermissionsList",
@@ -2006,15 +2006,15 @@
},
"MetricGroups":{
"shape":"MetricGroupList",
- "documentation":"<p>The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. </p>"
+ "documentation":"<p>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. </p>"
},
"PeerVpcAwsAccountId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings. </p>"
+ "documentation":"<p>Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings. </p>"
},
"PeerVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the AWS Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>. </p>"
+ "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>. </p>"
},
"FleetType":{
"shape":"FleetType",
@@ -2022,19 +2022,19 @@
},
"InstanceRoleArn":{
"shape":"NonEmptyString",
- "documentation":"<p>A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the AWS Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created.</p>"
+ "documentation":"<p>A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created.</p>"
},
"CertificateConfiguration":{
"shape":"CertificateConfiguration",
- "documentation":"<p>Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift. By default, the <code>CertificateConfiguration</code> is set to <code>DISABLED</code>. Learn more at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security\">Securing Client/Server Communication</a>. This property cannot be changed after the fleet is created. </p> <p>Note: This feature requires the AWS Certificate Manager (ACM) service, which is not available in all AWS regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.</p>"
+ "documentation":"<p>Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift. By default, the <code>CertificateConfiguration</code> is set to <code>DISABLED</code>. This property cannot be changed after the fleet is created. </p> <p>Note: This feature requires the Amazon Web Services Certificate Manager (ACM) service, which is not available in all Amazon Web Services regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.</p>"
},
"Locations":{
"shape":"LocationConfigurationList",
- "documentation":"<p>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as <code>us-west-2</code>. To create a fleet with instances in the home Region only, omit this parameter. </p>"
+ "documentation":"<p>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. To create a fleet with instances in the home Region only, omit this parameter. </p>"
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the fleet is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the <i>AWS General Reference</i> for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the fleet is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the <i>Amazon Web Services General Reference</i> for actual tagging limits.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2052,7 +2052,7 @@
},
"Locations":{
"shape":"LocationConfigurationList",
- "documentation":"<p>A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2102,31 +2102,31 @@
"members":{
"GameServerGroupName":{
"shape":"GameServerGroupName",
- "documentation":"<p>An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.</p>"
+ "documentation":"<p>An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.</p>"
},
"RoleArn":{
"shape":"IamRoleArn",
- "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.</p>"
+ "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.</p>"
},
"MinSize":{
"shape":"WholeNumber",
- "documentation":"<p>The minimum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.</p>"
+ "documentation":"<p>The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>"
},
"MaxSize":{
"shape":"PositiveInteger",
- "documentation":"<p>The maximum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.</p>"
+ "documentation":"<p>The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>"
},
"LaunchTemplate":{
"shape":"LaunchTemplateSpecification",
- "documentation":"<p>The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html\">Creating a Launch Template for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.</p> <note> <p>If you specify network interfaces in your launch template, you must explicitly set the property <code>AssociatePublicIpAddress</code> to \"true\". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.</p> </note>"
+ "documentation":"<p>The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html\">Creating a Launch Template for an Auto Scaling Group</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p> <note> <p>If you specify network interfaces in your launch template, you must explicitly set the property <code>AssociatePublicIpAddress</code> to \"true\". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.</p> </note>"
},
"InstanceDefinitions":{
"shape":"InstanceDefinitions",
- "documentation":"<p>The EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>"
+ "documentation":"<p>The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">EC2 Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>"
},
"AutoScalingPolicy":{
"shape":"GameServerGroupAutoScalingPolicy",
- "documentation":"<p>Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric <code>\"PercentUtilizedGameServers\"</code> to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.</p>"
+ "documentation":"<p>Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric <code>\"PercentUtilizedGameServers\"</code> to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>"
},
"BalancingStrategy":{
"shape":"BalancingStrategy",
@@ -2134,7 +2134,7 @@
},
"GameServerProtectionPolicy":{
"shape":"GameServerProtectionPolicy",
- "documentation":"<p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>"
+ "documentation":"<p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>"
},
"VpcSubnets":{
"shape":"VpcSubnets",
@@ -2142,7 +2142,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
}
},
@@ -2151,7 +2151,7 @@
"members":{
"GameServerGroup":{
"shape":"GameServerGroup",
- "documentation":"<p>The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches <code>ACTIVE</code>. </p>"
+ "documentation":"<p>The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches <code>ACTIVE</code>. </p>"
}
}
},
@@ -2177,7 +2177,7 @@
},
"GameProperties":{
"shape":"GamePropertyList",
- "documentation":"<p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the <a>GameSession</a> object with a request to start a new game session.</p>"
+ "documentation":"<p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the <a>GameSession</a> object with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>).</p>"
},
"CreatorId":{
"shape":"NonZeroAndMaxString",
@@ -2193,11 +2193,11 @@
},
"GameSessionData":{
"shape":"LargeGameSessionData",
- "documentation":"<p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <a>GameSession</a> object with a request to start a new game session.</p>"
+ "documentation":"<p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <a>GameSession</a> object with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>).</p>"
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an AWS Region code such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2234,7 +2234,7 @@
},
"FilterConfiguration":{
"shape":"FilterConfiguration",
- "documentation":"<p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>"
+ "documentation":"<p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>"
},
"PriorityConfiguration":{
"shape":"PriorityConfiguration",
@@ -2250,7 +2250,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2332,7 +2332,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2364,7 +2364,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2429,7 +2429,7 @@
},
"PlayerDataMap":{
"shape":"PlayerDataMap",
- "documentation":"<p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored. </p>"
+ "documentation":"<p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon Web Services does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored. </p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2457,15 +2457,15 @@
},
"StorageLocation":{
"shape":"S3Location",
- "documentation":"<p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>"
+ "documentation":"<p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>"
},
"ZipFile":{
"shape":"ZipBlob",
- "documentation":"<p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string \"fileb://\" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>"
+ "documentation":"<p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string \"fileb://\" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>"
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> in the <i>AWS General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.</p>"
+ "documentation":"<p>A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>"
}
}
},
@@ -2474,7 +2474,7 @@
"members":{
"Script":{
"shape":"Script",
- "documentation":"<p>The newly created script record with a unique script ID and ARN. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.</p>"
+ "documentation":"<p>The newly created script record with a unique script ID and ARN. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon Web Services service.</p>"
}
}
},
@@ -2487,11 +2487,11 @@
"members":{
"GameLiftAwsAccountId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for the AWS account that you use to manage your GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.</p>"
+ "documentation":"<p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>"
},
"PeerVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the AWS Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
+ "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2516,15 +2516,15 @@
"members":{
"FleetId":{
"shape":"FleetId",
- "documentation":"<p>A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with. </p>"
+ "documentation":"<p>A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon Web Services which GameLift VPC to peer with. </p>"
},
"PeerVpcAwsAccountId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.</p>"
+ "documentation":"<p>A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon Web Services fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>"
},
"PeerVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the AWS Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
+ "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2585,7 +2585,7 @@
},
"Locations":{
"shape":"LocationList",
- "documentation":"<p>The list of fleet locations to delete. Specify locations in the form of an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2618,7 +2618,7 @@
},
"DeleteOption":{
"shape":"GameServerGroupDeleteOption",
- "documentation":"<p>The type of delete to perform. Options include the following:</p> <ul> <li> <p> <code>SAFE_DELETE</code> – (default) Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in <code>UTILIZED</code> status.</p> </li> <li> <p> <code>FORCE_DELETE</code> – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group. </p> </li> <li> <p> <code>RETAIN</code> – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.</p> </li> </ul>"
+ "documentation":"<p>The type of delete to perform. Options include the following:</p> <ul> <li> <p> <code>SAFE_DELETE</code> – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in <code>UTILIZED</code> status.</p> </li> <li> <p> <code>FORCE_DELETE</code> – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. </p> </li> <li> <p> <code>RETAIN</code> – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</p> </li> </ul>"
}
}
},
@@ -2717,11 +2717,11 @@
"members":{
"GameLiftAwsAccountId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for the AWS account that you use to manage your GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.</p>"
+ "documentation":"<p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>"
},
"PeerVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the AWS Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
+ "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2818,11 +2818,11 @@
"members":{
"EC2InstanceType":{
"shape":"EC2InstanceType",
- "documentation":"<p>Name of an EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.</p>"
+ "documentation":"<p>Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.</p>"
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The name of a remote location to request instance limits for, in the form of an AWS Region code such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -2952,7 +2952,7 @@
},
"Locations":{
"shape":"LocationList",
- "documentation":"<p>A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
},
"Limit":{
"shape":"PositiveInteger",
@@ -3000,7 +3000,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location to retrieve capacity information for. Specify a location in the form of an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -3028,7 +3028,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location to retrieve utilization information for. Specify a location in the form of an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -3053,7 +3053,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>A remote location to check for status of port setting updates. Use the AWS Region code format, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -3079,7 +3079,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The requested fleet location, expressed as an AWS Region code, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The requested fleet location, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Represents the returned data in response to a request operation.</p>"
@@ -3162,7 +3162,7 @@
},
"InstanceIds":{
"shape":"GameServerInstanceIds",
- "documentation":"<p>The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve all instances in the game server group, leave this parameter empty. </p>"
+ "documentation":"<p>The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve all instances in the game server group, leave this parameter empty. </p>"
},
"Limit":{
"shape":"PositiveInteger",
@@ -3213,7 +3213,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>"
},
"StatusFilter":{
"shape":"NonZeroAndMaxString",
@@ -3314,7 +3314,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>"
},
"StatusFilter":{
"shape":"NonZeroAndMaxString",
@@ -3367,7 +3367,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The name of a location to retrieve instance information for, in the form of an AWS Region code such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -3547,7 +3547,7 @@
"members":{
"FleetId":{
"shape":"FleetIdOrArn",
- "documentation":"<p>A unique identifier for the fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.</p>"
+ "documentation":"<p>A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.</p>"
},
"StatusFilter":{
"shape":"ScalingStatusType",
@@ -3563,7 +3563,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p> CONTENT TODO </p>"
+ "documentation":"<p> The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. </p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -3611,7 +3611,7 @@
"members":{
"VpcPeeringAuthorizations":{
"shape":"VpcPeeringAuthorizationList",
- "documentation":"<p>A collection of objects that describe all valid VPC peering operations for the current AWS account.</p>"
+ "documentation":"<p>A collection of objects that describe all valid VPC peering operations for the current Amazon Web Services account.</p>"
}
}
},
@@ -3688,18 +3688,18 @@
"documentation":"<p>Number of instances that are no longer active but haven't yet been terminated.</p>"
}
},
- "documentation":"<p>Resource capacity settings. Fleet capacity is measured in EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.</p> <p>EC2 instance counts are part of <a>FleetCapacity</a>.</p>"
+ "documentation":"<p>Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.</p> <p>EC2 instance counts are part of <a>FleetCapacity</a>.</p>"
},
"EC2InstanceLimit":{
"type":"structure",
"members":{
"EC2InstanceType":{
"shape":"EC2InstanceType",
- "documentation":"<p>The name of an EC2 instance type. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions. </p>"
+ "documentation":"<p>The name of an Amazon EC2 instance type. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions. </p>"
},
"CurrentInstances":{
"shape":"WholeNumber",
- "documentation":"<p>The number of instances for the specified type and location that are currently being used by the AWS account. </p>"
+ "documentation":"<p>The number of instances for the specified type and location that are currently being used by the Amazon Web Services account. </p>"
},
"InstanceLimit":{
"shape":"WholeNumber",
@@ -3707,10 +3707,10 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>An AWS Region code, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>An Amazon Web Services Region code, such as <code>us-west-2</code>. </p>"
}
},
- "documentation":"<p>The GameLift service limits for an EC2 instance type and current utilization. GameLift allows AWS accounts a maximum number of instances, per instance type, per AWS Region or location, for use with GameLift. You can request an limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeEC2InstanceLimits</a> </p>"
+ "documentation":"<p>The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region or location, for use with GameLift. You can request an limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeEC2InstanceLimits</a> </p>"
},
"EC2InstanceLimitList":{
"type":"list",
@@ -3816,7 +3816,7 @@
},
"EventCode":{
"shape":"EventCode",
- "documentation":"<p>The type of event being logged. </p> <p> <b>Fleet creation events (ordered by fleet creation activity):</b> </p> <ul> <li> <p>FLEET_CREATED -- A fleet resource was successfully created with a status of <code>NEW</code>. Event messaging includes the fleet ID.</p> </li> <li> <p>FLEET_STATE_DOWNLOADING -- Fleet status changed from <code>NEW</code> to <code>DOWNLOADING</code>. The compressed build has started downloading to a fleet instance for installation.</p> </li> <li> <p> FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.</p> </li> <li> <p>FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to <code>ACTIVE</code> status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in <i>PreSignedLogUrl</i>.</p> </li> <li> <p>FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to <code>ACTIVE</code> status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in <i>PreSignedLogUrl</i>. </p> </li> <li> <p>FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to <code>ACTIVE</code> status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in <i>PreSignedLogUrl</i>. </p> </li> <li> <p>FLEET_STATE_VALIDATING -- Fleet status changed from <code>DOWNLOADING</code> to <code>VALIDATING</code>.</p> </li> <li> <p> FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.</p> </li> <li> <p>FLEET_STATE_BUILDING -- Fleet status changed from <code>VALIDATING</code> to <code>BUILDING</code>.</p> </li> <li> <p>FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.</p> </li> <li> <p>FLEET_STATE_ACTIVATING -- Fleet status changed from <code>BUILDING</code> to <code>ACTIVATING</code>. </p> </li> <li> <p> FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. Learn more at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation\"> Debug Fleet Creation Issues</a> </p> </li> <li> <p>FLEET_STATE_ACTIVE -- The fleet's status changed from <code>ACTIVATING</code> to <code>ACTIVE</code>. The fleet is now ready to host game sessions.</p> </li> </ul> <p> <b>VPC peering events:</b> </p> <ul> <li> <p>FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an GameLift fleet and a VPC in your AWS account.</p> </li> <li> <p>FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see <a>DescribeVpcPeeringConnections</a>) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your AWS account. For more information on VPC peering failures, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html\">https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html</a> </p> </li> <li> <p>FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.</p> </li> </ul> <p> <b>Spot instance events:</b> </p> <ul> <li> <p> INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.</p> </li> </ul> <p> <b>Other fleet events:</b> </p> <ul> <li> <p>FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.</p> </li> <li> <p>FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting. </p> </li> <li> <p>FLEET_DELETED -- A request to delete a fleet was initiated.</p> </li> <li> <p> GENERIC_EVENT -- An unspecified event has occurred.</p> </li> </ul>"
+ "documentation":"<p>The type of event being logged. </p> <p> <b>Fleet state transition events:</b> </p> <ul> <li> <p>FLEET_CREATED -- A fleet resource was successfully created with a status of <code>NEW</code>. Event messaging includes the fleet ID.</p> </li> <li> <p>FLEET_STATE_DOWNLOADING -- Fleet status changed from <code>NEW</code> to <code>DOWNLOADING</code>. The compressed build has started downloading to a fleet instance for installation.</p> </li> <li> <p>FLEET_STATE_VALIDATING -- Fleet status changed from <code>DOWNLOADING</code> to <code>VALIDATING</code>. GameLift has successfully downloaded the build and is now validating the build files.</p> </li> <li> <p>FLEET_STATE_BUILDING -- Fleet status changed from <code>VALIDATING</code> to <code>BUILDING</code>. GameLift has successfully verified the build files and is now running the installation scripts.</p> </li> <li> <p>FLEET_STATE_ACTIVATING -- Fleet status changed from <code>BUILDING</code> to <code>ACTIVATING</code>. GameLift is trying to launch an instance and test the connectivity between the build and the GameLift Service via the Server SDK.</p> </li> <li> <p>FLEET_STATE_ACTIVE -- The fleet's status changed from <code>ACTIVATING</code> to <code>ACTIVE</code>. The fleet is now ready to host game sessions.</p> </li> <li> <p>FLEET_STATE_ERROR -- The Fleet's status changed to <code>ERROR</code>. Describe the fleet event message for more details.</p> </li> </ul> <p> <b>Fleet creation events (ordered by fleet creation activity):</b> </p> <ul> <li> <p>FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.</p> </li> <li> <p>FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in <i>PreSignedLogUrl</i>.</p> </li> <li> <p>FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in <i>PreSignedLogUrl</i>.</p> </li> <li> <p>FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to <code>ACTIVE</code> status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in <i>PreSignedLogUrl</i>.</p> </li> <li> <p>FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.</p> </li> <li> <p>FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.</p> </li> <li> <p>FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation timed out. Try fleet creation again.</p> </li> <li> <p>FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. For more information, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation\">Debug Fleet Creation Issues</a>.</p> </li> <li> <p>FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain any instances based on the input fleet attributes. Try again at a different time or choose a different combination of fleet attributes such as fleet type, instance type, etc.</p> </li> <li> <p>FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet creation. Describe the fleet event message for more details.</p> </li> </ul> <p> <b>VPC peering events:</b> </p> <ul> <li> <p>FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an GameLift fleet and a VPC in your Amazon Web Services account.</p> </li> <li> <p>FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see <a>DescribeVpcPeeringConnections</a>) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services account. For more information on VPC peering failures, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html\">https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html</a> </p> </li> <li> <p>FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.</p> </li> </ul> <p> <b>Spot instance events:</b> </p> <ul> <li> <p> INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.</p> </li> </ul> <p> <b>Spot process events:</b> </p> <ul> <li> <p>SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not be found based on the Fleet runtime configuration. Check that the launch path is correct based on the operating system of the Fleet.</p> </li> <li> <p>SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call InitSDK() within the time expected. Check your game session log to see why InitSDK() was not called in time.</p> </li> <li> <p>SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call ProcessReady() within the time expected after calling InitSDK(). Check your game session log to see why ProcessReady() was not called in time.</p> </li> <li> <p>SERVER_PROCESS_CRASHED -- The server process exited without calling ProcessEnding(). Check your game session log to see why ProcessEnding() was not called.</p> </li> <li> <p>SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a valid health check for too long and was therefore terminated by GameLift. Check your game session log to see if the thread became stuck processing a synchronous task for too long.</p> </li> <li> <p>SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly after OnProcessTerminate() was sent within the time expected. Check your game session log to see why termination took longer than expected.</p> </li> <li> <p>SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly within the time expected after calling ProcessEnding(). Check your game session log to see why termination took longer than expected.</p> </li> </ul> <p> <b>Game session events:</b> </p> <ul> <li> <p>GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the expected time. Check your game session log to see why ActivateGameSession() took longer to complete than expected.</p> </li> </ul> <p> <b>Other fleet events:</b> </p> <ul> <li> <p>FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.</p> </li> <li> <p>FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting. </p> </li> <li> <p>FLEET_DELETED -- A request to delete a fleet was initiated.</p> </li> <li> <p> GENERIC_EVENT -- An unspecified event has occurred.</p> </li> </ul>"
},
"Message":{
"shape":"NonEmptyString",
@@ -3880,7 +3880,7 @@
"members":{
"AllowedLocations":{
"shape":"LocationList",
- "documentation":"<p> A list of locations to allow game session placement in, in the form of AWS Region codes such as <code>us-west-2</code>. </p>"
+ "documentation":"<p> A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>A list of fleet locations where a game session queue can place new game sessions. You can use a filter to temporarily turn off placements for specific locations. For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.</p> <p>Filter configurations are part of a <a>GameSessionQueue</a>.</p>"
@@ -3916,7 +3916,7 @@
},
"InstanceType":{
"shape":"EC2InstanceType",
- "documentation":"<p>The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
+ "documentation":"<p>The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions.</p>"
},
"Description":{
"shape":"NonZeroAndMaxString",
@@ -3988,7 +3988,7 @@
},
"InstanceRoleArn":{
"shape":"NonEmptyString",
- "documentation":"<p>A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the AWS Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>.</p>"
+ "documentation":"<p>A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>.</p>"
},
"CertificateConfiguration":{
"shape":"CertificateConfiguration",
@@ -4014,7 +4014,7 @@
},
"InstanceType":{
"shape":"EC2InstanceType",
- "documentation":"<p>The EC2 instance type that is used for all instances in a fleet. The instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
+ "documentation":"<p>The Amazon EC2 instance type that is used for all instances in a fleet. The instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions.</p>"
},
"InstanceCounts":{
"shape":"EC2InstanceCounts",
@@ -4022,10 +4022,10 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location for the instance count information, expressed as an AWS Region code, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. </p>"
}
},
- "documentation":"<p>Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. </p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetCapacity</a> | <a>DescribeFleetLocationCapacity</a> | <a>UpdateFleetCapacity</a> </p>"
+ "documentation":"<p>Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. </p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html\">DescribeFleetCapacity</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html\">DescribeFleetLocationCapacity</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html\">UpdateFleetCapacity</a> </p>"
},
"FleetCapacityExceededException":{
"type":"structure",
@@ -4107,7 +4107,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location for the fleet utilization information, expressed as an AWS Region code, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetUtilization</a> | <a>DescribeFleetLocationUtilization</a> </p>"
@@ -4169,7 +4169,7 @@
},
"GameServerId":{
"shape":"GameServerId",
- "documentation":"<p>A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.</p>"
+ "documentation":"<p>A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an Amazon Web Services account.</p>"
},
"InstanceId":{
"shape":"GameServerInstanceId",
@@ -4227,7 +4227,7 @@
"members":{
"GameServerGroupName":{
"shape":"GameServerGroupName",
- "documentation":"<p>A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.</p>"
+ "documentation":"<p>A developer-defined identifier for the game server group. The name is unique for each Region in each Amazon Web Services account.</p>"
},
"GameServerGroupArn":{
"shape":"GameServerGroupArn",
@@ -4235,11 +4235,11 @@
},
"RoleArn":{
"shape":"IamRoleArn",
- "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.</p>"
+ "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.</p>"
},
"InstanceDefinitions":{
"shape":"InstanceDefinitions",
- "documentation":"<p>The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. </p>"
+ "documentation":"<p>The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group. </p>"
},
"BalancingStrategy":{
"shape":"BalancingStrategy",
@@ -4247,15 +4247,15 @@
},
"GameServerProtectionPolicy":{
"shape":"GameServerProtectionPolicy",
- "documentation":"<p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. </p>"
+ "documentation":"<p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. </p>"
},
"AutoScalingGroupArn":{
"shape":"AutoScalingGroupArn",
- "documentation":"<p>A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.</p>"
+ "documentation":"<p>A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this game server group.</p>"
},
"Status":{
"shape":"GameServerGroupStatus",
- "documentation":"<p>The current status of the game server group. Possible statuses include:</p> <ul> <li> <p> <code>NEW</code> - GameLift FleetIQ has validated the <code>CreateGameServerGroup()</code> request. </p> </li> <li> <p> <code>ACTIVATING</code> - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account. </p> </li> <li> <p> <code>ACTIVE</code> - The game server group has been successfully created. </p> </li> <li> <p> <code>DELETE_SCHEDULED</code> - A request to delete the game server group has been received. </p> </li> <li> <p> <code>DELETING</code> - GameLift FleetIQ has received a valid <code>DeleteGameServerGroup()</code> request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group. </p> </li> <li> <p> <code>DELETED</code> - The game server group has been successfully deleted. </p> </li> <li> <p> <code>ERROR</code> - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.</p> </li> </ul>"
+ "documentation":"<p>The current status of the game server group. Possible statuses include:</p> <ul> <li> <p> <code>NEW</code> - GameLift FleetIQ has validated the <code>CreateGameServerGroup()</code> request. </p> </li> <li> <p> <code>ACTIVATING</code> - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account. </p> </li> <li> <p> <code>ACTIVE</code> - The game server group has been successfully created. </p> </li> <li> <p> <code>DELETE_SCHEDULED</code> - A request to delete the game server group has been received. </p> </li> <li> <p> <code>DELETING</code> - GameLift FleetIQ has received a valid <code>DeleteGameServerGroup()</code> request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group. </p> </li> <li> <p> <code>DELETED</code> - The game server group has been successfully deleted. </p> </li> <li> <p> <code>ERROR</code> - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.</p> </li> </ul>"
},
"StatusReason":{
"shape":"NonZeroAndMaxString",
@@ -4274,7 +4274,7 @@
"documentation":"<p>A timestamp that indicates when this game server group was last updated.</p>"
}
},
- "documentation":"<p> <b>This data type is used with the GameLift FleetIQ and game server groups.</b> </p> <p>Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding EC2 Auto Scaling group. </p> <p>A game server group is created by a successful call to <code>CreateGameServerGroup</code> and deleted by calling <code>DeleteGameServerGroup</code>. Game server group activity can be temporarily suspended and resumed by calling <code>SuspendGameServerGroup</code> and <code>ResumeGameServerGroup</code>, respectively. </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameServerGroup</a> | <a>ListGameServerGroups</a> | <a>DescribeGameServerGroup</a> | <a>UpdateGameServerGroup</a> | <a>DeleteGameServerGroup</a> | <a>ResumeGameServerGroup</a> | <a>SuspendGameServerGroup</a> | <a>DescribeGameServerInstances</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html\">All APIs by task</a> </p>"
+ "documentation":"<p> <b>This data type is used with the GameLift FleetIQ and game server groups.</b> </p> <p>Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon EC2 Auto Scaling group. </p> <p>A game server group is created by a successful call to <code>CreateGameServerGroup</code> and deleted by calling <code>DeleteGameServerGroup</code>. Game server group activity can be temporarily suspended and resumed by calling <code>SuspendGameServerGroup</code> and <code>ResumeGameServerGroup</code>, respectively. </p> <p> <b>Related actions</b> </p> <p> <a>CreateGameServerGroup</a> | <a>ListGameServerGroups</a> | <a>DescribeGameServerGroup</a> | <a>UpdateGameServerGroup</a> | <a>DeleteGameServerGroup</a> | <a>ResumeGameServerGroup</a> | <a>SuspendGameServerGroup</a> | <a>DescribeGameServerInstances</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html\">All APIs by task</a> </p>"
},
"GameServerGroupAction":{
"type":"string",
@@ -4451,7 +4451,7 @@
"members":{
"GameServerGroupName":{
"shape":"GameServerGroupName",
- "documentation":"<p>A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each AWS account.</p>"
+ "documentation":"<p>A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.</p>"
},
"GameServerGroupArn":{
"shape":"GameServerGroupArn",
@@ -4555,7 +4555,7 @@
},
"GameProperties":{
"shape":"GamePropertyList",
- "documentation":"<p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the <a>GameSession</a> object with a request to start a new game session. You can search for active game sessions based on this custom data with <a>SearchGameSessions</a>.</p>"
+ "documentation":"<p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the <a>GameSession</a> object with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>). You can search for active game sessions based on this custom data with <a>SearchGameSessions</a>.</p>"
},
"IpAddress":{
"shape":"IpAddress",
@@ -4579,15 +4579,15 @@
},
"GameSessionData":{
"shape":"LargeGameSessionData",
- "documentation":"<p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <a>GameSession</a> object with a request to start a new game session.</p>"
+ "documentation":"<p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <a>GameSession</a> object with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>).</p>"
},
"MatchmakerData":{
"shape":"MatchmakerData",
- "documentation":"<p>Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data\">Match Data</a>. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see <a>StartMatchBackfill</a>). </p>"
+ "documentation":"<p>Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data\">Match Data</a>. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html\">StartMatchBackfill</a>). </p>"
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Properties describing a game session.</p> <p>A game session in ACTIVE status can host players. When a game session ends, its status is set to <code>TERMINATED</code>. </p> <p>Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.</p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSession</a> | <a>DescribeGameSessions</a> | <a>DescribeGameSessionDetails</a> | <a>SearchGameSessions</a> | <a>UpdateGameSession</a> | <a>GetGameSessionLogUrl</a> | <a>StartGameSessionPlacement</a> | <a>DescribeGameSessionPlacement</a> | <a>StopGameSessionPlacement</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
@@ -4699,7 +4699,7 @@
},
"PlayerLatencies":{
"shape":"PlayerLatencyList",
- "documentation":"<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.</p>"
+ "documentation":"<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions.</p>"
},
"StartTime":{
"shape":"Timestamp",
@@ -4771,7 +4771,7 @@
},
"FilterConfiguration":{
"shape":"FilterConfiguration",
- "documentation":"<p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>"
+ "documentation":"<p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>"
},
"PriorityConfiguration":{
"shape":"PriorityConfiguration",
@@ -4786,7 +4786,7 @@
"documentation":"<p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html\"> Setting up notifications for game session placement</a>.</p>"
}
},
- "documentation":"<p>Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.</p> <p> <b>Related actions</b> </p> <p> <a>CreateGameSessionQueue</a> | <a>DescribeGameSessionQueues</a> | <a>UpdateGameSessionQueue</a> </p>"
+ "documentation":"<p>Configuration for a game session placement mechanism that processes requests for new game sessions. A queue can be used on its own or as part of a matchmaking solution.</p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html\">CreateGameSessionQueue</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html\">DescribeGameSessionQueues</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html\">UpdateGameSessionQueue</a> </p>"
},
"GameSessionQueueArn":{
"type":"string",
@@ -4940,7 +4940,7 @@
},
"Type":{
"shape":"EC2InstanceType",
- "documentation":"<p>EC2 instance type that defines the computing resources of this instance. </p>"
+ "documentation":"<p>Amazon EC2 instance type that defines the computing resources of this instance. </p>"
},
"Status":{
"shape":"InstanceStatus",
@@ -4952,7 +4952,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location of the instance, expressed as an AWS Region code, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The fleet location of the instance, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. </p>"
}
},
"documentation":"<p>Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In GameLift, a fleet can contain zero or more instances.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeInstances</a> </p>"
@@ -5004,11 +5004,11 @@
"members":{
"InstanceType":{
"shape":"GameServerGroupInstanceType",
- "documentation":"<p>An EC2 instance type designation.</p>"
+ "documentation":"<p>An Amazon EC2 instance type designation.</p>"
},
"WeightedCapacity":{
"shape":"WeightedCapacity",
- "documentation":"<p>Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\">Instance Weighting</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. Default value is \"1\".</p>"
+ "documentation":"<p>Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\">Instance Weighting</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>. Default value is \"1\".</p>"
}
},
"documentation":"<p> <b>This data type is used with the GameLift FleetIQ and game server groups.</b> </p> <p>An allowed instance type for a <a>GameServerGroup</a>. All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.</p>"
@@ -5086,11 +5086,11 @@
"members":{
"FromPort":{
"shape":"PortNumber",
- "documentation":"<p>A starting value for a range of allowed port numbers.</p>"
+ "documentation":"<p>A starting value for a range of allowed port numbers.</p> <p>For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only port 443, 1026-60000 are valid.</p>"
},
"ToPort":{
"shape":"PortNumber",
- "documentation":"<p>An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than <code>FromPort</code>.</p>"
+ "documentation":"<p>An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than <code>FromPort</code>.</p> <p>For fleets using Linux builds, only port 22, 443, 1026-60000 are valid. For fleets using Windows builds, only port 443, 1026-60000 are valid.</p>"
},
"IpRange":{
"shape":"NonBlankString",
@@ -5154,18 +5154,18 @@
"members":{
"LaunchTemplateId":{
"shape":"LaunchTemplateId",
- "documentation":"<p>A unique identifier for an existing EC2 launch template.</p>"
+ "documentation":"<p>A unique identifier for an existing Amazon EC2 launch template.</p>"
},
"LaunchTemplateName":{
"shape":"LaunchTemplateName",
- "documentation":"<p>A readable identifier for an existing EC2 launch template. </p>"
+ "documentation":"<p>A readable identifier for an existing Amazon EC2 launch template. </p>"
},
"Version":{
"shape":"LaunchTemplateVersion",
- "documentation":"<p>The version of the EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created.</p>"
+ "documentation":"<p>The version of the Amazon EC2 launch template to use. If no version is specified, the default version will be used. With Amazon Elastic Compute Cloud, you can specify a default version for a launch template. If none is set, the default is the first version created.</p>"
}
},
- "documentation":"<p> <b>This data type is used with the GameLift FleetIQ and game server groups.</b> </p> <p>An EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with <a>CreateGameServerGroup</a>. </p>"
+ "documentation":"<p> <b>This data type is used with the GameLift FleetIQ and game server groups.</b> </p> <p>An Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with <a>CreateGameServerGroup</a>. </p>"
},
"LaunchTemplateVersion":{
"type":"string",
@@ -5418,10 +5418,10 @@
"members":{
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>An AWS Region code, such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>An Amazon Web Services Region code, such as <code>us-west-2</code>. </p>"
}
},
- "documentation":"<p>A remote location where a multi-location fleet can deploy EC2 instances for game hosting. </p> <p> <b>Related actions</b> </p> <p> <a>CreateFleet</a> </p>"
+ "documentation":"<p>A remote location where a multi-location fleet can deploy EC2 instances for game hosting. </p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html\">CreateFleet</a> </p>"
},
"LocationConfigurationList":{
"type":"list",
@@ -5440,7 +5440,7 @@
"members":{
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location, expressed as an AWS Region code such as <code>us-west-2</code>. </p>"
+ "documentation":"<p>The fleet location, expressed as an Amazon Web Services Region code such as <code>us-west-2</code>. </p>"
},
"Status":{
"shape":"FleetStatus",
@@ -5822,7 +5822,7 @@
},
"LatencyInMs":{
"shape":"LatencyMap",
- "documentation":"<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported. </p> <p>If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable. </p>"
+ "documentation":"<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported. </p> <p>If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable. </p>"
}
},
"documentation":"<p>Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.</p>"
@@ -5937,7 +5937,7 @@
},
"Port":{
"shape":"PortNumber",
- "documentation":"<p>Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.</p>"
+ "documentation":"<p>Port number for the game session. To connect to a Amazon Web Services server process, an app needs both the IP address and port number.</p>"
},
"PlayerData":{
"shape":"PlayerData",
@@ -5999,7 +5999,7 @@
},
"LocationOrder":{
"shape":"LocationList",
- "documentation":"<p>The prioritization order to use for fleet locations, when the <code>PriorityOrder</code> property includes <code>LOCATION</code>. Locations are identified by AWS Region codes such as <code>us-west-2</code>. Each location can only be listed once. </p>"
+ "documentation":"<p>The prioritization order to use for fleet locations, when the <code>PriorityOrder</code> property includes <code>LOCATION</code>. Locations are identified by Amazon Web Services Region codes such as <code>us-west-2</code>. Each location can only be listed once. </p>"
}
},
"documentation":"<p>Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers. When defined, this configuration replaces the default FleetIQ prioritization process, which is as follows:</p> <ul> <li> <p>If player latency data is included in a game session request, destinations and locations are prioritized first based on lowest average latency (1), then on lowest hosting cost (2), then on destination list order (3), and finally on location (alphabetical) (4). This approach ensures that the queue's top priority is to place game sessions where average player latency is lowest, and--if latency is the same--where the hosting cost is less, etc.</p> </li> <li> <p>If player latency data is not included, destinations and locations are prioritized first on destination list order (1), and then on location (alphabetical) (2). This approach ensures that the queue's top priority is to place game sessions on the first destination fleet listed. If that fleet has multiple locations, the game session is placed on the first location (when listed alphabetically).</p> </li> </ul> <p>Changing the priority order will affect how game sessions are placed.</p> <p>Priority configurations are part of a <a>GameSessionQueue</a>.</p>"
@@ -6064,7 +6064,7 @@
},
"MetricName":{
"shape":"MetricName",
- "documentation":"<p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html\">Monitor Amazon GameLift with Amazon CloudWatch</a>. </p> <ul> <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li> <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li> <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li> <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li> <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li> <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li> <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li> <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li> <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li> <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li> <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li> </ul>"
+ "documentation":"<p>Name of the Amazon Web Services-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html\">Monitor Amazon Web Services with Amazon CloudWatch</a>. </p> <ul> <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li> <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li> <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li> <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li> <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li> <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li> <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li> <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li> <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li> <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li> <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li> </ul>"
},
"PolicyType":{
"shape":"PolicyType",
@@ -6117,7 +6117,7 @@
},
"GameServerId":{
"shape":"GameServerId",
- "documentation":"<p>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.</p>"
+ "documentation":"<p>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.</p>"
},
"InstanceId":{
"shape":"GameServerInstanceId",
@@ -6158,7 +6158,7 @@
"members":{
"UploadCredentials":{
"shape":"AwsCredentials",
- "documentation":"<p>AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.</p>"
+ "documentation":"<p>Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.</p>"
},
"StorageLocation":{
"shape":"S3Location",
@@ -6298,14 +6298,14 @@
},
"RoleArn":{
"shape":"NonEmptyString",
- "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon GameLift to access the S3 bucket.</p>"
+ "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon Web Services to access the S3 bucket.</p>"
},
"ObjectVersion":{
"shape":"NonEmptyString",
- "documentation":"<p>The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. </p>"
+ "documentation":"<p>The version of the file, if object versioning is turned on for the bucket. Amazon Web Services uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved. </p>"
}
},
- "documentation":"<p>The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This location is specified in <a>CreateBuild</a>, <a>CreateScript</a>, and <a>UpdateScript</a> requests. </p>"
+ "documentation":"<p>The location in Amazon S3 where build or script files are stored for access by Amazon Web Services. This location is specified in <a>CreateBuild</a>, <a>CreateScript</a>, and <a>UpdateScript</a> requests. </p>"
},
"ScalingAdjustmentType":{
"type":"string",
@@ -6356,7 +6356,7 @@
},
"MetricName":{
"shape":"MetricName",
- "documentation":"<p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html\">Monitor Amazon GameLift with Amazon CloudWatch</a>. </p> <ul> <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li> <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li> <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li> <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li> <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li> <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li> <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li> <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li> <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li> <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li> <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li> </ul>"
+ "documentation":"<p>Name of the Amazon Web Services-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html\">Monitor Amazon Web Services with Amazon CloudWatch</a>. </p> <ul> <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li> <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li> <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li> <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li> <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li> <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li> <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li> <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li> <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li> <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li> <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li> </ul>"
},
"PolicyType":{
"shape":"PolicyType",
@@ -6372,7 +6372,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p> </p>"
+ "documentation":"<p> The fleet location. </p>"
}
},
"documentation":"<p>Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.</p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetCapacity</a> | <a>UpdateFleetCapacity</a> | <a>DescribeEC2InstanceLimits</a> | <a>PutScalingPolicy</a> | <a>DescribeScalingPolicies</a> | <a>DeleteScalingPolicy</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
@@ -6453,7 +6453,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as <code>us-west-2</code>. </p> <p> </p>"
+ "documentation":"<p>A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p> <p> </p>"
},
"FilterExpression":{
"shape":"NonZeroAndMaxString",
@@ -6546,7 +6546,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location to restart fleet actions for. Specify a location in the form of an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -6595,7 +6595,7 @@
},
"PlayerLatencies":{
"shape":"PlayerLatencyList",
- "documentation":"<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. </p>"
+ "documentation":"<p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. </p>"
},
"DesiredPlayerSessions":{
"shape":"DesiredPlayerSessionList",
@@ -6627,7 +6627,7 @@
"members":{
"TicketId":{
"shape":"MatchmakingIdStringModel",
- "documentation":"<p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.</p>"
+ "documentation":"<p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon Web Services will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.</p>"
},
"ConfigurationName":{
"shape":"MatchmakingConfigurationName",
@@ -6639,7 +6639,7 @@
},
"Players":{
"shape":"PlayerList",
- "documentation":"<p>Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.</p> <ul> <li> <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the <a>GameSession</a> object, <code>MatchmakerData</code> property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data\"> Match Data</a>. </p> </li> <li> <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.</p> </li> </ul>"
+ "documentation":"<p>Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.</p> <ul> <li> <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the <a>GameSession</a> object, <code>MatchmakerData</code> property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data\"> Match Data</a>. </p> <p>The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.</p> </li> <li> <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -6663,7 +6663,7 @@
"members":{
"TicketId":{
"shape":"MatchmakingIdStringModel",
- "documentation":"<p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.</p>"
+ "documentation":"<p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon Web Services will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.</p>"
},
"ConfigurationName":{
"shape":"MatchmakingConfigurationName",
@@ -6703,7 +6703,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The fleet location to stop fleet actions for. Specify a location in the form of an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -6804,14 +6804,14 @@
"members":{
"Key":{
"shape":"TagKey",
- "documentation":"<p> The key for a developer-defined key:value pair for tagging an AWS resource. </p>"
+ "documentation":"<p> The key for a developer-defined key:value pair for tagging an Amazon Web Services resource. </p>"
},
"Value":{
"shape":"TagValue",
- "documentation":"<p> The value for a developer-defined key:value pair for tagging an AWS resource. </p>"
+ "documentation":"<p> The value for a developer-defined key:value pair for tagging an Amazon Web Services resource. </p>"
}
},
- "documentation":"<p> A label that can be assigned to a GameLift resource. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> in the <i>AWS General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> AWS Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p> A label that can be assigned to a GameLift resource. </p> <p> <b>Learn more</b> </p> <p> <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p> <p> <a href=\"http://aws.amazon.com/answers/account-management/aws-tagging-strategies/\"> Amazon Web Services Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a>TagResource</a> | <a>UntagResource</a> | <a>ListTagsForResource</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"TagKey":{
"type":"string",
@@ -6843,7 +6843,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging AWS Resources</a> for actual tagging limits.</p>"
+ "documentation":"<p>A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> for actual tagging limits.</p>"
}
}
},
@@ -6874,7 +6874,7 @@
"documentation":"<p>Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).</p>"
}
},
- "documentation":"<p>Settings for a target-based scaling policy (see <a>ScalingPolicy</a>. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. </p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetCapacity</a> | <a>UpdateFleetCapacity</a> | <a>DescribeEC2InstanceLimits</a> | <a>PutScalingPolicy</a> | <a>DescribeScalingPolicies</a> | <a>DeleteScalingPolicy</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Settings for a target-based scaling policy (see <a>ScalingPolicy</a>. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon Web Services to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. </p> <p> <b>Related actions</b> </p> <p> <a>DescribeFleetCapacity</a> | <a>UpdateFleetCapacity</a> | <a>DescribeEC2InstanceLimits</a> | <a>PutScalingPolicy</a> | <a>DescribeScalingPolicies</a> | <a>DeleteScalingPolicy</a> | <a>StopFleetActions</a> | <a>StartFleetActions</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"TargetTrackingConfiguration":{
"type":"structure",
@@ -6925,7 +6925,7 @@
},
"TagKeys":{
"shape":"TagKeyList",
- "documentation":"<p>A list of one or more tag keys to remove from the specified GameLift resource. An AWS resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove. </p>"
+ "documentation":"<p>A list of one or more tag keys to remove from the specified GameLift resource. An Amazon Web Services resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove. </p>"
}
}
},
@@ -7047,7 +7047,7 @@
},
"DesiredInstances":{
"shape":"WholeNumber",
- "documentation":"<p>The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.</p>"
+ "documentation":"<p>The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.</p>"
},
"MinSize":{
"shape":"WholeNumber",
@@ -7059,7 +7059,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The name of a remote location to update fleet capacity settings for, in the form of an AWS Region code such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the input for a request operation.</p>"
@@ -7077,7 +7077,7 @@
},
"Location":{
"shape":"LocationStringModel",
- "documentation":"<p>The remote location being updated, expressed as an AWS Region code, such as <code>us-west-2</code>.</p>"
+ "documentation":"<p>The remote location being updated, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>Represents the returned data in response to a request operation.</p>"
@@ -7121,15 +7121,15 @@
},
"RoleArn":{
"shape":"IamRoleArn",
- "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.</p>"
+ "documentation":"<p>The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.</p>"
},
"InstanceDefinitions":{
"shape":"InstanceDefinitions",
- "documentation":"<p>An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>"
+ "documentation":"<p>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value \"1\". For more information about capacity weighting, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>"
},
"GameServerProtectionPolicy":{
"shape":"GameServerProtectionPolicy",
- "documentation":"<p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>"
+ "documentation":"<p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>"
},
"BalancingStrategy":{
"shape":"BalancingStrategy",
@@ -7243,7 +7243,7 @@
},
"FilterConfiguration":{
"shape":"FilterConfiguration",
- "documentation":"<p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>"
+ "documentation":"<p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>"
},
"PriorityConfiguration":{
"shape":"PriorityConfiguration",
@@ -7389,11 +7389,11 @@
},
"StorageLocation":{
"shape":"S3Location",
- "documentation":"<p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>"
+ "documentation":"<p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>"
},
"ZipFile":{
"shape":"ZipBlob",
- "documentation":"<p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string \"fileb://\" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>"
+ "documentation":"<p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string \"fileb://\" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>"
}
}
},
@@ -7402,7 +7402,7 @@
"members":{
"Script":{
"shape":"Script",
- "documentation":"<p>The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.</p>"
+ "documentation":"<p>The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon Web Services service.</p>"
}
}
},
@@ -7432,7 +7432,7 @@
"members":{
"GameLiftAwsAccountId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for the AWS account that you use to manage your GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.</p>"
+ "documentation":"<p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>"
},
"PeerVpcAwsAccountId":{
"shape":"NonZeroAndMaxString",
@@ -7440,7 +7440,7 @@
},
"PeerVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the AWS Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
+ "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
},
"CreationTime":{
"shape":"Timestamp",
@@ -7451,7 +7451,7 @@
"documentation":"<p>Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example <code>\"1469498468.057\"</code>).</p>"
}
},
- "documentation":"<p>Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.</p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Represents an authorization for a VPC peering connection between the VPC for an Amazon Web Services fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.</p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"VpcPeeringAuthorizationList":{
"type":"list",
@@ -7462,7 +7462,7 @@
"members":{
"FleetId":{
"shape":"FleetId",
- "documentation":"<p>A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.</p>"
+ "documentation":"<p>A unique identifier for the fleet. This ID determines the ID of the Amazon Web Services VPC for your fleet.</p>"
},
"FleetArn":{
"shape":"FleetArn",
@@ -7482,14 +7482,14 @@
},
"PeerVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the AWS Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
+ "documentation":"<p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href=\"https://console.aws.amazon.com/vpc/\">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html\">VPC Peering with GameLift Fleets</a>.</p>"
},
"GameLiftVpcId":{
"shape":"NonZeroAndMaxString",
- "documentation":"<p>A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account. </p>"
+ "documentation":"<p>A unique identifier for the VPC that contains the Amazon Web Services fleet for this connection. This VPC is managed by Amazon Web Services and does not appear in your Amazon Web Services account. </p>"
}
},
- "documentation":"<p>Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.</p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
+ "documentation":"<p>Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the VPC for your Amazon Web Services fleets. This record may be for an active peering connection or a pending connection that has not yet been established.</p> <p> <b>Related actions</b> </p> <p> <a>CreateVpcPeeringAuthorization</a> | <a>DescribeVpcPeeringAuthorizations</a> | <a>DeleteVpcPeeringAuthorization</a> | <a>CreateVpcPeeringConnection</a> | <a>DescribeVpcPeeringConnections</a> | <a>DeleteVpcPeeringConnection</a> | <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>"
},
"VpcPeeringConnectionList":{
"type":"list",
@@ -7536,5 +7536,5 @@
"max":5000000
}
},
- "documentation":"<fullname>Amazon GameLift Service</fullname> <p>GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on AWS global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand. </p> <p> <b>About GameLift solutions</b> </p> <p>Get more information on these GameLift solutions in the <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/\">GameLift Developer Guide</a>.</p> <ul> <li> <p>GameLift managed hosting -- GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.</p> </li> <li> <p>Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core GameLift infrastructure already built in. Then use the full range of GameLift managed hosting features, including FlexMatch, for your game.</p> </li> <li> <p>GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.</p> </li> <li> <p>GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.</p> </li> </ul> <p> <b>About this API Reference</b> </p> <p>This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the AWS CLI reference. Useful links:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html\">GameLift API operations listed by tasks</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html\"> GameLift tools and resources</a> </p> </li> </ul>"
+ "documentation":"<fullname>GameLift Service</fullname> <p>Amazon Web Services provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand. </p> <p> <b>About GameLift solutions</b> </p> <p>Get more information on these GameLift solutions in the <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/\">GameLift Developer Guide</a>.</p> <ul> <li> <p>GameLift managed hosting -- GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.</p> </li> <li> <p>Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core GameLift infrastructure already built in. Then use the full range of GameLift managed hosting features, including FlexMatch, for your game.</p> </li> <li> <p>GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.</p> </li> <li> <p>GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.</p> </li> </ul> <p> <b>About this API Reference</b> </p> <p>This reference guide describes the low-level service API for Amazon Web Services. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html\">GameLift API operations listed by tasks</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html\"> GameLift tools and resources</a> </p> </li> </ul>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/paginators-1.json b/contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/paginators-1.json
new file mode 100644
index 0000000000..755ad2baa0
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/paginators-1.json
@@ -0,0 +1,46 @@
+{
+ "pagination": {
+ "ListExtensionVersions": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "ExtensionVersions"
+ },
+ "ListExtensions": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Extensions"
+ },
+ "ListGames": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Games"
+ },
+ "ListGeneratedCodeJobs": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "GeneratedCodeJobs"
+ },
+ "ListSnapshots": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Snapshots"
+ },
+ "ListStageDeployments": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "StageDeployments"
+ },
+ "ListStages": {
+ "input_token": "NextToken",
+ "output_token": "NextToken",
+ "limit_key": "MaxResults",
+ "result_key": "Stages"
+ }
+ }
+}
diff --git a/contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/service-2.json b/contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/service-2.json
new file mode 100644
index 0000000000..9fce59f589
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/gamesparks/2021-08-17/service-2.json
@@ -0,0 +1,2509 @@
+{
+ "version":"2.0",
+ "metadata":{
+ "apiVersion":"2021-08-17",
+ "endpointPrefix":"gamesparks",
+ "jsonVersion":"1.1",
+ "protocol":"rest-json",
+ "serviceFullName":"GameSparks",
+ "serviceId":"GameSparks",
+ "signatureVersion":"v4",
+ "signingName":"gamesparks",
+ "uid":"gamesparks-2021-08-17"
+ },
+ "operations":{
+ "CreateGame":{
+ "name":"CreateGame",
+ "http":{
+ "method":"POST",
+ "requestUri":"/game",
+ "responseCode":200
+ },
+ "input":{"shape":"CreateGameRequest"},
+ "output":{"shape":"CreateGameResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ServiceQuotaExceededException"}
+ ],
+ "documentation":"<p> Creates a new game with an empty configuration. After creating your game, you can update the configuration using <code>UpdateGameConfiguration</code> or <code>ImportGameConfiguration</code>. </p>",
+ "idempotent":true
+ },
+ "CreateSnapshot":{
+ "name":"CreateSnapshot",
+ "http":{
+ "method":"POST",
+ "requestUri":"/game/{GameName}/snapshot",
+ "responseCode":200
+ },
+ "input":{"shape":"CreateSnapshotRequest"},
+ "output":{"shape":"CreateSnapshotResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Creates a snapshot of the game configuration.</p>"
+ },
+ "CreateStage":{
+ "name":"CreateStage",
+ "http":{
+ "method":"POST",
+ "requestUri":"/game/{GameName}/stage",
+ "responseCode":200
+ },
+ "input":{"shape":"CreateStageRequest"},
+ "output":{"shape":"CreateStageResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Creates a new stage for stage-by-stage game development and deployment.</p>",
+ "idempotent":true
+ },
+ "DeleteGame":{
+ "name":"DeleteGame",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/game/{GameName}",
+ "responseCode":200
+ },
+ "input":{"shape":"DeleteGameRequest"},
+ "output":{"shape":"DeleteGameResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Deletes a game.</p>",
+ "idempotent":true
+ },
+ "DeleteStage":{
+ "name":"DeleteStage",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/game/{GameName}/stage/{StageName}",
+ "responseCode":200
+ },
+ "input":{"shape":"DeleteStageRequest"},
+ "output":{"shape":"DeleteStageResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Deletes a stage from a game, along with the associated game runtime.</p>",
+ "idempotent":true
+ },
+ "DisconnectPlayer":{
+ "name":"DisconnectPlayer",
+ "http":{
+ "method":"POST",
+ "requestUri":"/runtime/game/{GameName}/stage/{StageName}/player/{PlayerId}/disconnect",
+ "responseCode":200
+ },
+ "input":{"shape":"DisconnectPlayerRequest"},
+ "output":{"shape":"DisconnectPlayerResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Disconnects a player from the game runtime.</p> <p> If a player has multiple connections, this operation attempts to close all of them. </p>",
+ "idempotent":true
+ },
+ "ExportSnapshot":{
+ "name":"ExportSnapshot",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/snapshot/{SnapshotId}/export",
+ "responseCode":200
+ },
+ "input":{"shape":"ExportSnapshotRequest"},
+ "output":{"shape":"ExportSnapshotResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Exports a game configuration snapshot.</p>"
+ },
+ "GetExtension":{
+ "name":"GetExtension",
+ "http":{
+ "method":"GET",
+ "requestUri":"/extension/{Namespace}/{Name}",
+ "responseCode":200
+ },
+ "input":{"shape":"GetExtensionRequest"},
+ "output":{"shape":"GetExtensionResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets details about a specified extension.</p>"
+ },
+ "GetExtensionVersion":{
+ "name":"GetExtensionVersion",
+ "http":{
+ "method":"GET",
+ "requestUri":"/extension/{Namespace}/{Name}/version/{ExtensionVersion}",
+ "responseCode":200
+ },
+ "input":{"shape":"GetExtensionVersionRequest"},
+ "output":{"shape":"GetExtensionVersionResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets details about a specified extension version.</p>"
+ },
+ "GetGame":{
+ "name":"GetGame",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}",
+ "responseCode":200
+ },
+ "input":{"shape":"GetGameRequest"},
+ "output":{"shape":"GetGameResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets details about a game.</p>"
+ },
+ "GetGameConfiguration":{
+ "name":"GetGameConfiguration",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/configuration",
+ "responseCode":200
+ },
+ "input":{"shape":"GetGameConfigurationRequest"},
+ "output":{"shape":"GetGameConfigurationResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets the configuration of the game.</p>"
+ },
+ "GetGeneratedCodeJob":{
+ "name":"GetGeneratedCodeJob",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/snapshot/{SnapshotId}/generated-sdk-code-job/{JobId}",
+ "responseCode":200
+ },
+ "input":{"shape":"GetGeneratedCodeJobRequest"},
+ "output":{"shape":"GetGeneratedCodeJobResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets details about a job that is generating code for a snapshot.</p>"
+ },
+ "GetPlayerConnectionStatus":{
+ "name":"GetPlayerConnectionStatus",
+ "http":{
+ "method":"GET",
+ "requestUri":"/runtime/game/{GameName}/stage/{StageName}/player/{PlayerId}/connection",
+ "responseCode":200
+ },
+ "input":{"shape":"GetPlayerConnectionStatusRequest"},
+ "output":{"shape":"GetPlayerConnectionStatusResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets the status of a player's connection to the game runtime.</p> <p> It's possible for a single player to have multiple connections to the game runtime. If a player is not connected, this operation returns an empty list. </p>"
+ },
+ "GetSnapshot":{
+ "name":"GetSnapshot",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/snapshot/{SnapshotId}",
+ "responseCode":200
+ },
+ "input":{"shape":"GetSnapshotRequest"},
+ "output":{"shape":"GetSnapshotResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a copy of the game configuration in a snapshot.</p>"
+ },
+ "GetStage":{
+ "name":"GetStage",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/stage/{StageName}",
+ "responseCode":200
+ },
+ "input":{"shape":"GetStageRequest"},
+ "output":{"shape":"GetStageResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets information about a stage.</p>"
+ },
+ "GetStageDeployment":{
+ "name":"GetStageDeployment",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/stage/{StageName}/deployment",
+ "responseCode":200
+ },
+ "input":{"shape":"GetStageDeploymentRequest"},
+ "output":{"shape":"GetStageDeploymentResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets information about a stage deployment.</p>"
+ },
+ "ImportGameConfiguration":{
+ "name":"ImportGameConfiguration",
+ "http":{
+ "method":"PUT",
+ "requestUri":"/game/{GameName}/configuration",
+ "responseCode":200
+ },
+ "input":{"shape":"ImportGameConfigurationRequest"},
+ "output":{"shape":"ImportGameConfigurationResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ServiceQuotaExceededException"}
+ ],
+ "documentation":"<p>Imports a game configuration.</p> <p> This operation replaces the current configuration of the game with the provided input. This is not a reversible operation. If you want to preserve the previous configuration, use <code>CreateSnapshot</code> to make a new snapshot before importing. </p>",
+ "idempotent":true
+ },
+ "ListExtensionVersions":{
+ "name":"ListExtensionVersions",
+ "http":{
+ "method":"GET",
+ "requestUri":"/extension/{Namespace}/{Name}/version",
+ "responseCode":200
+ },
+ "input":{"shape":"ListExtensionVersionsRequest"},
+ "output":{"shape":"ListExtensionVersionsResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of available versions for the extension.</p> <p> Each time an API change is made to an extension, the version is incremented. The list retrieved by this operation shows the versions that are currently available. </p>"
+ },
+ "ListExtensions":{
+ "name":"ListExtensions",
+ "http":{
+ "method":"GET",
+ "requestUri":"/extension",
+ "responseCode":200
+ },
+ "input":{"shape":"ListExtensionsRequest"},
+ "output":{"shape":"ListExtensionsResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of available extensions.</p> <p> Extensions provide features that games can use from scripts. </p>"
+ },
+ "ListGames":{
+ "name":"ListGames",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game",
+ "responseCode":200
+ },
+ "input":{"shape":"ListGamesRequest"},
+ "output":{"shape":"ListGamesResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of games.</p>"
+ },
+ "ListGeneratedCodeJobs":{
+ "name":"ListGeneratedCodeJobs",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/snapshot/{SnapshotId}/generated-sdk-code-jobs",
+ "responseCode":200
+ },
+ "input":{"shape":"ListGeneratedCodeJobsRequest"},
+ "output":{"shape":"ListGeneratedCodeJobsResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of code generation jobs for a snapshot.</p>"
+ },
+ "ListSnapshots":{
+ "name":"ListSnapshots",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/snapshot",
+ "responseCode":200
+ },
+ "input":{"shape":"ListSnapshotsRequest"},
+ "output":{"shape":"ListSnapshotsResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of snapshot summaries from the game.</p>"
+ },
+ "ListStageDeployments":{
+ "name":"ListStageDeployments",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/stage/{StageName}/deployments",
+ "responseCode":200
+ },
+ "input":{"shape":"ListStageDeploymentsRequest"},
+ "output":{"shape":"ListStageDeploymentsResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of stage deployment summaries from the game.</p>"
+ },
+ "ListStages":{
+ "name":"ListStages",
+ "http":{
+ "method":"GET",
+ "requestUri":"/game/{GameName}/stage",
+ "responseCode":200
+ },
+ "input":{"shape":"ListStagesRequest"},
+ "output":{"shape":"ListStagesResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Gets a paginated list of stage summaries from the game.</p>"
+ },
+ "ListTagsForResource":{
+ "name":"ListTagsForResource",
+ "http":{
+ "method":"GET",
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":200
+ },
+ "input":{"shape":"ListTagsForResourceRequest"},
+ "output":{"shape":"ListTagsForResourceResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Lists the tags associated with a GameSparks resource.</p>"
+ },
+ "StartGeneratedCodeJob":{
+ "name":"StartGeneratedCodeJob",
+ "http":{
+ "method":"POST",
+ "requestUri":"/game/{GameName}/snapshot/{SnapshotId}/generated-sdk-code-job",
+ "responseCode":200
+ },
+ "input":{"shape":"StartGeneratedCodeJobRequest"},
+ "output":{"shape":"StartGeneratedCodeJobResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p> Starts an asynchronous process that generates client code for system-defined and custom messages. The resulting code is collected as a .zip file and uploaded to a pre-signed Amazon S3 URL. </p>"
+ },
+ "StartStageDeployment":{
+ "name":"StartStageDeployment",
+ "http":{
+ "method":"POST",
+ "requestUri":"/game/{GameName}/stage/{StageName}/deployment",
+ "responseCode":200
+ },
+ "input":{"shape":"StartStageDeploymentRequest"},
+ "output":{"shape":"StartStageDeploymentResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ConflictException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Deploys a snapshot to the stage and creates a new game runtime.</p> <p> After you call this operation, you can check the deployment status by using <code>GetStageDeployment</code>. </p> <p> If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted. </p>",
+ "idempotent":true
+ },
+ "TagResource":{
+ "name":"TagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":200
+ },
+ "input":{"shape":"TagResourceRequest"},
+ "output":{"shape":"TagResourceResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Adds tags to a GameSparks resource.</p>"
+ },
+ "UntagResource":{
+ "name":"UntagResource",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":200
+ },
+ "input":{"shape":"UntagResourceRequest"},
+ "output":{"shape":"UntagResourceResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Removes tags from a GameSparks resource.</p>",
+ "idempotent":true
+ },
+ "UpdateGame":{
+ "name":"UpdateGame",
+ "http":{
+ "method":"PATCH",
+ "requestUri":"/game/{GameName}",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateGameRequest"},
+ "output":{"shape":"UpdateGameResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Updates details of the game.</p>",
+ "idempotent":true
+ },
+ "UpdateGameConfiguration":{
+ "name":"UpdateGameConfiguration",
+ "http":{
+ "method":"PATCH",
+ "requestUri":"/game/{GameName}/configuration",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateGameConfigurationRequest"},
+ "output":{"shape":"UpdateGameConfigurationResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ServiceQuotaExceededException"}
+ ],
+ "documentation":"<p>Updates one or more sections of the game configuration.</p>",
+ "idempotent":true
+ },
+ "UpdateSnapshot":{
+ "name":"UpdateSnapshot",
+ "http":{
+ "method":"PATCH",
+ "requestUri":"/game/{GameName}/snapshot/{SnapshotId}",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateSnapshotRequest"},
+ "output":{"shape":"UpdateSnapshotResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Updates the metadata of a GameSparks snapshot.</p>",
+ "idempotent":true
+ },
+ "UpdateStage":{
+ "name":"UpdateStage",
+ "http":{
+ "method":"PATCH",
+ "requestUri":"/game/{GameName}/stage/{StageName}",
+ "responseCode":200
+ },
+ "input":{"shape":"UpdateStageRequest"},
+ "output":{"shape":"UpdateStageResult"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
+ ],
+ "documentation":"<p>Updates the metadata of a stage.</p>",
+ "idempotent":true
+ }
+ },
+ "shapes":{
+ "ARN":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"^[A-Za-z0-9:_/-]+$"
+ },
+ "AccessDeniedException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>You do not have sufficient access to perform this action.</p>",
+ "error":{
+ "httpStatusCode":403,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "ByteSize":{
+ "type":"integer",
+ "min":0
+ },
+ "ClientToken":{
+ "type":"string",
+ "max":126,
+ "min":33
+ },
+ "ConflictException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>The resource already exists, or another operation is in progress.</p>",
+ "error":{
+ "httpStatusCode":409,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "Connection":{
+ "type":"structure",
+ "members":{
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The date and time when the connection was created.</p>"
+ },
+ "Id":{
+ "shape":"ConnectionId",
+ "documentation":"<p>The identifier used to indicate a specific WebSocket connection.</p>"
+ }
+ },
+ "documentation":"<p>Details about a WebSocket connection.</p>"
+ },
+ "ConnectionId":{
+ "type":"string",
+ "max":36,
+ "min":1
+ },
+ "ConnectionIdList":{
+ "type":"list",
+ "member":{"shape":"ConnectionId"}
+ },
+ "ConnectionList":{
+ "type":"list",
+ "member":{"shape":"Connection"}
+ },
+ "CreateGameRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> A client-defined token. With an active client token in the request, this action is idempotent. </p>"
+ },
+ "Description":{
+ "shape":"GameDescription",
+ "documentation":"<p>The description of the game.</p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The list of tags to apply to the game.</p>"
+ }
+ }
+ },
+ "CreateGameResult":{
+ "type":"structure",
+ "members":{
+ "Game":{
+ "shape":"GameDetails",
+ "documentation":"<p>Details about the game that was created.</p>"
+ }
+ }
+ },
+ "CreateSnapshotRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "Description":{
+ "shape":"SnapshotDescription",
+ "documentation":"<p>The description of the snapshot.</p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ }
+ }
+ },
+ "CreateSnapshotResult":{
+ "type":"structure",
+ "members":{
+ "Snapshot":{
+ "shape":"SnapshotDetails",
+ "documentation":"<p>Properties that provide details of the created snapshot.</p>"
+ }
+ }
+ },
+ "CreateStageRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "Role",
+ "StageName"
+ ],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> A client-defined token. With an active client token in the request, this action is idempotent. </p>"
+ },
+ "Description":{
+ "shape":"StageDescription",
+ "documentation":"<p>The description of the stage.</p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "Role":{
+ "shape":"RoleARN",
+ "documentation":"<p> The Amazon Resource Name (ARN) of the role to run the game with. This role can be a game-defined role or the default role that GameSparks created. </p>"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The list of tags to apply to the stage.</p>"
+ }
+ }
+ },
+ "CreateStageResult":{
+ "type":"structure",
+ "members":{
+ "Stage":{
+ "shape":"StageDetails",
+ "documentation":"<p>Properties that describe the stage.</p>"
+ }
+ }
+ },
+ "DateTime":{
+ "type":"timestamp",
+ "timestampFormat":"iso8601"
+ },
+ "DeleteGameRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game to delete.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ }
+ }
+ },
+ "DeleteGameResult":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "DeleteStageRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "StageName"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage to delete.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "DeleteStageResult":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "DeploymentAction":{
+ "type":"string",
+ "enum":[
+ "DEPLOY",
+ "UNDEPLOY"
+ ]
+ },
+ "DeploymentId":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"^\\S(.*\\S)?$"
+ },
+ "DeploymentState":{
+ "type":"string",
+ "enum":[
+ "PENDING",
+ "IN_PROGRESS",
+ "COMPLETED",
+ "FAILED"
+ ]
+ },
+ "DisconnectPlayerRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "PlayerId",
+ "StageName"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "PlayerId":{
+ "shape":"PlayerId",
+ "documentation":"<p>The unique identifier representing a player.</p>",
+ "location":"uri",
+ "locationName":"PlayerId"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "DisconnectPlayerResult":{
+ "type":"structure",
+ "members":{
+ "DisconnectFailures":{
+ "shape":"ConnectionIdList",
+ "documentation":"<p>The list of the connection ids that could not be disconnected.</p>"
+ },
+ "DisconnectSuccesses":{
+ "shape":"ConnectionIdList",
+ "documentation":"<p>The list of the connection ids that were disconnected.</p>"
+ }
+ }
+ },
+ "Document":{
+ "type":"structure",
+ "members":{
+ },
+ "documentation":"<p/>",
+ "document":true
+ },
+ "ExceptionMessage":{"type":"string"},
+ "ExportSnapshotRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "SnapshotId"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot to export.</p>",
+ "location":"uri",
+ "locationName":"SnapshotId"
+ }
+ }
+ },
+ "ExportSnapshotResult":{
+ "type":"structure",
+ "members":{
+ "S3Url":{
+ "shape":"S3PresignedUrl",
+ "documentation":"<p>The presigned URL for the snapshot data.</p> <p> This URL will be available for 10 minutes, and can be used to download the snapshot content. If the URL expires, a new one can be requested using the same operation. </p>"
+ }
+ }
+ },
+ "ExtensionDescription":{
+ "type":"string",
+ "max":250,
+ "min":0,
+ "pattern":"^\\S(.*\\S)?$|^$"
+ },
+ "ExtensionDetails":{
+ "type":"structure",
+ "members":{
+ "Description":{
+ "shape":"ExtensionDescription",
+ "documentation":"<p>The description of the extension.</p>"
+ },
+ "Name":{
+ "shape":"ExtensionName",
+ "documentation":"<p>The name of the extension.</p>"
+ },
+ "Namespace":{
+ "shape":"ExtensionNamespace",
+ "documentation":"<p>The namespace (qualifier) of the extension.</p>"
+ }
+ },
+ "documentation":"<p>Details about the extension.</p>"
+ },
+ "ExtensionDetailsList":{
+ "type":"list",
+ "member":{"shape":"ExtensionDetails"}
+ },
+ "ExtensionName":{
+ "type":"string",
+ "max":36,
+ "min":1,
+ "pattern":"^[a-zA-Z0-9_-]+$"
+ },
+ "ExtensionNamespace":{
+ "type":"string",
+ "max":36,
+ "min":1,
+ "pattern":"^[a-zA-Z0-9_-]+$"
+ },
+ "ExtensionVersion":{
+ "type":"string",
+ "max":20,
+ "min":0
+ },
+ "ExtensionVersionDetails":{
+ "type":"structure",
+ "members":{
+ "Name":{
+ "shape":"ExtensionName",
+ "documentation":"<p>The name of the extension.</p>"
+ },
+ "Namespace":{
+ "shape":"ExtensionNamespace",
+ "documentation":"<p>The namespace (qualifier) of the extension.</p>"
+ },
+ "Schema":{
+ "shape":"ExtensionVersionSchema",
+ "documentation":"<p>The model that defines the interface for this extension version.</p>"
+ },
+ "Version":{
+ "shape":"ExtensionVersion",
+ "documentation":"<p>The version of the extension.</p>"
+ }
+ },
+ "documentation":"<p>Details about the extension version.</p>"
+ },
+ "ExtensionVersionDetailsList":{
+ "type":"list",
+ "member":{"shape":"ExtensionVersionDetails"}
+ },
+ "ExtensionVersionSchema":{
+ "type":"string",
+ "max":2048,
+ "min":0
+ },
+ "GameConfigurationDetails":{
+ "type":"structure",
+ "members":{
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The date when the game was created.</p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>The date when the game was last modified.</p>"
+ },
+ "Sections":{
+ "shape":"Sections",
+ "documentation":"<p>Configuration data, organized by section name.</p>"
+ }
+ },
+ "documentation":"<p>Details about the game configuration.</p> <p> The game configuration is organized into named sections, where the schema of each section is defined by an extension. The schema for these sections can be retrieved using the <code>GetExtensionVersion</code> operation. </p>"
+ },
+ "GameDescription":{
+ "type":"string",
+ "max":250,
+ "min":0,
+ "pattern":"^\\S(.*\\S)?$|^$"
+ },
+ "GameDetails":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of this game.</p>"
+ },
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The date when the game was created.</p>"
+ },
+ "Description":{
+ "shape":"GameDescription",
+ "documentation":"<p>The description of the game.</p>"
+ },
+ "EnableTerminationProtection":{
+ "shape":"GameTerminationProtection",
+ "documentation":"<p>Determines if the game can be deleted.</p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>The date when the game was last modified.</p>"
+ },
+ "Name":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>"
+ },
+ "State":{
+ "shape":"GameState",
+ "documentation":"<p>The state of the game.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags associated with the game.</p>"
+ }
+ },
+ "documentation":"<p>Details about a game.</p>"
+ },
+ "GameKey":{
+ "type":"string",
+ "max":44,
+ "min":1
+ },
+ "GameName":{
+ "type":"string",
+ "max":36,
+ "min":1,
+ "pattern":"^[a-zA-Z0-9_-]+$"
+ },
+ "GameSdkVersion":{
+ "type":"string",
+ "max":10,
+ "min":5,
+ "pattern":"^(\\d|[1-9]\\d*)\\.(\\d|[0-9]\\d*)\\.(\\d|[0-9]\\d*)$"
+ },
+ "GameState":{
+ "type":"string",
+ "enum":[
+ "ACTIVE",
+ "DELETING"
+ ]
+ },
+ "GameSummary":{
+ "type":"structure",
+ "members":{
+ "Description":{
+ "shape":"GameDescription",
+ "documentation":"<p>The description of the game.</p>"
+ },
+ "Name":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>"
+ },
+ "State":{
+ "shape":"GameState",
+ "documentation":"<p>The state of the game.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags associated with the game.</p>"
+ }
+ },
+ "documentation":"<p>The summary of the properties of a game.</p>"
+ },
+ "GameSummaryList":{
+ "type":"list",
+ "member":{"shape":"GameSummary"}
+ },
+ "GameTerminationProtection":{"type":"boolean"},
+ "GeneratedCodeJobDescription":{
+ "type":"string",
+ "max":250,
+ "min":0,
+ "pattern":"^\\S(.*\\S)?$|^$"
+ },
+ "GeneratedCodeJobDetails":{
+ "type":"structure",
+ "members":{
+ "Description":{
+ "shape":"GeneratedCodeJobDescription",
+ "documentation":"<p>The description of the generated code job.</p>"
+ },
+ "ExpirationTime":{
+ "shape":"DateTime",
+ "documentation":"<p>The expiration date and time for the download URL.</p> <p> The download URL us guaranteed to be available until at least this time. </p>"
+ },
+ "GeneratedCodeJobId":{
+ "shape":"GeneratedCodeJobId",
+ "documentation":"<p>The identifier for the generated code job.</p>"
+ },
+ "S3Url":{
+ "shape":"S3PresignedUrl",
+ "documentation":"<p>A presigned URL that can be used to download the generated code.</p>"
+ },
+ "Status":{
+ "shape":"GeneratedCodeJobState",
+ "documentation":"<p>The status of the generated code job</p>"
+ }
+ },
+ "documentation":"<p>Details about a generated code job.</p>"
+ },
+ "GeneratedCodeJobDetailsList":{
+ "type":"list",
+ "member":{"shape":"GeneratedCodeJobDetails"}
+ },
+ "GeneratedCodeJobId":{
+ "type":"string",
+ "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
+ },
+ "GeneratedCodeJobState":{
+ "type":"string",
+ "enum":[
+ "IN_PROGRESS",
+ "COMPLETED",
+ "FAILED",
+ "PENDING"
+ ]
+ },
+ "Generator":{
+ "type":"structure",
+ "members":{
+ "GameSdkVersion":{
+ "shape":"GameSdkVersion",
+ "documentation":"<p>The target version of the GameSparks Game SDK.</p>"
+ },
+ "Language":{
+ "shape":"Language",
+ "documentation":"<p>The programming language for the generated code.</p> <p> Not all languages are supported for each platform. For cases where multiple languages are supported, this parameter specifies the language to be used. If this value is omitted, the default language for the target platform will be used. </p>"
+ },
+ "TargetPlatform":{
+ "shape":"TargetPlatform",
+ "documentation":"<p>The platform that will be used to run the generated code.</p>"
+ }
+ },
+ "documentation":"<p>Properties that specify the code generator for a generated code job.</p>"
+ },
+ "GetExtensionRequest":{
+ "type":"structure",
+ "required":[
+ "Name",
+ "Namespace"
+ ],
+ "members":{
+ "Name":{
+ "shape":"ExtensionName",
+ "documentation":"<p>The name of the extension.</p>",
+ "location":"uri",
+ "locationName":"Name"
+ },
+ "Namespace":{
+ "shape":"ExtensionNamespace",
+ "documentation":"<p>The namespace (qualifier) of the extension.</p>",
+ "location":"uri",
+ "locationName":"Namespace"
+ }
+ }
+ },
+ "GetExtensionResult":{
+ "type":"structure",
+ "members":{
+ "Extension":{
+ "shape":"ExtensionDetails",
+ "documentation":"<p>Details about the extension.</p>"
+ }
+ }
+ },
+ "GetExtensionVersionRequest":{
+ "type":"structure",
+ "required":[
+ "ExtensionVersion",
+ "Name",
+ "Namespace"
+ ],
+ "members":{
+ "ExtensionVersion":{
+ "shape":"ExtensionVersion",
+ "documentation":"<p>The version of the extension.</p>",
+ "location":"uri",
+ "locationName":"ExtensionVersion"
+ },
+ "Name":{
+ "shape":"ExtensionName",
+ "documentation":"<p>The name of the extension.</p>",
+ "location":"uri",
+ "locationName":"Name"
+ },
+ "Namespace":{
+ "shape":"ExtensionNamespace",
+ "documentation":"<p>The namespace (qualifier) of the extension.</p>",
+ "location":"uri",
+ "locationName":"Namespace"
+ }
+ }
+ },
+ "GetExtensionVersionResult":{
+ "type":"structure",
+ "members":{
+ "ExtensionVersion":{
+ "shape":"ExtensionVersionDetails",
+ "documentation":"<p>The version of the extension.</p>"
+ }
+ }
+ },
+ "GetGameConfigurationRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "Sections":{
+ "shape":"SectionList",
+ "documentation":"<p>The list of sections to return.</p>",
+ "location":"querystring",
+ "locationName":"Sections"
+ }
+ }
+ },
+ "GetGameConfigurationResult":{
+ "type":"structure",
+ "members":{
+ "GameConfiguration":{
+ "shape":"GameConfigurationDetails",
+ "documentation":"<p>Details about the game configuration.</p>"
+ }
+ }
+ },
+ "GetGameRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ }
+ }
+ },
+ "GetGameResult":{
+ "type":"structure",
+ "members":{
+ "Game":{
+ "shape":"GameDetails",
+ "documentation":"<p>The details of the game.</p>"
+ }
+ }
+ },
+ "GetGeneratedCodeJobRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "JobId",
+ "SnapshotId"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "JobId":{
+ "shape":"GeneratedCodeJobId",
+ "documentation":"<p>The identifier of the code generation job.</p>",
+ "location":"uri",
+ "locationName":"JobId"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot for the code generation job.</p>",
+ "location":"uri",
+ "locationName":"SnapshotId"
+ }
+ }
+ },
+ "GetGeneratedCodeJobResult":{
+ "type":"structure",
+ "members":{
+ "GeneratedCodeJob":{
+ "shape":"GeneratedCodeJobDetails",
+ "documentation":"<p>Details about the generated code job.</p>"
+ }
+ }
+ },
+ "GetPlayerConnectionStatusRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "PlayerId",
+ "StageName"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "PlayerId":{
+ "shape":"PlayerId",
+ "documentation":"<p>The unique identifier representing a player.</p>",
+ "location":"uri",
+ "locationName":"PlayerId"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "GetPlayerConnectionStatusResult":{
+ "type":"structure",
+ "members":{
+ "Connections":{
+ "shape":"ConnectionList",
+ "documentation":"<p>The list of connection ids, one for each connection in use by the player.</p>"
+ }
+ }
+ },
+ "GetSnapshotRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "SnapshotId"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "Sections":{
+ "shape":"SectionList",
+ "documentation":"<p>The list of game configuration sections to be described.</p>",
+ "location":"querystring",
+ "locationName":"Sections"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot.</p>",
+ "location":"uri",
+ "locationName":"SnapshotId"
+ }
+ }
+ },
+ "GetSnapshotResult":{
+ "type":"structure",
+ "members":{
+ "Snapshot":{
+ "shape":"SnapshotDetails",
+ "documentation":"<p>Properties that provide details of the snapshot.</p>"
+ }
+ }
+ },
+ "GetStageDeploymentRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "StageName"
+ ],
+ "members":{
+ "DeploymentId":{
+ "shape":"DeploymentId",
+ "documentation":"<p> The identifier of the stage deployment. <code>StartStageDeployment</code> returns the identifier that you use here. </p>",
+ "location":"querystring",
+ "locationName":"DeploymentId"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "GetStageDeploymentResult":{
+ "type":"structure",
+ "members":{
+ "StageDeployment":{
+ "shape":"StageDeploymentDetails",
+ "documentation":"<p>Properties that provide details of the stage deployment.</p>"
+ }
+ }
+ },
+ "GetStageRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "StageName"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "GetStageResult":{
+ "type":"structure",
+ "members":{
+ "Stage":{
+ "shape":"StageDetails",
+ "documentation":"<p>Properties that provide details of the stage.</p>"
+ }
+ }
+ },
+ "ImportGameConfigurationRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "ImportSource"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "ImportSource":{
+ "shape":"ImportGameConfigurationSource",
+ "documentation":"<p>The source used to import configuration sections.</p>"
+ }
+ }
+ },
+ "ImportGameConfigurationResult":{
+ "type":"structure",
+ "members":{
+ "GameConfiguration":{
+ "shape":"GameConfigurationDetails",
+ "documentation":"<p>Details about the game configuration.</p>"
+ }
+ }
+ },
+ "ImportGameConfigurationSource":{
+ "type":"structure",
+ "required":["File"],
+ "members":{
+ "File":{
+ "shape":"RawGameConfigurationData",
+ "documentation":"<p>The JSON string containing the configuration sections.</p>"
+ }
+ },
+ "documentation":"<p>The source used to import configuration sections.</p>"
+ },
+ "InternalServerException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>The service encountered an internal error.</p>",
+ "error":{"httpStatusCode":500},
+ "exception":true,
+ "fault":true
+ },
+ "Language":{
+ "type":"string",
+ "max":16,
+ "min":1,
+ "pattern":"^[a-zA-Z_]+$"
+ },
+ "ListExtensionVersionsRequest":{
+ "type":"structure",
+ "required":[
+ "Name",
+ "Namespace"
+ ],
+ "members":{
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "Name":{
+ "shape":"ExtensionName",
+ "documentation":"<p>The name of the extension.</p>",
+ "location":"uri",
+ "locationName":"Name"
+ },
+ "Namespace":{
+ "shape":"ExtensionNamespace",
+ "documentation":"<p>The namespace (qualifier) of the extension.</p>",
+ "location":"uri",
+ "locationName":"Namespace"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ }
+ }
+ },
+ "ListExtensionVersionsResult":{
+ "type":"structure",
+ "members":{
+ "ExtensionVersions":{
+ "shape":"ExtensionVersionDetailsList",
+ "documentation":"<p>The list of extension versions.</p>"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ }
+ }
+ },
+ "ListExtensionsRequest":{
+ "type":"structure",
+ "members":{
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ }
+ }
+ },
+ "ListExtensionsResult":{
+ "type":"structure",
+ "members":{
+ "Extensions":{
+ "shape":"ExtensionDetailsList",
+ "documentation":"<p>The list of extensions.</p>"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ }
+ }
+ },
+ "ListGamesRequest":{
+ "type":"structure",
+ "members":{
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ }
+ }
+ },
+ "ListGamesResult":{
+ "type":"structure",
+ "members":{
+ "Games":{
+ "shape":"GameSummaryList",
+ "documentation":"<p>The list of games.</p>"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ }
+ }
+ },
+ "ListGeneratedCodeJobsRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "SnapshotId"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot.</p>",
+ "location":"uri",
+ "locationName":"SnapshotId"
+ }
+ }
+ },
+ "ListGeneratedCodeJobsResult":{
+ "type":"structure",
+ "members":{
+ "GeneratedCodeJobs":{
+ "shape":"GeneratedCodeJobDetailsList",
+ "documentation":"<p>The list of generated code jobs.</p>"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ }
+ }
+ },
+ "ListSnapshotsRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ }
+ }
+ },
+ "ListSnapshotsResult":{
+ "type":"structure",
+ "members":{
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ },
+ "Snapshots":{
+ "shape":"SnapshotSummaryList",
+ "documentation":"<p> A list of snapshot summaries. You can use the returned snapshot IDs in the <code>UpdateSnapshot</code> and <code>GetSnapshot</code> operations. </p>"
+ }
+ }
+ },
+ "ListStageDeploymentsRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "StageName"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "ListStageDeploymentsResult":{
+ "type":"structure",
+ "members":{
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ },
+ "StageDeployments":{
+ "shape":"StageDeploymentList",
+ "documentation":"<p> A list of stage deployment summaries. You can use the deployment IDs in the <code>UpdateStageDeployment</code> and <code>GetStageDeployment</code> actions. </p>"
+ }
+ }
+ },
+ "ListStagesRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return.</p> <p> Use this parameter with NextToken to get results as a set of sequential pages. </p>",
+ "location":"querystring",
+ "locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. </p>",
+ "location":"querystring",
+ "locationName":"NextToken"
+ }
+ }
+ },
+ "ListStagesResult":{
+ "type":"structure",
+ "members":{
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The token that indicates the start of the next sequential page of results.</p> <p> Use this value when making the next call to this operation to continue where the last one finished. </p>"
+ },
+ "Stages":{
+ "shape":"StageSummaryList",
+ "documentation":"<p> A list of stage summaries. You can use the stage names in the <code>UpdateStage</code> and <code>GetStage</code> actions. </p>"
+ }
+ }
+ },
+ "ListTagsForResourceRequest":{
+ "type":"structure",
+ "required":["ResourceArn"],
+ "members":{
+ "ResourceArn":{
+ "shape":"ResourceArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the GameSparks resource.</p>",
+ "location":"uri",
+ "locationName":"ResourceArn"
+ }
+ }
+ },
+ "ListTagsForResourceResult":{
+ "type":"structure",
+ "members":{
+ "tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags associated with the resource.</p>"
+ }
+ }
+ },
+ "LogGroupName":{
+ "type":"string",
+ "max":512,
+ "min":1
+ },
+ "MaxResults":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
+ "NextToken":{
+ "type":"string",
+ "max":1024,
+ "min":1,
+ "pattern":"^\\S(.*\\S)?$"
+ },
+ "Operation":{
+ "type":"string",
+ "enum":[
+ "ADD",
+ "REMOVE",
+ "REPLACE"
+ ]
+ },
+ "Path":{
+ "type":"string",
+ "max":500,
+ "min":1,
+ "pattern":"^\\/.*[^\\/]$"
+ },
+ "PlayerId":{
+ "type":"string",
+ "max":44,
+ "min":1,
+ "pattern":"^[a-zA-Z0-9_-]+$"
+ },
+ "RawGameConfigurationData":{
+ "type":"blob",
+ "max":1024000,
+ "min":10
+ },
+ "ResourceArn":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"^arn:aws:gamesparks:"
+ },
+ "ResourceNotFoundException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>The resource specified in the request does not exist.</p>",
+ "error":{
+ "httpStatusCode":404,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "RoleARN":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/.+$"
+ },
+ "S3PresignedUrl":{
+ "type":"string",
+ "max":2048,
+ "min":10,
+ "pattern":"^https:\\/\\/(.*)\\.s3(.*)\\.amazonaws\\.com\\/(.*)$"
+ },
+ "Section":{
+ "type":"structure",
+ "members":{
+ "Attributes":{
+ "shape":"Document",
+ "documentation":"<p>The content of a configuration section.</p>"
+ },
+ "Name":{
+ "shape":"SectionName",
+ "documentation":"<p>The name of the section.</p>"
+ },
+ "Size":{
+ "shape":"ByteSize",
+ "documentation":"<p>The size, in bytes, of the section contents.</p>"
+ }
+ },
+ "documentation":"<p>The configuration section.</p>"
+ },
+ "SectionList":{
+ "type":"list",
+ "member":{"shape":"SectionName"},
+ "max":100,
+ "min":1
+ },
+ "SectionModification":{
+ "type":"structure",
+ "required":[
+ "Operation",
+ "Path",
+ "Section"
+ ],
+ "members":{
+ "Operation":{
+ "shape":"Operation",
+ "documentation":"<p>The operation to be performed on a configuration section.</p> <p> Content can be added, deleted, or replaced within a section. </p>"
+ },
+ "Path":{
+ "shape":"Path",
+ "documentation":"<p>The path within the section content to be modified.</p>"
+ },
+ "Section":{
+ "shape":"SectionName",
+ "documentation":"<p>The name of the section to be modified.</p>"
+ },
+ "Value":{
+ "shape":"Document",
+ "documentation":"<p>For add and replace operations, this is the value that will be used.</p> <p> This field should be omitted for delete operations. </p>"
+ }
+ },
+ "documentation":"<p>A single modification to the configuration section.</p>"
+ },
+ "SectionModificationList":{
+ "type":"list",
+ "member":{"shape":"SectionModification"},
+ "max":100,
+ "min":1
+ },
+ "SectionName":{
+ "type":"string",
+ "max":36,
+ "min":1,
+ "pattern":"^[a-zA-Z0-9.]+$"
+ },
+ "Sections":{
+ "type":"map",
+ "key":{"shape":"SectionName"},
+ "value":{"shape":"Section"}
+ },
+ "ServiceQuotaExceededException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>The request would result in exceeding service quota.</p>",
+ "error":{
+ "httpStatusCode":402,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "SnapshotDescription":{
+ "type":"string",
+ "max":250,
+ "min":0,
+ "pattern":"^\\S(.*\\S)?$|^$"
+ },
+ "SnapshotDetails":{
+ "type":"structure",
+ "members":{
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the snapshot was created.</p>"
+ },
+ "Description":{
+ "shape":"SnapshotDescription",
+ "documentation":"<p>The description of the snapshot.</p>"
+ },
+ "Id":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot.</p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the snapshot was last updated.</p>"
+ },
+ "Sections":{
+ "shape":"Sections",
+ "documentation":"<p>The sections in the snapshot.</p>"
+ }
+ },
+ "documentation":"<p>Properties that provide details of a snapshot.</p>"
+ },
+ "SnapshotId":{
+ "type":"string",
+ "max":36,
+ "min":33,
+ "pattern":"^Snapshot_\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3,6}Z$"
+ },
+ "SnapshotSummary":{
+ "type":"structure",
+ "members":{
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the snapshot was created.</p>"
+ },
+ "Description":{
+ "shape":"SnapshotDescription",
+ "documentation":"<p>The description of the snapshot.</p>"
+ },
+ "Id":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot.</p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>Then timestamp of when the snapshot was last updated.</p>"
+ }
+ },
+ "documentation":"<p>The summary of the properties of a snapshot.</p>"
+ },
+ "SnapshotSummaryList":{
+ "type":"list",
+ "member":{"shape":"SnapshotSummary"}
+ },
+ "StageDeploymentDetails":{
+ "type":"structure",
+ "members":{
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the stage deployment was created.</p>"
+ },
+ "DeploymentAction":{
+ "shape":"DeploymentAction",
+ "documentation":"<p>The type of action of the stage deployment.</p>"
+ },
+ "DeploymentId":{
+ "shape":"DeploymentId",
+ "documentation":"<p>The identifier of the deployment.</p>"
+ },
+ "DeploymentState":{
+ "shape":"DeploymentState",
+ "documentation":"<p>The state of the deployment.</p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the deployment was last updated.</p>"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot associated with the stage deployment.</p>"
+ }
+ },
+ "documentation":"<p>Properties that provide details of a stage deployment.</p>"
+ },
+ "StageDeploymentList":{
+ "type":"list",
+ "member":{"shape":"StageDeploymentSummary"}
+ },
+ "StageDeploymentSummary":{
+ "type":"structure",
+ "members":{
+ "DeploymentAction":{
+ "shape":"DeploymentAction",
+ "documentation":"<p>The type of action of the deployment.</p>"
+ },
+ "DeploymentId":{
+ "shape":"DeploymentId",
+ "documentation":"<p>The identifier of the deployment.</p>"
+ },
+ "DeploymentState":{
+ "shape":"DeploymentState",
+ "documentation":"<p>The state of the deployment.</p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the deployment was last updated.</p>"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot associated with the stage deployment.</p>"
+ }
+ },
+ "documentation":"<p>The summary of the properties of a stage deployment.</p>"
+ },
+ "StageDescription":{
+ "type":"string",
+ "max":250,
+ "min":0,
+ "pattern":"^\\S(.*\\S)?$|^$"
+ },
+ "StageDetails":{
+ "type":"structure",
+ "members":{
+ "Arn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the stage.</p>"
+ },
+ "Created":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the stage was created.</p>"
+ },
+ "Description":{
+ "shape":"StageDescription",
+ "documentation":"<p>The description of the stage.</p>"
+ },
+ "GameKey":{
+ "shape":"GameKey",
+ "documentation":"<p>The game key associated with the stage.</p> <p> The game key is a unique identifier that the game client uses to connect to the GameSparks backend. </p>"
+ },
+ "LastUpdated":{
+ "shape":"DateTime",
+ "documentation":"<p>The timestamp of when the stage was last updated.</p>"
+ },
+ "LogGroup":{
+ "shape":"LogGroupName",
+ "documentation":"<p>The Amazon CloudWatch log group for game runtimes deployed to the stage.</p>"
+ },
+ "Name":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>"
+ },
+ "Role":{
+ "shape":"RoleARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the role used to run the game runtimes deployed to the stage.</p>"
+ },
+ "State":{
+ "shape":"StageState",
+ "documentation":"<p>The state of the stage.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags associated with the stage.</p>"
+ }
+ },
+ "documentation":"<p>Properties that provide details of a stage.</p>"
+ },
+ "StageName":{
+ "type":"string",
+ "max":36,
+ "min":1,
+ "pattern":"^[a-zA-Z0-9_-]+$"
+ },
+ "StageState":{
+ "type":"string",
+ "enum":[
+ "ACTIVE",
+ "DELETING"
+ ]
+ },
+ "StageSummary":{
+ "type":"structure",
+ "members":{
+ "Description":{
+ "shape":"StageDescription",
+ "documentation":"<p>The description of the stage.</p>"
+ },
+ "GameKey":{
+ "shape":"GameKey",
+ "documentation":"<p>The game key associated with the stage.</p> <p> The game key is a unique identifier that the game client uses to connect to the GameSparks backend. </p>"
+ },
+ "Name":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>"
+ },
+ "State":{
+ "shape":"StageState",
+ "documentation":"<p>The state of the stage.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags associated with the stage.</p>"
+ }
+ },
+ "documentation":"<p>The summary of the properties of a stage.</p>"
+ },
+ "StageSummaryList":{
+ "type":"list",
+ "member":{"shape":"StageSummary"}
+ },
+ "StartGeneratedCodeJobRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "Generator",
+ "SnapshotId"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "Generator":{
+ "shape":"Generator",
+ "documentation":"<p>Properties of the generator to use for the job.</p>"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot for which to generate code.</p>",
+ "location":"uri",
+ "locationName":"SnapshotId"
+ }
+ }
+ },
+ "StartGeneratedCodeJobResult":{
+ "type":"structure",
+ "members":{
+ "GeneratedCodeJobId":{
+ "shape":"GeneratedCodeJobId",
+ "documentation":"<p> The identifier of the code generation job. You can use this identifier in the <code>GetGeneratedCodeJob</code> operation. </p>"
+ }
+ }
+ },
+ "StartStageDeploymentRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "SnapshotId",
+ "StageName"
+ ],
+ "members":{
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p> A client-defined token. With an active client token in the request, this action is idempotent. </p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot to deploy.</p>"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage to deploy the snapshot onto.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "StartStageDeploymentResult":{
+ "type":"structure",
+ "members":{
+ "StageDeployment":{
+ "shape":"StageDeploymentDetails",
+ "documentation":"<p>Properties that describe the stage deployment.</p>"
+ }
+ }
+ },
+ "TagKey":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$"
+ },
+ "TagKeyList":{
+ "type":"list",
+ "member":{"shape":"TagKey"},
+ "max":50,
+ "min":1
+ },
+ "TagMap":{
+ "type":"map",
+ "key":{"shape":"TagKey"},
+ "value":{"shape":"TagValue"},
+ "max":50,
+ "min":1
+ },
+ "TagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "ResourceArn",
+ "tags"
+ ],
+ "members":{
+ "ResourceArn":{
+ "shape":"ResourceArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the resource to add the tags to.</p>",
+ "location":"uri",
+ "locationName":"ResourceArn"
+ },
+ "tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The tags to add to the resource.</p>"
+ }
+ }
+ },
+ "TagResourceResult":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "TagValue":{
+ "type":"string",
+ "max":256,
+ "min":0,
+ "pattern":"^[\\s\\w+-=\\.:/@]*$"
+ },
+ "TargetPlatform":{
+ "type":"string",
+ "max":16,
+ "min":1,
+ "pattern":"^[a-zA-Z]+$"
+ },
+ "ThrottlingException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>The request throughput limit was exceeded.</p>",
+ "error":{
+ "httpStatusCode":429,
+ "senderFault":true
+ },
+ "exception":true
+ },
+ "UntagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "ResourceArn",
+ "tagKeys"
+ ],
+ "members":{
+ "ResourceArn":{
+ "shape":"ResourceArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the resource to remove the tags from.</p>",
+ "location":"uri",
+ "locationName":"ResourceArn"
+ },
+ "tagKeys":{
+ "shape":"TagKeyList",
+ "documentation":"<p>The keys of the tags to remove.</p>",
+ "location":"querystring",
+ "locationName":"tagKeys"
+ }
+ }
+ },
+ "UntagResourceResult":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "UpdateGameConfigurationRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "Modifications"
+ ],
+ "members":{
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "Modifications":{
+ "shape":"SectionModificationList",
+ "documentation":"<p>The list of modifications to make.</p>"
+ }
+ }
+ },
+ "UpdateGameConfigurationResult":{
+ "type":"structure",
+ "members":{
+ "GameConfiguration":{
+ "shape":"GameConfigurationDetails",
+ "documentation":"<p>Details about the game configuration.</p>"
+ }
+ }
+ },
+ "UpdateGameRequest":{
+ "type":"structure",
+ "required":["GameName"],
+ "members":{
+ "Description":{
+ "shape":"GameDescription",
+ "documentation":"<p>The description of the game.</p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ }
+ }
+ },
+ "UpdateGameResult":{
+ "type":"structure",
+ "members":{
+ "Game":{
+ "shape":"GameDetails",
+ "documentation":"<p>The details of the game.</p>"
+ }
+ }
+ },
+ "UpdateSnapshotRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "SnapshotId"
+ ],
+ "members":{
+ "Description":{
+ "shape":"SnapshotDescription",
+ "documentation":"<p>The description of the snapshot.</p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "SnapshotId":{
+ "shape":"SnapshotId",
+ "documentation":"<p>The identifier of the snapshot.</p>",
+ "location":"uri",
+ "locationName":"SnapshotId"
+ }
+ }
+ },
+ "UpdateSnapshotResult":{
+ "type":"structure",
+ "members":{
+ "Snapshot":{
+ "shape":"SnapshotDetails",
+ "documentation":"<p>Properties that provide details of the updated snapshot.</p>"
+ }
+ }
+ },
+ "UpdateStageRequest":{
+ "type":"structure",
+ "required":[
+ "GameName",
+ "StageName"
+ ],
+ "members":{
+ "Description":{
+ "shape":"StageDescription",
+ "documentation":"<p>The description of the stage.</p>"
+ },
+ "GameName":{
+ "shape":"GameName",
+ "documentation":"<p>The name of the game.</p>",
+ "location":"uri",
+ "locationName":"GameName"
+ },
+ "Role":{
+ "shape":"RoleARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the role to use for the game snapshots deployed to this stage.</p>"
+ },
+ "StageName":{
+ "shape":"StageName",
+ "documentation":"<p>The name of the stage.</p>",
+ "location":"uri",
+ "locationName":"StageName"
+ }
+ }
+ },
+ "UpdateStageResult":{
+ "type":"structure",
+ "members":{
+ "Stage":{
+ "shape":"StageDetails",
+ "documentation":"<p>Properties that provide details of the updated stage.</p>"
+ }
+ }
+ },
+ "ValidationException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>One of the parameters in the request is invalid.</p>",
+ "error":{
+ "httpStatusCode":400,
+ "senderFault":true
+ },
+ "exception":true
+ }
+ },
+ "documentation":"<p/>"
+}
diff --git a/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json b/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json
index 46c03b8c84..25566e4144 100644
--- a/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json
@@ -251,6 +251,24 @@
],
"documentation":"<p>Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling <code>CancelMLTaskRun</code> with a task run's parent transform's <code>TransformID</code> and the task run's <code>TaskRunId</code>. </p>"
},
+ "CancelStatement":{
+ "name":"CancelStatement",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"CancelStatementRequest"},
+ "output":{"shape":"CancelStatementResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"EntityNotFoundException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"IllegalSessionStateException"}
+ ],
+ "documentation":"<p>Cancels the statement..</p>"
+ },
"CheckSchemaVersionValidity":{
"name":"CheckSchemaVersionValidity",
"http":{
@@ -515,6 +533,26 @@
],
"documentation":"<p>Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html\">Encrypting Data Written by Crawlers, Jobs, and Development Endpoints</a>.</p>"
},
+ "CreateSession":{
+ "name":"CreateSession",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"CreateSessionRequest"},
+ "output":{"shape":"CreateSessionResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"IdempotentParameterMismatchException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"ValidationException"},
+ {"shape":"AlreadyExistsException"},
+ {"shape":"ResourceNumberLimitExceededException"}
+ ],
+ "documentation":"<p>Creates a new session.</p>"
+ },
"CreateTable":{
"name":"CreateTable",
"http":{
@@ -865,6 +903,24 @@
],
"documentation":"<p>Deletes a specified security configuration.</p>"
},
+ "DeleteSession":{
+ "name":"DeleteSession",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"DeleteSessionRequest"},
+ "output":{"shape":"DeleteSessionResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"IllegalSessionStateException"},
+ {"shape":"ConcurrentModificationException"}
+ ],
+ "documentation":"<p>Deletes the session.</p>"
+ },
"DeleteTable":{
"name":"DeleteTable",
"http":{
@@ -1609,6 +1665,41 @@
],
"documentation":"<p>Retrieves a list of all security configurations.</p>"
},
+ "GetSession":{
+ "name":"GetSession",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetSessionRequest"},
+ "output":{"shape":"GetSessionResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"EntityNotFoundException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"}
+ ],
+ "documentation":"<p>Retrieves the session.</p>"
+ },
+ "GetStatement":{
+ "name":"GetStatement",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetStatementRequest"},
+ "output":{"shape":"GetStatementResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"EntityNotFoundException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"IllegalSessionStateException"}
+ ],
+ "documentation":"<p>Retrieves the statement.</p>"
+ },
"GetTable":{
"name":"GetTable",
"http":{
@@ -2012,6 +2103,40 @@
],
"documentation":"<p>Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.</p> <p>When the <code>RegistryId</code> is not provided, all the schemas across registries will be part of the API response.</p>"
},
+ "ListSessions":{
+ "name":"ListSessions",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListSessionsRequest"},
+ "output":{"shape":"ListSessionsResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"}
+ ],
+ "documentation":"<p>Retrieve a session..</p>"
+ },
+ "ListStatements":{
+ "name":"ListStatements",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListStatementsRequest"},
+ "output":{"shape":"ListStatementsResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"EntityNotFoundException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"IllegalSessionStateException"}
+ ],
+ "documentation":"<p>Lists statements for the session.</p>"
+ },
"ListTriggers":{
"name":"ListTriggers",
"http":{
@@ -2193,6 +2318,26 @@
],
"documentation":"<p>Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.</p>"
},
+ "RunStatement":{
+ "name":"RunStatement",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"RunStatementRequest"},
+ "output":{"shape":"RunStatementResponse"},
+ "errors":[
+ {"shape":"EntityNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"ValidationException"},
+ {"shape":"ResourceNumberLimitExceededException"},
+ {"shape":"IllegalSessionStateException"}
+ ],
+ "documentation":"<p>Executes the statement.</p>"
+ },
"SearchTables":{
"name":"SearchTables",
"http":{
@@ -2412,6 +2557,24 @@
],
"documentation":"<p>Sets the schedule state of the specified crawler to <code>NOT_SCHEDULED</code>, but does not stop the crawler if it is already running.</p>"
},
+ "StopSession":{
+ "name":"StopSession",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"StopSessionRequest"},
+ "output":{"shape":"StopSessionResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServiceException"},
+ {"shape":"OperationTimeoutException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"IllegalSessionStateException"},
+ {"shape":"ConcurrentModificationException"}
+ ],
+ "documentation":"<p>Stops the session.</p>"
+ },
"StopTrigger":{
"name":"StopTrigger",
"http":{
@@ -2857,11 +3020,27 @@
"exception":true
},
"AttemptCount":{"type":"integer"},
+ "AuditColumnNamesList":{
+ "type":"list",
+ "member":{"shape":"ColumnNameString"}
+ },
"AuditContext":{
"type":"structure",
"members":{
- "AdditionalAuditContext":{"shape":"AuditContextString"}
- }
+ "AdditionalAuditContext":{
+ "shape":"AuditContextString",
+ "documentation":"<p>The context for the audit..</p>"
+ },
+ "RequestedColumns":{
+ "shape":"AuditColumnNamesList",
+ "documentation":"<p>The requested columns for audit.</p>"
+ },
+ "AllColumnsRequested":{
+ "shape":"NullableBoolean",
+ "documentation":"<p>All columns request for audit.</p>"
+ }
+ },
+ "documentation":"<p>A structure containing information for audit.</p>"
},
"AuditContextString":{
"type":"string",
@@ -3685,6 +3864,32 @@
}
}
},
+ "CancelStatementRequest":{
+ "type":"structure",
+ "required":[
+ "SessionId",
+ "Id"
+ ],
+ "members":{
+ "SessionId":{
+ "shape":"NameString",
+ "documentation":"<p>The Session ID of the statement to be cancelled.</p>"
+ },
+ "Id":{
+ "shape":"IntegerValue",
+ "documentation":"<p>The ID of the statement to be cancelled.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request to cancel the statement.</p>"
+ }
+ }
+ },
+ "CancelStatementResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
"CatalogEncryptionMode":{
"type":"string",
"enum":[
@@ -5528,6 +5733,86 @@
}
}
},
+ "CreateSessionRequest":{
+ "type":"structure",
+ "required":[
+ "Id",
+ "Role",
+ "Command"
+ ],
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>The ID of the session request. </p>"
+ },
+ "Description":{
+ "shape":"DescriptionString",
+ "documentation":"<p>The description of the session. </p>"
+ },
+ "Role":{
+ "shape":"OrchestrationRoleArn",
+ "documentation":"<p>The IAM Role ARN </p>"
+ },
+ "Command":{
+ "shape":"SessionCommand",
+ "documentation":"<p>The <code>SessionCommand</code> that runs the job. </p>"
+ },
+ "Timeout":{
+ "shape":"Timeout",
+ "documentation":"<p>The number of seconds before request times out. </p>"
+ },
+ "IdleTimeout":{
+ "shape":"Timeout",
+ "documentation":"<p>The number of seconds when idle before request times out. </p>"
+ },
+ "DefaultArguments":{
+ "shape":"OrchestrationArgumentsMap",
+ "documentation":"<p>A map array of key-value pairs. Max is 75 pairs. </p>"
+ },
+ "Connections":{
+ "shape":"ConnectionsList",
+ "documentation":"<p>The number of connections to use for the session. </p>"
+ },
+ "MaxCapacity":{
+ "shape":"NullableDouble",
+ "documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory. </p>"
+ },
+ "NumberOfWorkers":{
+ "shape":"NullableInteger",
+ "documentation":"<p>The number of workers to use for the session. </p>"
+ },
+ "WorkerType":{
+ "shape":"WorkerType",
+ "documentation":"<p>The Worker Type. Can be one of G.1X, G.2X, Standard </p>"
+ },
+ "SecurityConfiguration":{
+ "shape":"NameString",
+ "documentation":"<p>The name of the SecurityConfiguration structure to be used with the session </p>"
+ },
+ "GlueVersion":{
+ "shape":"GlueVersionString",
+ "documentation":"<p>The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The GlueVersion must be greater than 2.0. </p>"
+ },
+ "Tags":{
+ "shape":"TagsMap",
+ "documentation":"<p>The map of key value pairs (tags) belonging to the session.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request. </p>"
+ }
+ },
+ "documentation":"<p>Request to create a new session.</p>"
+ },
+ "CreateSessionResponse":{
+ "type":"structure",
+ "members":{
+ "Session":{
+ "shape":"Session",
+ "documentation":"<p>Returns the session object in the response.</p>"
+ }
+ }
+ },
"CreateTableRequest":{
"type":"structure",
"required":[
@@ -6383,6 +6668,29 @@
"members":{
}
},
+ "DeleteSessionRequest":{
+ "type":"structure",
+ "required":["Id"],
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>The ID of the session to be deleted.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The name of the origin of the delete session request.</p>"
+ }
+ }
+ },
+ "DeleteSessionResponse":{
+ "type":"structure",
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>Returns the ID of the deleted session.</p>"
+ }
+ }
+ },
"DeleteTableRequest":{
"type":"structure",
"required":[
@@ -6703,6 +7011,7 @@
},
"documentation":"<p>Defines column statistics supported for floating-point number data columns.</p>"
},
+ "DoubleValue":{"type":"double"},
"DynamoDBTarget":{
"type":"structure",
"members":{
@@ -8426,6 +8735,59 @@
}
}
},
+ "GetSessionRequest":{
+ "type":"structure",
+ "required":["Id"],
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>The ID of the session. </p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request. </p>"
+ }
+ }
+ },
+ "GetSessionResponse":{
+ "type":"structure",
+ "members":{
+ "Session":{
+ "shape":"Session",
+ "documentation":"<p>The session object is returned in the response.</p>"
+ }
+ }
+ },
+ "GetStatementRequest":{
+ "type":"structure",
+ "required":[
+ "SessionId",
+ "Id"
+ ],
+ "members":{
+ "SessionId":{
+ "shape":"NameString",
+ "documentation":"<p>The Session ID of the statement.</p>"
+ },
+ "Id":{
+ "shape":"IntegerValue",
+ "documentation":"<p>The Id of the statement.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request.</p>"
+ }
+ }
+ },
+ "GetStatementResponse":{
+ "type":"structure",
+ "members":{
+ "Statement":{
+ "shape":"Statement",
+ "documentation":"<p>Returns the statement.</p>"
+ }
+ }
+ },
"GetTableRequest":{
"type":"structure",
"required":[
@@ -8925,7 +9287,7 @@
"members":{
"Message":{
"shape":"MessageString",
- "documentation":"<p>A message describing the problem.</p>"
+ "documentation":"<p>The message describing the problem.</p>"
}
},
"documentation":"<p>An encryption operation failed.</p>",
@@ -8957,7 +9319,7 @@
"type":"string",
"max":10240,
"min":1,
- "pattern":"arn:aws:glue:.*"
+ "pattern":"arn:(aws|aws-us-gov|aws-cn):glue:.*"
},
"GlueTable":{
"type":"structure",
@@ -9072,6 +9434,17 @@
},
"exception":true
},
+ "IllegalSessionStateException":{
+ "type":"structure",
+ "members":{
+ "Message":{
+ "shape":"MessageString",
+ "documentation":"<p>A message describing the problem.</p>"
+ }
+ },
+ "documentation":"<p>The session is in an invalid state to perform a requested operation.</p>",
+ "exception":true
+ },
"IllegalWorkflowStateException":{
"type":"structure",
"members":{
@@ -9959,6 +10332,69 @@
}
}
},
+ "ListSessionsRequest":{
+ "type":"structure",
+ "members":{
+ "NextToken":{
+ "shape":"OrchestrationToken",
+ "documentation":"<p>The token for the next set of results, or null if there are no more result. </p>"
+ },
+ "MaxResults":{
+ "shape":"PageSize",
+ "documentation":"<p>The maximum number of results. </p>"
+ },
+ "Tags":{
+ "shape":"TagsMap",
+ "documentation":"<p>Tags belonging to the session. </p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request. </p>"
+ }
+ }
+ },
+ "ListSessionsResponse":{
+ "type":"structure",
+ "members":{
+ "Ids":{
+ "shape":"SessionIdList",
+ "documentation":"<p>Returns the Id of the session. </p>"
+ },
+ "Sessions":{
+ "shape":"SessionList",
+ "documentation":"<p>Returns the session object. </p>"
+ },
+ "NextToken":{
+ "shape":"OrchestrationToken",
+ "documentation":"<p>The token for the next set of results, or null if there are no more result. </p>"
+ }
+ }
+ },
+ "ListStatementsRequest":{
+ "type":"structure",
+ "required":["SessionId"],
+ "members":{
+ "SessionId":{
+ "shape":"NameString",
+ "documentation":"<p>The Session ID of the statements.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request to list statements.</p>"
+ },
+ "NextToken":{"shape":"OrchestrationToken"}
+ }
+ },
+ "ListStatementsResponse":{
+ "type":"structure",
+ "members":{
+ "Statements":{
+ "shape":"StatementList",
+ "documentation":"<p>Returns the list of statements.</p>"
+ },
+ "NextToken":{"shape":"OrchestrationToken"}
+ }
+ },
"ListTriggersRequest":{
"type":"structure",
"members":{
@@ -10101,6 +10537,7 @@
},
"documentation":"<p>Defines column statistics supported for integer data columns.</p>"
},
+ "LongValue":{"type":"long"},
"MLTransform":{
"type":"structure",
"members":{
@@ -10471,6 +10908,19 @@
"documentation":"<p>The operation timed out.</p>",
"exception":true
},
+ "OrchestrationArgumentsMap":{
+ "type":"map",
+ "key":{"shape":"OrchestrationNameString"},
+ "value":{"shape":"OrchestrationArgumentsValue"},
+ "max":75,
+ "min":0
+ },
+ "OrchestrationArgumentsValue":{
+ "type":"string",
+ "max":4096,
+ "min":0,
+ "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
+ },
"OrchestrationIAMRoleArn":{
"type":"string",
"max":1024,
@@ -10483,16 +10933,30 @@
"min":1,
"pattern":"[\\.\\-_A-Za-z0-9]+"
},
+ "OrchestrationRoleArn":{
+ "type":"string",
+ "max":2048,
+ "min":20,
+ "pattern":"arn:aws[^:]*:iam::[0-9]*:role/.+"
+ },
"OrchestrationS3Location":{
"type":"string",
"max":8192,
"min":1,
"pattern":"^s3://([^/]+)/([^/]+/)*([^/]+)$"
},
+ "OrchestrationStatementCodeString":{
+ "type":"string",
+ "max":68000
+ },
"OrchestrationStringList":{
"type":"list",
"member":{"shape":"GenericString"}
},
+ "OrchestrationToken":{
+ "type":"string",
+ "max":400000
+ },
"Order":{
"type":"structure",
"required":[
@@ -10782,7 +11246,6 @@
},
"PolicyJsonString":{
"type":"string",
- "max":10240,
"min":2
},
"Predecessor":{
@@ -11362,6 +11825,36 @@
"RoleString":{"type":"string"},
"RowTag":{"type":"string"},
"RunId":{"type":"string"},
+ "RunStatementRequest":{
+ "type":"structure",
+ "required":[
+ "SessionId",
+ "Code"
+ ],
+ "members":{
+ "SessionId":{
+ "shape":"NameString",
+ "documentation":"<p>The Session Id of the statement to be run.</p>"
+ },
+ "Code":{
+ "shape":"OrchestrationStatementCodeString",
+ "documentation":"<p>The statement code to be run.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request.</p>"
+ }
+ }
+ },
+ "RunStatementResponse":{
+ "type":"structure",
+ "members":{
+ "Id":{
+ "shape":"IntegerValue",
+ "documentation":"<p>Returns the Id of the statement that was run.</p>"
+ }
+ }
+ },
"S3Encryption":{
"type":"structure",
"members":{
@@ -11700,7 +12193,10 @@
"DELETING"
]
},
- "ScriptLocationString":{"type":"string"},
+ "ScriptLocationString":{
+ "type":"string",
+ "max":400000
+ },
"SearchPropertyPredicates":{
"type":"list",
"member":{"shape":"PropertyPredicate"}
@@ -11815,6 +12311,97 @@
},
"documentation":"<p>Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.</p>"
},
+ "Session":{
+ "type":"structure",
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>The ID of the session.</p>"
+ },
+ "CreatedOn":{
+ "shape":"TimestampValue",
+ "documentation":"<p>The time and date when the session was created.</p>"
+ },
+ "Status":{
+ "shape":"SessionStatus",
+ "documentation":"<p>The session status. </p>"
+ },
+ "ErrorMessage":{
+ "shape":"DescriptionString",
+ "documentation":"<p>The error message displayed during the session.</p>"
+ },
+ "Description":{
+ "shape":"DescriptionString",
+ "documentation":"<p>The description of the session.</p>"
+ },
+ "Role":{
+ "shape":"OrchestrationRoleArn",
+ "documentation":"<p>The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.</p>"
+ },
+ "Command":{
+ "shape":"SessionCommand",
+ "documentation":"<p>The command object.See SessionCommand.</p>"
+ },
+ "DefaultArguments":{
+ "shape":"OrchestrationArgumentsMap",
+ "documentation":"<p>A map array of key-value pairs. Max is 75 pairs. </p>"
+ },
+ "Connections":{
+ "shape":"ConnectionsList",
+ "documentation":"<p>The number of connections used for the session.</p>"
+ },
+ "Progress":{
+ "shape":"DoubleValue",
+ "documentation":"<p>The code execution progress of the session.</p>"
+ },
+ "MaxCapacity":{
+ "shape":"NullableDouble",
+ "documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory. </p>"
+ },
+ "SecurityConfiguration":{
+ "shape":"NameString",
+ "documentation":"<p>The name of the SecurityConfiguration structure to be used with the session.</p>"
+ },
+ "GlueVersion":{
+ "shape":"GlueVersionString",
+ "documentation":"<p>The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The GlueVersion must be greater than 2.0.</p>"
+ }
+ },
+ "documentation":"<p>The period in which a remote Spark runtime environment is running.</p>"
+ },
+ "SessionCommand":{
+ "type":"structure",
+ "members":{
+ "Name":{
+ "shape":"NameString",
+ "documentation":"<p>Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.</p>"
+ },
+ "PythonVersion":{
+ "shape":"PythonVersionString",
+ "documentation":"<p>Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.</p>"
+ }
+ },
+ "documentation":"<p>The <code>SessionCommand</code> that runs the job.</p>"
+ },
+ "SessionIdList":{
+ "type":"list",
+ "member":{"shape":"NameString"}
+ },
+ "SessionList":{
+ "type":"list",
+ "member":{"shape":"Session"}
+ },
+ "SessionStatus":{
+ "type":"string",
+ "enum":[
+ "PROVISIONING",
+ "READY",
+ "FAILED",
+ "TIMEOUT",
+ "STOPPING",
+ "STOPPED"
+ ]
+ },
"SkewedInfo":{
"type":"structure",
"members":{
@@ -12141,6 +12728,95 @@
},
"documentation":"<p>The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow member is non-zero.</p>"
},
+ "Statement":{
+ "type":"structure",
+ "members":{
+ "Id":{
+ "shape":"IntegerValue",
+ "documentation":"<p>The ID of the statement.</p>"
+ },
+ "Code":{
+ "shape":"GenericString",
+ "documentation":"<p>The execution code of the statement.</p>"
+ },
+ "State":{
+ "shape":"StatementState",
+ "documentation":"<p>The state while request is actioned.</p>"
+ },
+ "Output":{
+ "shape":"StatementOutput",
+ "documentation":"<p>The output in JSON.</p>"
+ },
+ "Progress":{
+ "shape":"DoubleValue",
+ "documentation":"<p>The code execution progress.</p>"
+ },
+ "StartedOn":{
+ "shape":"LongValue",
+ "documentation":"<p>The unix time and date that the job definition was started.</p>"
+ },
+ "CompletedOn":{
+ "shape":"LongValue",
+ "documentation":"<p>The unix time and date that the job definition was completed.</p>"
+ }
+ },
+ "documentation":"<p>The statement or request for a particular action to occur in a session.</p>"
+ },
+ "StatementList":{
+ "type":"list",
+ "member":{"shape":"Statement"}
+ },
+ "StatementOutput":{
+ "type":"structure",
+ "members":{
+ "Data":{
+ "shape":"StatementOutputData",
+ "documentation":"<p>The code execution output.</p>"
+ },
+ "ExecutionCount":{
+ "shape":"IntegerValue",
+ "documentation":"<p>The execution count of the output.</p>"
+ },
+ "Status":{
+ "shape":"StatementState",
+ "documentation":"<p>The status of the code execution output.</p>"
+ },
+ "ErrorName":{
+ "shape":"GenericString",
+ "documentation":"<p>The name of the error in the output.</p>"
+ },
+ "ErrorValue":{
+ "shape":"GenericString",
+ "documentation":"<p>The error value of the output.</p>"
+ },
+ "Traceback":{
+ "shape":"OrchestrationStringList",
+ "documentation":"<p>The traceback of the output.</p>"
+ }
+ },
+ "documentation":"<p>The code execution output in JSON format.</p>"
+ },
+ "StatementOutputData":{
+ "type":"structure",
+ "members":{
+ "TextPlain":{
+ "shape":"GenericString",
+ "documentation":"<p>The code execution output in text format.</p>"
+ }
+ },
+ "documentation":"<p>The code execution output in JSON format.</p>"
+ },
+ "StatementState":{
+ "type":"string",
+ "enum":[
+ "WAITING",
+ "RUNNING",
+ "AVAILABLE",
+ "CANCELLING",
+ "CANCELLED",
+ "ERROR"
+ ]
+ },
"StopCrawlerRequest":{
"type":"structure",
"required":["Name"],
@@ -12171,6 +12847,29 @@
"members":{
}
},
+ "StopSessionRequest":{
+ "type":"structure",
+ "required":["Id"],
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>The ID of the session to be stopped.</p>"
+ },
+ "RequestOrigin":{
+ "shape":"OrchestrationNameString",
+ "documentation":"<p>The origin of the request.</p>"
+ }
+ }
+ },
+ "StopSessionResponse":{
+ "type":"structure",
+ "members":{
+ "Id":{
+ "shape":"NameString",
+ "documentation":"<p>Returns the Id of the stopped session.</p>"
+ }
+ }
+ },
"StopTriggerRequest":{
"type":"structure",
"required":["Name"],
@@ -12382,7 +13081,8 @@
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which the table resides.</p>"
- }
+ },
+ "VersionId":{"shape":"VersionString"}
},
"documentation":"<p>Represents a collection of related data organized in columns and rows.</p>"
},
@@ -13638,7 +14338,8 @@
"TransactionId":{
"shape":"TransactionIdString",
"documentation":"<p>The transaction ID at which to update the table contents. </p>"
- }
+ },
+ "VersionId":{"shape":"VersionString"}
}
},
"UpdateTableResponse":{
diff --git a/contrib/python/botocore/py3/botocore/data/greengrassv2/2020-11-30/service-2.json b/contrib/python/botocore/py3/botocore/data/greengrassv2/2020-11-30/service-2.json
index 9eb0e5903e..1e5aedfb37 100644
--- a/contrib/python/botocore/py3/botocore/data/greengrassv2/2020-11-30/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/greengrassv2/2020-11-30/service-2.json
@@ -117,7 +117,7 @@
{"shape":"InternalServerException"},
{"shape":"RequestAlreadyInProgressException"}
],
- "documentation":"<p>Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.</p> <p>You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.</p> <p>Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html\">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"
+ "documentation":"<p>Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.</p> <p>You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.</p> <p>Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html\">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"
},
"DeleteComponent":{
"name":"DeleteComponent",
@@ -233,7 +233,7 @@
{"shape":"ValidationException"},
{"shape":"InternalServerException"}
],
- "documentation":"<p>Retrieves connectivity information for a Greengrass core device.</p> <p>Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html\">Greengrass discovery API</a>, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html\">Connect client devices to core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>"
+ "documentation":"<p>Retrieves connectivity information for a Greengrass core device.</p> <p>Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html\">IoT Greengrass discovery API</a>, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html\">Connect client devices to core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>"
},
"GetCoreDevice":{
"name":"GetCoreDevice",
@@ -476,7 +476,7 @@
{"shape":"ValidationException"},
{"shape":"InternalServerException"}
],
- "documentation":"<p>Updates connectivity information for a Greengrass core device.</p> <p>Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html\">Greengrass discovery API</a>, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html\">Connect client devices to core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>"
+ "documentation":"<p>Updates connectivity information for a Greengrass core device.</p> <p>Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html\">IoT Greengrass discovery API</a>, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html\">Connect client devices to core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>"
}
},
"shapes":{
diff --git a/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json b/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json
index 28a87373e4..0732a4a5e1 100644
--- a/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json
@@ -856,7 +856,7 @@
{"shape":"NoSuchEntityException"},
{"shape":"InvalidInputException"}
],
- "documentation":"<p>Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for the last 365 days, or less if your Region began supporting this feature within the last year. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period\">Regions where data is tracked</a>.</p> <important> <p>The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html\">Logging IAM events with CloudTrail</a> in the <i>IAM User Guide</i>.</p> </important> <p>The <code>GenerateServiceLastAccessedDetails</code> operation returns a <code>JobId</code>. Use this parameter in the following operations to retrieve the following details from your report: </p> <ul> <li> <p> <a>GetServiceLastAccessedDetails</a> – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.</p> <p>The <code>JobId</code> returned by <code>GenerateServiceLastAccessedDetail</code> must be used by the same role within a session, or by the same user when used to call <code>GetServiceLastAccessedDetail</code>.</p> </li> <li> <p> <a>GetServiceLastAccessedDetailsWithEntities</a> – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service. </p> </li> </ul> <p>To check the status of the <code>GenerateServiceLastAccessedDetails</code> request, use the <code>JobId</code> parameter in the same operations and test the <code>JobStatus</code> response parameter.</p> <p>For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the <a>ListPoliciesGrantingServiceAccess</a> operation.</p> <note> <p>Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics\">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For more information about service and action last accessed data, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html\">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p>"
+ "documentation":"<p>Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period\">Regions where data is tracked</a>.</p> <important> <p>The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html\">Logging IAM events with CloudTrail</a> in the <i>IAM User Guide</i>.</p> </important> <p>The <code>GenerateServiceLastAccessedDetails</code> operation returns a <code>JobId</code>. Use this parameter in the following operations to retrieve the following details from your report: </p> <ul> <li> <p> <a>GetServiceLastAccessedDetails</a> – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.</p> <p>The <code>JobId</code> returned by <code>GenerateServiceLastAccessedDetail</code> must be used by the same role within a session, or by the same user when used to call <code>GetServiceLastAccessedDetail</code>.</p> </li> <li> <p> <a>GetServiceLastAccessedDetailsWithEntities</a> – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service. </p> </li> </ul> <p>To check the status of the <code>GenerateServiceLastAccessedDetails</code> request, use the <code>JobId</code> parameter in the same operations and test the <code>JobStatus</code> response parameter.</p> <p>For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the <a>ListPoliciesGrantingServiceAccess</a> operation.</p> <note> <p>Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics\">Evaluating policies</a> in the <i>IAM User Guide</i>.</p> </note> <p>For more information about service and action last accessed data, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html\">Reducing permissions using service last accessed data</a> in the <i>IAM User Guide</i>.</p>"
},
"GetAccessKeyLastUsed":{
"name":"GetAccessKeyLastUsed",
@@ -1853,7 +1853,7 @@
"shape":"ListVirtualMFADevicesResponse",
"resultWrapper":"ListVirtualMFADevicesResult"
},
- "documentation":"<p>Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a virtual MFA device, see <a>ListVirtualMFADevices</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>"
+ "documentation":"<p>Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>.</p> <note> <p>IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see <a>ListMFADeviceTags</a>.</p> </note> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>"
},
"PutGroupPolicy":{
"name":"PutGroupPolicy",
@@ -2341,7 +2341,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceFailureException"}
],
- "documentation":"<p>Updates the password policy settings for the Amazon Web Services account.</p> <note> <ul> <li> <p>This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.</p> </li> </ul> </note> <p> For more information about using a password policy, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an IAM password policy</a> in the <i>IAM User Guide</i>.</p>"
+ "documentation":"<p>Updates the password policy settings for the Amazon Web Services account.</p> <note> <p>This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.</p> </note> <p> For more information about using a password policy, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an IAM password policy</a> in the <i>IAM User Guide</i>.</p>"
},
"UpdateAssumeRolePolicy":{
"name":"UpdateAssumeRolePolicy",
@@ -6454,7 +6454,7 @@
},
"AllowUsersToChangePassword":{
"shape":"booleanType",
- "documentation":"<p>Specifies whether IAM users are allowed to change their own password.</p>"
+ "documentation":"<p>Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to <code>iam:ChangePassword</code> for only their user and to the <code>iam:GetAccountPasswordPolicy</code> action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.</p>"
},
"ExpirePasswords":{
"shape":"booleanType",
@@ -6470,7 +6470,7 @@
},
"HardExpiry":{
"shape":"booleanObjectType",
- "documentation":"<p>Specifies whether IAM users are prevented from setting a new password after their password has expired.</p>"
+ "documentation":"<p>Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with <code>iam:ChangePassword</code> permission and active access keys can reset their own expired console password using the CLI or API.</p>"
}
},
"documentation":"<p>Contains information about the account password policy.</p> <p> This data type is used as a response element in the <a>GetAccountPasswordPolicy</a> operation. </p>"
@@ -8085,7 +8085,7 @@
},
"AllowUsersToChangePassword":{
"shape":"booleanType",
- "documentation":"<p> Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html\">Letting IAM users change their own passwords</a> in the <i>IAM User Guide</i>.</p> <p>If you do not specify a value for this parameter, then the operation uses the default value of <code>false</code>. The result is that IAM users in the account do not automatically have permissions to change their own password.</p>"
+ "documentation":"<p> Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_enable-user-change.html\">Permitting IAM users to change their own passwords</a> in the <i>IAM User Guide</i>.</p> <p>If you do not specify a value for this parameter, then the operation uses the default value of <code>false</code>. The result is that IAM users in the account do not automatically have permissions to change their own password.</p>"
},
"MaxPasswordAge":{
"shape":"maxPasswordAgeType",
@@ -8097,7 +8097,7 @@
},
"HardExpiry":{
"shape":"booleanObjectType",
- "documentation":"<p>Prevents IAM users from setting a new password after their password has expired. The IAM user cannot be accessed until an administrator resets the password.</p> <p>If you do not specify a value for this parameter, then the operation uses the default value of <code>false</code>. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.</p>"
+ "documentation":"<p> Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.</p> <p>If you do not specify a value for this parameter, then the operation uses the default value of <code>false</code>. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.</p> <note> <p> In the Amazon Web Services Management Console, the custom password policy option <b>Allow users to change their own password</b> gives IAM users permissions to <code>iam:ChangePassword</code> for only their user and to the <code>iam:GetAccountPasswordPolicy</code> action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with <code>iam:ChangePassword</code> permission and active access keys can reset their own expired console password using the CLI or API.</p> </note>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/imagebuilder/2019-12-02/service-2.json b/contrib/python/botocore/py3/botocore/data/imagebuilder/2019-12-02/service-2.json
index 6ededb45af..ae29e3c251 100644
--- a/contrib/python/botocore/py3/botocore/data/imagebuilder/2019-12-02/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/imagebuilder/2019-12-02/service-2.json
@@ -54,7 +54,7 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"ServiceQuotaExceededException"}
],
- "documentation":"<p>Creates a new component that can be used to build, validate, test, and assess your image.</p>"
+ "documentation":"<p>Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:</p> <ul> <li> <p>Inline, using the <code>data</code> property in the request body.</p> </li> <li> <p>A URL that points to a YAML document file stored in Amazon S3, using the <code>uri</code> property in the request body.</p> </li> </ul>"
},
"CreateContainerRecipe":{
"name":"CreateContainerRecipe",
@@ -997,7 +997,7 @@
},
"userDataOverride":{
"shape":"UserDataOverride",
- "documentation":"<p>Use this property to provide commands or a command script to run when you launch your build instance.</p> <note> <p>The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.</p> </note>"
+ "documentation":"<p>Use this property to provide commands or a command script to run when you launch your build instance.</p> <p>The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.</p> <note> <p>The user data is always base 64 encoded. For example, the following commands are encoded as <code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</code>:</p> <p> <i>#!/bin/bash</i> </p> <p>mkdir -p /var/bb/</p> <p>touch /var</p> </note>"
}
},
"documentation":"<p>In addition to your infrastruction configuration, these settings provide an extra layer of control over your build instances. For instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create. You can also specify commands to run on launch for all of your build instances.</p>"
@@ -1186,7 +1186,7 @@
},
"data":{
"shape":"ComponentData",
- "documentation":"<p>The data of the component.</p>"
+ "documentation":"<p>Component data contains the YAML document content for the component.</p>"
},
"kmsKeyId":{
"shape":"NonEmptyString",
@@ -1653,11 +1653,11 @@
},
"data":{
"shape":"InlineComponentData",
- "documentation":"<p>The data of the component. Used to specify the data inline. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>"
+ "documentation":"<p>Component <code>data</code> contains inline YAML document content for the component. Alternatively, you can specify the <code>uri</code> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</p>"
},
"uri":{
"shape":"Uri",
- "documentation":"<p>The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>"
+ "documentation":"<p>The <code>uri</code> of a YAML component document file. This must be an S3 URL (<code>s3://bucket/key</code>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</p> <p>Alternatively, you can specify the YAML document inline, using the component <code>data</code> property. You cannot specify both properties.</p>"
},
"kmsKeyId":{
"shape":"NonEmptyString",
@@ -2335,6 +2335,10 @@
"s3ExportConfiguration":{
"shape":"S3ExportConfiguration",
"documentation":"<p>Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.</p>"
+ },
+ "fastLaunchConfigurations":{
+ "shape":"FastLaunchConfigurationList",
+ "documentation":"<p>The Windows faster-launching configurations to use for AMI distribution.</p>"
}
},
"documentation":"<p> Defines the settings for a specific Region.</p>"
@@ -2501,6 +2505,67 @@
"min":0
},
"ErrorMessage":{"type":"string"},
+ "FastLaunchConfiguration":{
+ "type":"structure",
+ "required":["enabled"],
+ "members":{
+ "enabled":{
+ "shape":"Boolean",
+ "documentation":"<p>A Boolean that represents the current state of faster launching for the Windows AMI. Set to <code>true</code> to start using Windows faster launching, or <code>false</code> to stop using it.</p>"
+ },
+ "snapshotConfiguration":{
+ "shape":"FastLaunchSnapshotConfiguration",
+ "documentation":"<p>Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.</p>"
+ },
+ "maxParallelLaunches":{
+ "shape":"MaxParallelLaunches",
+ "documentation":"<p>The maximum number of parallel instances that are launched for creating resources.</p>"
+ },
+ "launchTemplate":{
+ "shape":"FastLaunchLaunchTemplateSpecification",
+ "documentation":"<p>The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.</p>"
+ },
+ "accountId":{
+ "shape":"AccountId",
+ "documentation":"<p>The owner account ID for the fast-launch enabled Windows AMI.</p>"
+ }
+ },
+ "documentation":"<p>Define and configure faster launching for output Windows AMIs.</p>"
+ },
+ "FastLaunchConfigurationList":{
+ "type":"list",
+ "member":{"shape":"FastLaunchConfiguration"},
+ "max":1000,
+ "min":1
+ },
+ "FastLaunchLaunchTemplateSpecification":{
+ "type":"structure",
+ "members":{
+ "launchTemplateId":{
+ "shape":"LaunchTemplateId",
+ "documentation":"<p>The ID of the launch template to use for faster launching for a Windows AMI.</p>"
+ },
+ "launchTemplateName":{
+ "shape":"NonEmptyString",
+ "documentation":"<p>The name of the launch template to use for faster launching for a Windows AMI.</p>"
+ },
+ "launchTemplateVersion":{
+ "shape":"NonEmptyString",
+ "documentation":"<p>The version of the launch template to use for faster launching for a Windows AMI.</p>"
+ }
+ },
+ "documentation":"<p>Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.</p> <note> <p>You can specify either the <code>launchTemplateName</code> or the <code>launchTemplateId</code>, but not both.</p> </note>"
+ },
+ "FastLaunchSnapshotConfiguration":{
+ "type":"structure",
+ "members":{
+ "targetResourceCount":{
+ "shape":"TargetResourceCount",
+ "documentation":"<p>The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.</p>"
+ }
+ },
+ "documentation":"<p>Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.</p>"
+ },
"Filter":{
"type":"structure",
"members":{
@@ -4210,6 +4275,11 @@
},
"documentation":"<p>Logging configuration defines where Image Builder uploads your logs.</p>"
},
+ "MaxParallelLaunches":{
+ "type":"integer",
+ "max":10000,
+ "min":1
+ },
"NonEmptyString":{
"type":"string",
"max":1024,
@@ -4683,6 +4753,11 @@
},
"documentation":"<p>The container repository where the output container image is stored.</p>"
},
+ "TargetResourceCount":{
+ "type":"integer",
+ "max":10000,
+ "min":1
+ },
"Timezone":{
"type":"string",
"max":100,
diff --git a/contrib/python/botocore/py3/botocore/data/kafkaconnect/2021-09-14/service-2.json b/contrib/python/botocore/py3/botocore/data/kafkaconnect/2021-09-14/service-2.json
index aeb4cae4b6..2d3b248f26 100644
--- a/contrib/python/botocore/py3/botocore/data/kafkaconnect/2021-09-14/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/kafkaconnect/2021-09-14/service-2.json
@@ -97,6 +97,27 @@
"documentation":"<p>Deletes the specified connector.</p>",
"idempotent":true
},
+ "DeleteCustomPlugin":{
+ "name":"DeleteCustomPlugin",
+ "http":{
+ "method":"DELETE",
+ "requestUri":"/v1/custom-plugins/{customPluginArn}",
+ "responseCode":200
+ },
+ "input":{"shape":"DeleteCustomPluginRequest"},
+ "output":{"shape":"DeleteCustomPluginResponse"},
+ "errors":[
+ {"shape":"NotFoundException"},
+ {"shape":"BadRequestException"},
+ {"shape":"ForbiddenException"},
+ {"shape":"ServiceUnavailableException"},
+ {"shape":"TooManyRequestsException"},
+ {"shape":"UnauthorizedException"},
+ {"shape":"InternalServerErrorException"}
+ ],
+ "documentation":"<p>Deletes a custom plugin.</p>",
+ "idempotent":true
+ },
"DescribeConnector":{
"name":"DescribeConnector",
"http":{
@@ -552,7 +573,7 @@
"documentation":"<p>Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.</p>"
},
"connectorConfiguration":{
- "shape":"__mapOf__string",
+ "shape":"SyntheticCreateConnectorRequest__mapOf__string",
"documentation":"<p>A map of keys to values that represent the configuration for the connector.</p>"
},
"connectorDescription":{
@@ -677,7 +698,7 @@
"documentation":"<p>The name of the worker configuration.</p>"
},
"propertiesFileContent":{
- "shape":"__string",
+ "shape":"SyntheticCreateWorkerConfigurationRequest__string",
"documentation":"<p>Base64 encoded contents of connect-distributed.properties file.</p>"
}
}
@@ -879,6 +900,31 @@
}
}
},
+ "DeleteCustomPluginRequest":{
+ "type":"structure",
+ "required":["customPluginArn"],
+ "members":{
+ "customPluginArn":{
+ "shape":"__string",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the custom plugin that you want to delete.</p>",
+ "location":"uri",
+ "locationName":"customPluginArn"
+ }
+ }
+ },
+ "DeleteCustomPluginResponse":{
+ "type":"structure",
+ "members":{
+ "customPluginArn":{
+ "shape":"__string",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the custom plugin that you requested to delete.</p>"
+ },
+ "customPluginState":{
+ "shape":"CustomPluginState",
+ "documentation":"<p>The state of the custom plugin.</p>"
+ }
+ }
+ },
"DescribeConnectorRequest":{
"type":"structure",
"required":["connectorArn"],
@@ -903,7 +949,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) of the connector.</p>"
},
"connectorConfiguration":{
- "shape":"__mapOf__string",
+ "shape":"SyntheticDescribeConnectorResponse__mapOf__string",
"documentation":"<p>A map of keys to values that represent the configuration for the connector.</p>"
},
"connectorDescription":{
@@ -954,6 +1000,10 @@
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.</p>"
},
+ "stateDescription":{
+ "shape":"StateDescription",
+ "documentation":"<p>Details about the state of a connector.</p>"
+ },
"workerConfiguration":{
"shape":"WorkerConfigurationDescription",
"documentation":"<p>Specifies which worker configuration was used for the connector.</p>"
@@ -998,6 +1048,10 @@
"name":{
"shape":"__string",
"documentation":"<p>The name of the custom plugin.</p>"
+ },
+ "stateDescription":{
+ "shape":"StateDescription",
+ "documentation":"<p>Details about the state of a custom plugin.</p>"
}
}
},
@@ -1522,6 +1576,40 @@
"exception":true,
"fault":true
},
+ "StateDescription":{
+ "type":"structure",
+ "members":{
+ "code":{
+ "shape":"__string",
+ "documentation":"<p>A code that describes the state of a resource.</p>"
+ },
+ "message":{
+ "shape":"__string",
+ "documentation":"<p>A message that describes the state of a resource.</p>"
+ }
+ },
+ "documentation":"<p>Details about the state of a resource.</p>"
+ },
+ "SyntheticCreateConnectorRequest__mapOf__string":{
+ "type":"map",
+ "key":{"shape":"__string"},
+ "value":{"shape":"__string"},
+ "sensitive":true
+ },
+ "SyntheticCreateWorkerConfigurationRequest__string":{
+ "type":"string",
+ "sensitive":true
+ },
+ "SyntheticDescribeConnectorResponse__mapOf__string":{
+ "type":"map",
+ "key":{"shape":"__string"},
+ "value":{"shape":"__string"},
+ "sensitive":true
+ },
+ "SyntheticWorkerConfigurationRevisionDescription__string":{
+ "type":"string",
+ "sensitive":true
+ },
"TooManyRequestsException":{
"type":"structure",
"members":{
@@ -1658,7 +1746,7 @@
"documentation":"<p>The description of the worker configuration revision.</p>"
},
"propertiesFileContent":{
- "shape":"__string",
+ "shape":"SyntheticWorkerConfigurationRevisionDescription__string",
"documentation":"<p>Base64 encoded contents of the connect-distributed.properties file.</p>"
},
"revision":{
@@ -1795,11 +1883,6 @@
"max":9223372036854775807,
"min":1
},
- "__mapOf__string":{
- "type":"map",
- "key":{"shape":"__string"},
- "value":{"shape":"__string"}
- },
"__string":{"type":"string"},
"__stringMax1024":{
"type":"string",
diff --git a/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json b/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json
index 4d6793743d..5b79ebb374 100644
--- a/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/kendra/2019-02-03/service-2.json
@@ -1512,10 +1512,10 @@
},
"AttachmentFieldMappings":{
"shape":"ConfluenceAttachmentFieldMappingsList",
- "documentation":"<p>Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the <code>UpdateIndex</code> API.</p> <p>If you specify the <code>AttachentFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
+ "documentation":"<p>Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p> <p>If you specify the <code>AttachentFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
}
},
- "documentation":"<p>Specifies the attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.</p>"
+ "documentation":"<p>Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.</p>"
},
"ConfluenceAttachmentFieldMappingsList":{
"type":"list",
@@ -1555,17 +1555,17 @@
"documentation":"<p>The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.</p>"
}
},
- "documentation":"<p>Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.</p> <p>You must first create the index field using the <code>UpdateIndex</code> API. </p>"
+ "documentation":"<p>Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confuence data source field names must exist in your Confluence custom metadata.</p>"
},
"ConfluenceBlogConfiguration":{
"type":"structure",
"members":{
"BlogFieldMappings":{
"shape":"ConfluenceBlogFieldMappingsList",
- "documentation":"<p>Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the <code>UpdateIndex</code> API.</p> <p>If you specify the <code>BlogFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
+ "documentation":"<p>Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p> <p>If you specify the <code>BlogFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
}
},
- "documentation":"<p>Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the <code>ExclusionPatterns</code> or <code>InclusionPatterns</code> fields in the <code>ConfluenceConfiguration</code> object.</p>"
+ "documentation":"<p>Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the <code>ExclusionPatterns</code> or <code>InclusionPatterns</code> fields in the <code>ConfluenceConfiguration</code> object.</p>"
},
"ConfluenceBlogFieldMappingsList":{
"type":"list",
@@ -1603,7 +1603,7 @@
"documentation":"<p>The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.</p>"
}
},
- "documentation":"<p>Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.</p> <p>You must first create the index field using the <code>UpdateIndex</code> API. </p>"
+ "documentation":"<p>Maps attributes or field names of Confluence blog to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p>"
},
"ConfluenceConfiguration":{
"type":"structure",
@@ -1615,11 +1615,11 @@
"members":{
"ServerUrl":{
"shape":"Url",
- "documentation":"<p>The URL of your Confluence instance. Use the full URL of the server. For example, <code>https://server.example.com:port/</code>. You can also use an IP address, for example, <code>https://192.168.1.113/</code>.</p>"
+ "documentation":"<p>The URL of your Confluence instance. Use the full URL of the server. For example, <i>https://server.example.com:port/</i>. You can also use an IP address, for example, <i>https://192.168.1.113/</i>.</p>"
},
"SecretArn":{
"shape":"SecretArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>username - The user name or email address of a user with administrative privileges for the Confluence server.</p> </li> <li> <p>password - The password associated with the user logging in to the Confluence server.</p> </li> </ul>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>username—The user name or email address of a user with administrative privileges for the Confluence server.</p> </li> <li> <p>password—The password associated with the user logging in to the Confluence server.</p> </li> </ul>"
},
"Version":{
"shape":"ConfluenceVersion",
@@ -1627,44 +1627,44 @@
},
"SpaceConfiguration":{
"shape":"ConfluenceSpaceConfiguration",
- "documentation":"<p>Specifies configuration information for indexing Confluence spaces.</p>"
+ "documentation":"<p>Configuration information for indexing Confluence spaces.</p>"
},
"PageConfiguration":{
"shape":"ConfluencePageConfiguration",
- "documentation":"<p>Specifies configuration information for indexing Confluence pages.</p>"
+ "documentation":"<p>Configuration information for indexing Confluence pages.</p>"
},
"BlogConfiguration":{
"shape":"ConfluenceBlogConfiguration",
- "documentation":"<p> Specifies configuration information for indexing Confluence blogs.</p>"
+ "documentation":"<p>Configuration information for indexing Confluence blogs.</p>"
},
"AttachmentConfiguration":{
"shape":"ConfluenceAttachmentConfiguration",
- "documentation":"<p>Specifies configuration information for indexing attachments to Confluence blogs and pages.</p>"
+ "documentation":"<p>Configuration information for indexing attachments to Confluence blogs and pages.</p>"
},
"VpcConfiguration":{
"shape":"DataSourceVpcConfiguration",
- "documentation":"<p>Specifies the information for connecting to an Amazon VPC.</p>"
+ "documentation":"<p>Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html\">Configuring a VPC</a>.</p>"
},
"InclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.</p>"
},
"ExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.</p>"
+ "documentation":"<p>&gt;A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.</p>"
}
},
- "documentation":"<p>Provides configuration information for data sources that connect to Confluence.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Confluence as your data source.</p>"
},
"ConfluencePageConfiguration":{
"type":"structure",
"members":{
"PageFieldMappings":{
"shape":"ConfluencePageFieldMappingsList",
- "documentation":"<p>Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the <code>UpdateIndex</code> API.</p> <p>If you specify the <code>PageFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
+ "documentation":"<p>&gt;Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p> <p>If you specify the <code>PageFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
}
},
- "documentation":"<p>Specifies the page settings for the Confluence data source.</p>"
+ "documentation":"<p>Configuration of the page settings for the Confluence data source.</p>"
},
"ConfluencePageFieldMappingsList":{
"type":"list",
@@ -1694,7 +1694,7 @@
"members":{
"DataSourceFieldName":{
"shape":"ConfluencePageFieldName",
- "documentation":"<p>The name of the field in the data source. </p>"
+ "documentation":"<p>The name of the field in the data source.</p>"
},
"DateFieldFormat":{
"shape":"DataSourceDateFieldFormat",
@@ -1705,7 +1705,7 @@
"documentation":"<p>The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.</p>"
}
},
- "documentation":"<p>Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.</p> <p>You must first create the index field using the <code>UpdateIndex</code> API.</p>"
+ "documentation":"<p>&gt;Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p>"
},
"ConfluenceSpaceConfiguration":{
"type":"structure",
@@ -1728,10 +1728,10 @@
},
"SpaceFieldMappings":{
"shape":"ConfluenceSpaceFieldMappingsList",
- "documentation":"<p>Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the <code>UpdateIndex</code> API.</p> <p>If you specify the <code>SpaceFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
+ "documentation":"<p>Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p> <p>If you specify the <code>SpaceFieldMappings</code> parameter, you must specify at least one field mapping.</p>"
}
},
- "documentation":"<p>Specifies the configuration for indexing Confluence spaces.</p>"
+ "documentation":"<p>Configuration information for indexing Confluence spaces.</p>"
},
"ConfluenceSpaceFieldMappingsList":{
"type":"list",
@@ -1775,7 +1775,7 @@
"documentation":"<p>The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.</p>"
}
},
- "documentation":"<p>Defines the mapping between a field in the Confluence data source to an Amazon Kendra index field.</p> <p>You must first create the index field using the <code>UpdateIndex</code> API.</p>"
+ "documentation":"<p>&gt;Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p>"
},
"ConfluenceVersion":{
"type":"string",
@@ -1815,7 +1815,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html\">Using a Database Data Source</a>. For more information about Secrets Manager, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html\"> What Is Secrets Manager</a> in the <i> Secrets Manager </i> user guide.</p>"
}
},
- "documentation":"<p>Provides the information necessary to connect to a database.</p>"
+ "documentation":"<p>Provides the configuration information that's required to connect to a database.</p>"
},
"ContentSourceConfiguration":{
"type":"structure",
@@ -1833,7 +1833,7 @@
"documentation":"<p> <code>TRUE</code> to use documents you indexed directly using the <code>BatchPutDocument</code> API.</p>"
}
},
- "documentation":"<p>Configuration information for your content sources, such as data sources, FAQs, and content indexed directly via <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html\">BatchPutDocument</a>.</p>"
+ "documentation":"<p>Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html\">BatchPutDocument</a>.</p>"
},
"ContentType":{
"type":"string",
@@ -1845,6 +1845,32 @@
"PPT"
]
},
+ "Correction":{
+ "type":"structure",
+ "members":{
+ "BeginOffset":{
+ "shape":"Integer",
+ "documentation":"<p>The zero-based location in the response string or text where the corrected word starts.</p>"
+ },
+ "EndOffset":{
+ "shape":"Integer",
+ "documentation":"<p>The zero-based location in the response string or text where the corrected word ends.</p>"
+ },
+ "Term":{
+ "shape":"String",
+ "documentation":"<p>The string or text of a misspelled word in a query.</p>"
+ },
+ "CorrectedTerm":{
+ "shape":"String",
+ "documentation":"<p>The string or text of a corrected misspelled word in a query.</p>"
+ }
+ },
+ "documentation":"<p>A corrected misspelled word in a query.</p>"
+ },
+ "CorrectionList":{
+ "type":"list",
+ "member":{"shape":"Correction"}
+ },
"CrawlDepth":{
"type":"integer",
"max":10,
@@ -1872,7 +1898,7 @@
},
"Configuration":{
"shape":"DataSourceConfiguration",
- "documentation":"<p>The connector configuration information that is required to access the repository.</p> <p>You can't specify the <code>Configuration</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception.</p> <p>The <code>Configuration</code> parameter is required for all other data sources.</p>"
+ "documentation":"<p>Configuration information that is required to access the data source repository.</p> <p>You can't specify the <code>Configuration</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception.</p> <p>The <code>Configuration</code> parameter is required for all other data sources.</p>"
},
"Description":{
"shape":"Description",
@@ -1936,7 +1962,7 @@
},
"Configuration":{
"shape":"ExperienceConfiguration",
- "documentation":"<p>Provides the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>"
+ "documentation":"<p>Configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>"
},
"Description":{
"shape":"Description",
@@ -2200,35 +2226,35 @@
"members":{
"S3Configuration":{
"shape":"S3DataSourceConfiguration",
- "documentation":"<p>Provides information to create a data source connector for a document repository in an Amazon S3 bucket.</p>"
+ "documentation":"<p>Provides the configuration information to connect to an Amazon S3 bucket as your data source.</p>"
},
"SharePointConfiguration":{
"shape":"SharePointConfiguration",
- "documentation":"<p>Provides information necessary to create a data source connector for a Microsoft SharePoint site.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Microsoft SharePoint as your data source.</p>"
},
"DatabaseConfiguration":{
"shape":"DatabaseConfiguration",
- "documentation":"<p>Provides information necessary to create a data source connector for a database.</p>"
+ "documentation":"<p>Provides the configuration information to connect to a database as your data source.</p>"
},
"SalesforceConfiguration":{
"shape":"SalesforceConfiguration",
- "documentation":"<p>Provides configuration information for data sources that connect to a Salesforce site.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Salesforce as your data source.</p>"
},
"OneDriveConfiguration":{
"shape":"OneDriveConfiguration",
- "documentation":"<p>Provides configuration for data sources that connect to Microsoft OneDrive.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Microsoft OneDrive as your data source.</p>"
},
"ServiceNowConfiguration":{
"shape":"ServiceNowConfiguration",
- "documentation":"<p>Provides configuration for data sources that connect to ServiceNow instances.</p>"
+ "documentation":"<p>Provides the configuration information to connect to ServiceNow as your data source.</p>"
},
"ConfluenceConfiguration":{
"shape":"ConfluenceConfiguration",
- "documentation":"<p>Provides configuration information for connecting to a Confluence data source.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Confluence as your data source.</p>"
},
"GoogleDriveConfiguration":{
"shape":"GoogleDriveConfiguration",
- "documentation":"<p>Provides configuration for data sources that connect to Google Drive. </p>"
+ "documentation":"<p>Provides the configuration information to connect to Google Drive as your data source.</p>"
},
"WebCrawlerConfiguration":{"shape":"WebCrawlerConfiguration"},
"WorkDocsConfiguration":{
@@ -2238,9 +2264,13 @@
"FsxConfiguration":{
"shape":"FsxConfiguration",
"documentation":"<p>Provides the configuration information to connect to Amazon FSx as your data source.</p>"
+ },
+ "SlackConfiguration":{
+ "shape":"SlackConfiguration",
+ "documentation":"<p>Provides the configuration information to connect to Slack as your data source.</p>"
}
},
- "documentation":"<p>Configuration information for an Amazon Kendra data source.</p>"
+ "documentation":"<p>Provides the configuration information for an Amazon Kendra data source.</p>"
},
"DataSourceDateFieldFormat":{
"type":"string",
@@ -2270,7 +2300,7 @@
"documentation":"<p>The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.</p>"
}
},
- "documentation":"<p> Data source information for user context filtering. </p>"
+ "documentation":"<p>Data source information for user context filtering.</p>"
},
"DataSourceGroups":{
"type":"list",
@@ -2498,7 +2528,8 @@
"GOOGLEDRIVE",
"WEBCRAWLER",
"WORKDOCS",
- "FSX"
+ "FSX",
+ "SLACK"
]
},
"DataSourceVpcConfiguration":{
@@ -2517,7 +2548,7 @@
"documentation":"<p>A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.</p>"
}
},
- "documentation":"<p>Provides information for connecting to an Amazon VPC.</p>"
+ "documentation":"<p>Provides the configuration information to connect to an Amazon VPC.</p>"
},
"DatabaseConfiguration":{
"type":"structure",
@@ -2533,7 +2564,7 @@
},
"ConnectionConfiguration":{
"shape":"ConnectionConfiguration",
- "documentation":"<p>The information necessary to connect to a database.</p>"
+ "documentation":"<p>Configuration information that's required to connect to a database.</p>"
},
"VpcConfiguration":{"shape":"DataSourceVpcConfiguration"},
"ColumnConfiguration":{
@@ -2549,7 +2580,7 @@
"documentation":"<p>Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.</p>"
}
},
- "documentation":"<p>Provides the information necessary to connect a database to an index. </p>"
+ "documentation":"<p>Provides the configuration information to connect to a index. </p>"
},
"DatabaseEngineType":{
"type":"string",
@@ -2739,7 +2770,7 @@
},
"Configuration":{
"shape":"DataSourceConfiguration",
- "documentation":"<p>Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.</p>"
+ "documentation":"<p>Describes how the data source is configured. The specific information in the description depends on the data source provider.</p>"
},
"CreatedAt":{
"shape":"Timestamp",
@@ -3621,7 +3652,7 @@
"documentation":"<p>Specifies whether you are configuring a <code>User</code> or a <code>Group</code>.</p>"
}
},
- "documentation":"<p>Provides the configuration information of users or groups in your Amazon Web Services SSO identity source to grant access your Amazon Kendra experience.</p>"
+ "documentation":"<p>Provides the configuration information for users or groups in your Amazon Web Services SSO identity source to grant access your Amazon Kendra experience.</p>"
},
"EntityDisplayData":{
"type":"structure",
@@ -3677,7 +3708,7 @@
"documentation":"<p>The persona that defines the specific permissions of the user or group in your Amazon Web Services SSO identity source. The available personas or access roles are <code>Owner</code> and <code>Viewer</code>. For more information on these personas, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience\">Providing access to your search page</a>.</p>"
}
},
- "documentation":"<p>Provides the configuration information of users or groups in your Amazon Web Services SSO identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.</p>"
+ "documentation":"<p>Provides the configuration information for users or groups in your Amazon Web Services SSO identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.</p>"
},
"EntityPersonaConfigurationList":{
"type":"list",
@@ -3735,7 +3766,7 @@
"documentation":"<p>The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.</p>"
}
},
- "documentation":"<p>Specifies the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.</p>"
+ "documentation":"<p>Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.</p>"
},
"ExperienceEndpoint":{
"type":"structure",
@@ -3749,7 +3780,7 @@
"documentation":"<p>The endpoint of your Amazon Kendra experience.</p>"
}
},
- "documentation":"<p>Provides the configuration information of the endpoint for your Amazon Kendra experience.</p>"
+ "documentation":"<p>Provides the configuration information for the endpoint for your Amazon Kendra experience.</p>"
},
"ExperienceEndpoints":{
"type":"list",
@@ -4007,23 +4038,23 @@
},
"VpcConfiguration":{
"shape":"DataSourceVpcConfiguration",
- "documentation":"<p>Provides the configuration information for connecting to an Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.</p>"
+ "documentation":"<p>Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.</p>"
},
"SecretArn":{
"shape":"SecretArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, <i>user@corp.example.com</i>. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.</p> </li> <li> <p>password—The password of the active directory user with read and mounting access Amazon FSx Windows file system.</p> </li> </ul>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, <i>user@corp.example.com</i>. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.</p> </li> <li> <p>password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.</p> </li> </ul>"
},
"InclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
},
"ExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names in Amazon Kendra. To create custom fields, use the <code>UpdateIndex</code> API before you map to Amazon FSx fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.</p>"
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Amazon FSx fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.</p>"
}
},
"documentation":"<p>Provides the configuration information to connect to Amazon FSx as your data source.</p>"
@@ -4127,15 +4158,15 @@
},
"InclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.</p>"
},
"ExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.</p>"
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>Defines mapping between a field in the Google Drive and a Amazon Kendra index field.</p> <p>If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the <code>UpdateIndex</code> API.</p>"
+ "documentation":"<p>Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Google Drive fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Google Drive data source field names must exist in your Google Drive custom metadata.</p>"
},
"ExcludeMimeTypes":{
"shape":"ExcludeMimeTypesList",
@@ -4150,7 +4181,7 @@
"documentation":"<p>A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.</p>"
}
},
- "documentation":"<p>Provides configuration information for data sources that connect to Google Drive.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Google Drive as your data source.</p>"
},
"GroupAttributeField":{
"type":"string",
@@ -4360,7 +4391,7 @@
"documentation":"<p>The current status of the index. When the status is <code>ACTIVE</code>, the index is ready to search.</p>"
}
},
- "documentation":"<p>A summary of information about an index.</p>"
+ "documentation":"<p>A summary of information on the configuration of an index.</p>"
},
"IndexConfigurationSummaryList":{
"type":"list",
@@ -4507,7 +4538,7 @@
"documentation":"<p>The group attribute field.</p>"
}
},
- "documentation":"<p>Configuration information for the JSON token type.</p>"
+ "documentation":"<p>Provides the configuration information for the JSON token type.</p>"
},
"JwtTokenTypeConfiguration":{
"type":"structure",
@@ -4542,7 +4573,7 @@
"documentation":"<p>The regular expression that identifies the claim.</p>"
}
},
- "documentation":"<p>Configuration information for the JWT token type.</p>"
+ "documentation":"<p>Provides the configuration information for the JWT token type.</p>"
},
"KeyLocation":{
"type":"string",
@@ -4841,7 +4872,7 @@
"members":{
"IndexConfigurationSummaryItems":{
"shape":"IndexConfigurationSummaryList",
- "documentation":"<p>An array of summary information for one or more indexes.</p>"
+ "documentation":"<p>An array of summary information on the configuration of one or more indexes.</p>"
},
"NextToken":{
"shape":"NextToken",
@@ -4935,6 +4966,11 @@
}
},
"Long":{"type":"long"},
+ "LookBackPeriod":{
+ "type":"integer",
+ "max":168,
+ "min":0
+ },
"MaxContentSizePerPageInMegaBytes":{
"type":"float",
"max":50,
@@ -5106,22 +5142,22 @@
},
"InclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index. </p> <p>The exclusion pattern is applied to the file name.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The pattern is applied to the file name.</p>"
},
"ExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed. </p> <p>The exclusion pattern is applied to the file name.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The pattern is applied to the file name.</p>"
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.</p>"
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to OneDrive fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The OneDrive data source field names must exist in your OneDrive custom metadata.</p>"
},
"DisableLocalGroups":{
"shape":"Boolean",
"documentation":"<p>A Boolean value that specifies whether local groups are disabled (<code>True</code>) or enabled (<code>False</code>). </p>"
}
},
- "documentation":"<p>Provides configuration information for data sources that connect to OneDrive.</p>"
+ "documentation":"<p>Provides the configuration information to connect to OneDrive as your data source.</p>"
},
"OneDriveUser":{
"type":"string",
@@ -5259,6 +5295,10 @@
"GROUP"
]
},
+ "PrivateChannelFilter":{
+ "type":"list",
+ "member":{"shape":"String"}
+ },
"ProxyConfiguration":{
"type":"structure",
"required":[
@@ -5281,6 +5321,10 @@
},
"documentation":"<p>Provides the configuration information for a web proxy to connect to website hosts.</p>"
},
+ "PublicChannelFilter":{
+ "type":"list",
+ "member":{"shape":"String"}
+ },
"PutPrincipalMappingRequest":{
"type":"structure",
"required":[
@@ -5383,6 +5427,10 @@
"VisitorId":{
"shape":"VisitorId",
"documentation":"<p>Provides an identifier for a specific user. The <code>VisitorId</code> should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the <code>VisitorId</code>.</p>"
+ },
+ "SpellCorrectionConfiguration":{
+ "shape":"SpellCorrectionConfiguration",
+ "documentation":"<p>Enables suggested spell corrections for queries.</p>"
}
}
},
@@ -5408,6 +5456,10 @@
"Warnings":{
"shape":"WarningList",
"documentation":"<p>A list of warning codes and their messages on problems with your query.</p> <p>Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax\">Searching with advanced query syntax</a>.</p>"
+ },
+ "SpellCorrectedQueries":{
+ "shape":"SpellCorrectedQueryList",
+ "documentation":"<p>A list of information related to suggested spell corrections for a query.</p>"
}
}
},
@@ -5680,7 +5732,7 @@
"documentation":"<p>Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html\">Access control for S3 data sources</a>.</p>"
}
},
- "documentation":"<p>Provides configuration information for a data source to index documents in an Amazon S3 bucket.</p>"
+ "documentation":"<p>Provides the configuration information to connect to an Amazon S3 bucket.</p>"
},
"S3ObjectKey":{
"type":"string",
@@ -5726,7 +5778,7 @@
"documentation":"<p>Filters the documents in the feed based on status of the user. When you specify <code>ACTIVE_USERS</code> only documents from users who have an active account are indexed. When you specify <code>STANDARD_USER</code> only documents for Salesforce standard users are documented. You can specify both.</p>"
}
},
- "documentation":"<p>Defines configuration for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.</p>"
+ "documentation":"<p>The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.</p>"
},
"SalesforceChatterFeedIncludeFilterType":{
"type":"string",
@@ -5758,15 +5810,15 @@
},
"StandardObjectConfigurations":{
"shape":"SalesforceStandardObjectConfigurationList",
- "documentation":"<p>Specifies the Salesforce standard objects that Amazon Kendra indexes.</p>"
+ "documentation":"<p>Configuration of the Salesforce standard objects that Amazon Kendra indexes.</p>"
},
"KnowledgeArticleConfiguration":{
"shape":"SalesforceKnowledgeArticleConfiguration",
- "documentation":"<p>Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.</p>"
+ "documentation":"<p>Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.</p>"
},
"ChatterFeedConfiguration":{
"shape":"SalesforceChatterFeedConfiguration",
- "documentation":"<p>Specifies configuration information for Salesforce chatter feeds.</p>"
+ "documentation":"<p>Configuration information for Salesforce chatter feeds.</p>"
},
"CrawlAttachments":{
"shape":"Boolean",
@@ -5774,18 +5826,18 @@
},
"StandardObjectAttachmentConfiguration":{
"shape":"SalesforceStandardObjectAttachmentConfiguration",
- "documentation":"<p>Provides configuration information for processing attachments to Salesforce standard objects. </p>"
+ "documentation":"<p>Configuration information for processing attachments to Salesforce standard objects. </p>"
},
"IncludeAttachmentFilePatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.</p> <p>The regex is applied to the name of the attached file.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The pattern is applied to the name of the attached file.</p>"
},
"ExcludeAttachmentFilePatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.</p> <p>The regex is applied to the name of the attached file.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The pattern is applied to the name of the attached file.</p>"
}
},
- "documentation":"<p>Provides configuration information for connecting to a Salesforce data source.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Salesforce as your data source.</p>"
},
"SalesforceCustomKnowledgeArticleTypeConfiguration":{
"type":"structure",
@@ -5808,10 +5860,10 @@
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.</p>"
+ "documentation":"<p>Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.</p>"
}
},
- "documentation":"<p>Provides configuration information for indexing Salesforce custom articles.</p>"
+ "documentation":"<p>Provides the configuration information for indexing Salesforce custom articles.</p>"
},
"SalesforceCustomKnowledgeArticleTypeConfigurationList":{
"type":"list",
@@ -5835,14 +5887,14 @@
},
"StandardKnowledgeArticleTypeConfiguration":{
"shape":"SalesforceStandardKnowledgeArticleTypeConfiguration",
- "documentation":"<p>Provides configuration information for standard Salesforce knowledge articles.</p>"
+ "documentation":"<p>Configuration information for standard Salesforce knowledge articles.</p>"
},
"CustomKnowledgeArticleTypeConfigurations":{
"shape":"SalesforceCustomKnowledgeArticleTypeConfigurationList",
- "documentation":"<p>Provides configuration information for custom Salesforce knowledge articles.</p>"
+ "documentation":"<p>Configuration information for custom Salesforce knowledge articles.</p>"
}
},
- "documentation":"<p>Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both </p>"
+ "documentation":"<p>Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both </p>"
},
"SalesforceKnowledgeArticleState":{
"type":"string",
@@ -5872,10 +5924,10 @@
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>One or more objects that map fields in the knowledge article to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.</p>"
+ "documentation":"<p>Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.</p>"
}
},
- "documentation":"<p>Provides configuration information for standard Salesforce knowledge articles.</p>"
+ "documentation":"<p>Provides the configuration information for standard Salesforce knowledge articles.</p>"
},
"SalesforceStandardObjectAttachmentConfiguration":{
"type":"structure",
@@ -5889,7 +5941,7 @@
"documentation":"<p>One or more objects that map fields in attachments to Amazon Kendra index fields.</p>"
}
},
- "documentation":"<p>Provides configuration information for processing attachments to Salesforce standard objects. </p>"
+ "documentation":"<p>Provides the configuration information for processing attachments to Salesforce standard objects.</p>"
},
"SalesforceStandardObjectConfiguration":{
"type":"structure",
@@ -5912,10 +5964,10 @@
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.</p>"
+ "documentation":"<p>Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.</p>"
}
},
- "documentation":"<p>Specifies configuration information for indexing a single standard object.</p>"
+ "documentation":"<p>Provides the configuration information for indexing a single standard object.</p>"
},
"SalesforceStandardObjectConfigurationList":{
"type":"list",
@@ -6020,7 +6072,7 @@
"documentation":"<p>You can choose one of the following modes:</p> <ul> <li> <p> <code>HOST_ONLY</code> – crawl only the website host names. For example, if the seed URL is \"abc.example.com\", then only URLs with host name \"abc.example.com\" are crawled.</p> </li> <li> <p> <code>SUBDOMAINS</code> – crawl the website host names with subdomains. For example, if the seed URL is \"abc.example.com\", then \"a.abc.example.com\" and \"b.abc.example.com\" are also crawled.</p> </li> <li> <p> <code>EVERYTHING</code> – crawl the website host names with subdomains and other domains that the webpages link to.</p> </li> </ul> <p>The default mode is set to <code>HOST_ONLY</code>.</p>"
}
},
- "documentation":"<p>Provides the configuration information of the seed or starting point URLs to crawl.</p> <p> <i>When selecting websites to index, you must adhere to the <a href=\"https://aws.amazon.com/aup/\">Amazon Acceptable Use Policy</a> and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.</i> </p>"
+ "documentation":"<p>Provides the configuration information for the seed or starting point URLs to crawl.</p> <p> <i>When selecting websites to index, you must adhere to the <a href=\"https://aws.amazon.com/aup/\">Amazon Acceptable Use Policy</a> and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.</i> </p>"
},
"SeedUrlList":{
"type":"list",
@@ -6062,7 +6114,7 @@
"members":{
"HostUrl":{
"shape":"ServiceNowHostUrl",
- "documentation":"<p>The ServiceNow instance that the data source connects to. The host endpoint should look like the following: <code>{instance}.service-now.com.</code> </p>"
+ "documentation":"<p>The ServiceNow instance that the data source connects to. The host endpoint should look like the following: <i>{instance}.service-now.com.</i> </p>"
},
"SecretArn":{
"shape":"SecretArn",
@@ -6074,18 +6126,18 @@
},
"KnowledgeArticleConfiguration":{
"shape":"ServiceNowKnowledgeArticleConfiguration",
- "documentation":"<p>Provides configuration information for crawling knowledge articles in the ServiceNow site.</p>"
+ "documentation":"<p>Configuration information for crawling knowledge articles in the ServiceNow site.</p>"
},
"ServiceCatalogConfiguration":{
"shape":"ServiceNowServiceCatalogConfiguration",
- "documentation":"<p>Provides configuration information for crawling service catalogs in the ServiceNow site.</p>"
+ "documentation":"<p>Configuration information for crawling service catalogs in the ServiceNow site.</p>"
},
"AuthenticationType":{
"shape":"ServiceNowAuthenticationType",
- "documentation":"<p>Determines the type of authentication used to connect to the ServiceNow instance. If you choose <code>HTTP_BASIC</code>, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the <code>SecretArn</code> field. When you choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.</p> <p>When you use <code>OAUTH2</code> authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html\">Using a ServiceNow data source</a>.</p>"
+ "documentation":"<p>The type of authentication used to connect to the ServiceNow instance. If you choose <code>HTTP_BASIC</code>, Amazon Kendra is authenticated using the user name and password provided in the Secrets Manager secret in the <code>SecretArn</code> field. When you choose <code>OAUTH2</code>, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.</p> <p>When you use <code>OAUTH2</code> authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html\">Using a ServiceNow data source</a>.</p>"
}
},
- "documentation":"<p>Provides configuration information required to connect to a ServiceNow data source.</p>"
+ "documentation":"<p>Provides the configuration information to connect to ServiceNow as your data source.</p>"
},
"ServiceNowHostUrl":{
"type":"string",
@@ -6103,11 +6155,11 @@
},
"IncludeAttachmentFilePatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the <code>PatternTargetField</code>.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.</p> <p>The regex is applied to the field specified in the <code>PatternTargetField</code>.</p>"
},
"ExcludeAttachmentFilePatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the <code>PatternTargetField</code> </p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.</p> <p>The regex is applied to the field specified in the <code>PatternTargetField</code>.</p>"
},
"DocumentDataFieldName":{
"shape":"DataSourceFieldName",
@@ -6119,14 +6171,14 @@
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.</p>"
+ "documentation":"<p>Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to ServiceNow fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>"
},
"FilterQuery":{
"shape":"ServiceNowKnowledgeArticleFilterQuery",
"documentation":"<p>A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.</p> <p>The query string must be one generated by the ServiceNow console. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html\">Specifying documents to index with a query</a>. </p>"
}
},
- "documentation":"<p>Provides configuration information for crawling knowledge articles in the ServiceNow site.</p>"
+ "documentation":"<p>Provides the configuration information for crawling knowledge articles in the ServiceNow site.</p>"
},
"ServiceNowKnowledgeArticleFilterQuery":{
"type":"string",
@@ -6144,11 +6196,11 @@
},
"IncludeAttachmentFilePatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.</p> <p>The regex is applied to the file name of the attachment.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.</p> <p>The regex is applied to the file name of the attachment.</p>"
},
"ExcludeAttachmentFilePatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.</p> <p>The regex is applied to the file name of the attachment.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.</p> <p>The regex is applied to the file name of the attachment.</p>"
},
"DocumentDataFieldName":{
"shape":"DataSourceFieldName",
@@ -6160,10 +6212,10 @@
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.</p>"
+ "documentation":"<p>Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to ServiceNow fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>"
}
},
- "documentation":"<p>Provides configuration information for crawling service catalog items in the ServiceNow site</p>"
+ "documentation":"<p>Provides the configuration information for crawling service catalog items in the ServiceNow site</p>"
},
"ServiceQuotaExceededException":{
"type":"structure",
@@ -6199,20 +6251,20 @@
},
"UseChangeLog":{
"shape":"Boolean",
- "documentation":"<p>Set to <code>TRUE</code> to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.</p>"
+ "documentation":"<p> <code>TRUE</code> to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.</p>"
},
"InclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.</p> <p>The regex is applied to the display URL of the SharePoint document.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The regex is applied to the display URL of the SharePoint document.</p>"
},
"ExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.</p> <p>The regex is applied to the display URL of the SharePoint document.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The regex is applied to the display URL of the SharePoint document.</p>"
},
"VpcConfiguration":{"shape":"DataSourceVpcConfiguration"},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the <code>UpdateIndex</code> API before you map SharePoint attributes. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping Data Source Fields</a>.</p>"
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to SharePoint fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The SharePoint data source field names must exist in your SharePoint custom metadata.</p>"
},
"DocumentTitleFieldName":{
"shape":"DataSourceFieldName",
@@ -6224,7 +6276,7 @@
},
"SslCertificateS3Path":{"shape":"S3Path"}
},
- "documentation":"<p>Provides configuration information for connecting to a Microsoft SharePoint data source.</p>"
+ "documentation":"<p>Provides the configuration information to connect to Microsoft SharePoint as your data source.</p>"
},
"SharePointUrlList":{
"type":"list",
@@ -6246,6 +6298,12 @@
"min":1,
"pattern":"^\\P{C}*$"
},
+ "SinceCrawlDate":{
+ "type":"string",
+ "max":10,
+ "min":10,
+ "pattern":"(20\\d{2})-(0?[1-9]|1[0-2])-(0?[1-9]|1\\d|2\\d|3[01])"
+ },
"SiteMap":{
"type":"string",
"max":2048,
@@ -6261,7 +6319,7 @@
"documentation":"<p>The list of sitemap URLs of the websites you want to crawl.</p> <p>The list can include a maximum of three sitemap URLs.</p>"
}
},
- "documentation":"<p>Provides the configuration information of the sitemap URLs to crawl.</p> <p> <i>When selecting websites to index, you must adhere to the <a href=\"https://aws.amazon.com/aup/\">Amazon Acceptable Use Policy</a> and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.</i> </p>"
+ "documentation":"<p>Provides the configuration information for the sitemap URLs to crawl.</p> <p> <i>When selecting websites to index, you must adhere to the <a href=\"https://aws.amazon.com/aup/\">Amazon Acceptable Use Policy</a> and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.</i> </p>"
},
"SiteMapsList":{
"type":"list",
@@ -6269,6 +6327,89 @@
"max":3,
"min":0
},
+ "SlackConfiguration":{
+ "type":"structure",
+ "required":[
+ "TeamId",
+ "SecretArn",
+ "SlackEntityList",
+ "SinceCrawlDate"
+ ],
+ "members":{
+ "TeamId":{
+ "shape":"TeamId",
+ "documentation":"<p>The identifier of the team in the Slack workspace. For example, <i>T0123456789</i>.</p> <p>You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, <i>https://app.slack.com/client/<b>T0123456789</b>/...</i>.</p>"
+ },
+ "SecretArn":{
+ "shape":"SecretArn",
+ "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication\">Authentication for a Slack data source</a>.</p> </li> </ul>"
+ },
+ "VpcConfiguration":{
+ "shape":"DataSourceVpcConfiguration",
+ "documentation":"<p>Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html\">Configuring a VPC</a>.</p>"
+ },
+ "SlackEntityList":{
+ "shape":"SlackEntityList",
+ "documentation":"<p>Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.</p>"
+ },
+ "UseChangeLog":{
+ "shape":"Boolean",
+ "documentation":"<p> <code>TRUE</code> to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.</p>"
+ },
+ "CrawlBotMessage":{
+ "shape":"Boolean",
+ "documentation":"<p> <code>TRUE</code> to index bot messages from your Slack workspace team.</p>"
+ },
+ "ExcludeArchived":{
+ "shape":"Boolean",
+ "documentation":"<p> <code>TRUE</code> to exclude archived messages to index from your Slack workspace team.</p>"
+ },
+ "SinceCrawlDate":{
+ "shape":"SinceCrawlDate",
+ "documentation":"<p>The date to start crawling your data from your Slack workspace team. The date must follow this format: <code>yyyy-mm-dd</code>.</p>"
+ },
+ "LookBackPeriod":{
+ "shape":"LookBackPeriod",
+ "documentation":"<p>The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.</p> <p>Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the <code>LookBackPeriod</code> to the number of hours you want change log to look back.</p>"
+ },
+ "PrivateChannelFilter":{
+ "shape":"PrivateChannelFilter",
+ "documentation":"<p>The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.</p>"
+ },
+ "PublicChannelFilter":{
+ "shape":"PublicChannelFilter",
+ "documentation":"<p>The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.</p>"
+ },
+ "InclusionPatterns":{
+ "shape":"DataSourceInclusionsExclusionsStrings",
+ "documentation":"<p>A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
+ },
+ "ExclusionPatterns":{
+ "shape":"DataSourceInclusionsExclusionsStrings",
+ "documentation":"<p>A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
+ },
+ "FieldMappings":{
+ "shape":"DataSourceToIndexFieldMappingList",
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Slack fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Slack data source field names must exist in your Slack custom metadata.</p>"
+ }
+ },
+ "documentation":"<p>Provides the configuration information to connect to Slack as your data source.</p>"
+ },
+ "SlackEntity":{
+ "type":"string",
+ "enum":[
+ "PUBLIC_CHANNEL",
+ "PRIVATE_CHANNEL",
+ "GROUP_MESSAGE",
+ "DIRECT_MESSAGE"
+ ]
+ },
+ "SlackEntityList":{
+ "type":"list",
+ "member":{"shape":"SlackEntity"},
+ "max":4,
+ "min":1
+ },
"SnapshotsDataHeaderFields":{
"type":"list",
"member":{"shape":"String"}
@@ -6306,6 +6447,35 @@
},
"documentation":"<p>Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the <code>Sortable</code> flag set to <code>true</code>, otherwise Amazon Kendra returns an exception.</p> <p>You can sort attributes of the following types.</p> <ul> <li> <p>Date value</p> </li> <li> <p>Long value</p> </li> <li> <p>String value</p> </li> </ul> <p>You can't sort attributes of the following type.</p> <ul> <li> <p>String list value</p> </li> </ul>"
},
+ "SpellCorrectedQuery":{
+ "type":"structure",
+ "members":{
+ "SuggestedQueryText":{
+ "shape":"SuggestedQueryText",
+ "documentation":"<p>The query with the suggested spell corrections.</p>"
+ },
+ "Corrections":{
+ "shape":"CorrectionList",
+ "documentation":"<p>The corrected misspelled word or words in a query.</p>"
+ }
+ },
+ "documentation":"<p>A query with suggested spell corrections. </p>"
+ },
+ "SpellCorrectedQueryList":{
+ "type":"list",
+ "member":{"shape":"SpellCorrectedQuery"}
+ },
+ "SpellCorrectionConfiguration":{
+ "type":"structure",
+ "required":["IncludeQuerySpellCheckSuggestions"],
+ "members":{
+ "IncludeQuerySpellCheckSuggestions":{
+ "shape":"Boolean",
+ "documentation":"<p> <code>TRUE</code> to suggest spell corrections for queries.</p>"
+ }
+ },
+ "documentation":"<p>Provides the configuration information for suggested query spell corrections.</p> <p>Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.</p> <p>This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html\">Spell Checker documentation</a>.</p>"
+ },
"SqlConfiguration":{
"type":"structure",
"members":{
@@ -6314,7 +6484,7 @@
"documentation":"<p>Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (\") when making a database query.</p> <p>By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.</p> <p>PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.</p> <p>For MySQL databases, you must enable the <code>ansi_quotes</code> option when you set this field to <code>DOUBLE_QUOTES</code>.</p>"
}
},
- "documentation":"<p>Provides information that configures Amazon Kendra to use a SQL database.</p>"
+ "documentation":"<p>Provides the configuration information to use a SQL database.</p>"
},
"StartDataSourceSyncJobRequest":{
"type":"structure",
@@ -6427,6 +6597,11 @@
"max":6,
"min":1
},
+ "SuggestedQueryText":{
+ "type":"string",
+ "max":1000,
+ "min":1
+ },
"Suggestion":{
"type":"structure",
"members":{
@@ -6559,6 +6734,12 @@
"max":256,
"min":0
},
+ "TeamId":{
+ "type":"string",
+ "max":64,
+ "min":1,
+ "pattern":"[A-Z0-9]*"
+ },
"TenantDomain":{
"type":"string",
"max":256,
@@ -6723,7 +6904,7 @@
},
"Configuration":{
"shape":"DataSourceConfiguration",
- "documentation":"<p>Configuration information for an Amazon Kendra data source.</p>"
+ "documentation":"<p>Configuration information for an Amazon Kendra data source you want to update.</p>"
},
"Description":{
"shape":"Description",
@@ -6772,7 +6953,7 @@
},
"Configuration":{
"shape":"ExperienceConfiguration",
- "documentation":"<p>Provides the user configuration information. This includes the Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails.</p>"
+ "documentation":"<p>Configuration information for your Amazon Kendra you want to update.</p>"
},
"Description":{
"shape":"Description",
@@ -6802,7 +6983,7 @@
},
"DocumentMetadataConfigurationUpdates":{
"shape":"DocumentMetadataConfigurationList",
- "documentation":"<p>The document metadata to update. </p>"
+ "documentation":"<p>The document metadata you want to update.</p>"
},
"CapacityUnits":{
"shape":"CapacityUnitsConfiguration",
@@ -6926,11 +7107,11 @@
"members":{
"SeedUrlConfiguration":{
"shape":"SeedUrlConfiguration",
- "documentation":"<p>Provides the configuration of the seed or starting point URLs of the websites you want to crawl.</p> <p>You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.</p> <p>You can list up to 100 seed URLs.</p>"
+ "documentation":"<p>Configuration of the seed or starting point URLs of the websites you want to crawl.</p> <p>You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the webpages link to.</p> <p>You can list up to 100 seed URLs.</p>"
},
"SiteMapsConfiguration":{
"shape":"SiteMapsConfiguration",
- "documentation":"<p>Provides the configuration of the sitemap URLs of the websites you want to crawl.</p> <p>Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.</p>"
+ "documentation":"<p>Configuration of the sitemap URLs of the websites you want to crawl.</p> <p>Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.</p>"
}
},
"documentation":"<p>Provides the configuration information of the URLs to crawl.</p> <p>You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.</p> <p> <i>When selecting websites to index, you must adhere to the <a href=\"https://aws.amazon.com/aup/\">Amazon Acceptable Use Policy</a> and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.</i> </p>"
@@ -7002,7 +7183,7 @@
"documentation":"<p>The Amazon Web Services SSO field name that contains the identifiers of your users, such as their emails. This is used for <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html\">user context filtering</a> and for granting access to your Amazon Kendra experience. You must set up Amazon Web Services SSO with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html\">Getting started with an Amazon Web Services SSO identity source</a>.</p>"
}
},
- "documentation":"<p>Configuration information for the identifiers of your users.</p>"
+ "documentation":"<p>Provides the configuration information for the identifiers of your users.</p>"
},
"UserNameAttributeField":{
"type":"string",
@@ -7022,7 +7203,7 @@
"documentation":"<p>Information about the JSON token type configuration.</p>"
}
},
- "documentation":"<p>Provides configuration information for a token configuration.</p>"
+ "documentation":"<p>Provides the configuration information for a token.</p>"
},
"UserTokenConfigurationList":{
"type":"list",
@@ -7115,19 +7296,19 @@
},
"UrlInclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>The regular expression pattern to include certain URLs to crawl.</p> <p>If there is a regular expression pattern to exclude certain URLs that conflicts with the include pattern, the exclude pattern takes precedence.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.</p>"
},
"UrlExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>The regular expression pattern to exclude certain URLs to crawl.</p> <p>If there is a regular expression pattern to include certain URLs that conflicts with the exclude pattern, the exclude pattern takes precedence.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.</p>"
},
"ProxyConfiguration":{
"shape":"ProxyConfiguration",
- "documentation":"<p>Provides configuration information required to connect to your internal websites via a web proxy.</p> <p>You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS.</p> <p>Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html\">Secrets Manager</a>.</p>"
+ "documentation":"<p>Configuration information required to connect to your internal websites via a web proxy.</p> <p>You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS.</p> <p>Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html\">Secrets Manager</a>.</p>"
},
"AuthenticationConfiguration":{
"shape":"AuthenticationConfiguration",
- "documentation":"<p>Provides configuration information required to connect to websites using authentication.</p> <p>You can connect to websites using basic authentication of user name and password.</p> <p>You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS. You use a secret in <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html\">Secrets Manager</a> to store your authentication credentials.</p>"
+ "documentation":"<p>Configuration information required to connect to websites using authentication.</p> <p>You can connect to websites using basic authentication of user name and password.</p> <p>You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS. You use a secret in <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html\">Secrets Manager</a> to store your authentication credentials.</p>"
}
},
"documentation":"<p>Provides the configuration information required for Amazon Kendra Web Crawler.</p>"
@@ -7154,19 +7335,19 @@
},
"UseChangeLog":{
"shape":"Boolean",
- "documentation":"<p> <code>TRUE</code> to use the change logs to update documents in your index instead of scanning all documents.</p> <p>If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs.</p> <p>The default is set to <code>FALSE</code>.</p>"
+ "documentation":"<p> <code>TRUE</code> to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.</p>"
},
"InclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
},
"ExclusionPatterns":{
"shape":"DataSourceInclusionsExclusionsStrings",
- "documentation":"<p>A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.</p>"
+ "documentation":"<p>A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.</p>"
},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",
- "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the <code>UpdateIndex</code> API before you map to Amazon WorkDocs fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping Data Source Fields</a>. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.</p>"
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Amazon WorkDocs fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.</p>"
}
},
"documentation":"<p>Provides the configuration information to connect to Amazon WorkDocs as your data source.</p> <p>Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/paginators-1.json b/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/paginators-1.json
new file mode 100644
index 0000000000..885bf4e250
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/paginators-1.json
@@ -0,0 +1,22 @@
+{
+ "pagination": {
+ "ListKeyspaces": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "limit_key": "maxResults",
+ "result_key": "keyspaces"
+ },
+ "ListTables": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "limit_key": "maxResults",
+ "result_key": "tables"
+ },
+ "ListTagsForResource": {
+ "input_token": "nextToken",
+ "output_token": "nextToken",
+ "limit_key": "maxResults",
+ "result_key": "tags"
+ }
+ }
+}
diff --git a/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/service-2.json b/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/service-2.json
new file mode 100644
index 0000000000..744e41e3e0
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/service-2.json
@@ -0,0 +1,1146 @@
+{
+ "version":"2.0",
+ "metadata":{
+ "apiVersion":"2022-02-10",
+ "endpointPrefix":"cassandra",
+ "jsonVersion":"1.0",
+ "protocol":"json",
+ "serviceFullName":"Amazon Keyspaces",
+ "serviceId":"Keyspaces",
+ "signatureVersion":"v4",
+ "signingName":"cassandra",
+ "targetPrefix":"KeyspacesService",
+ "uid":"keyspaces-2022-02-10"
+ },
+ "operations":{
+ "CreateKeyspace":{
+ "name":"CreateKeyspace",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"CreateKeyspaceRequest"},
+ "output":{"shape":"CreateKeyspaceResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"}
+ ],
+ "documentation":"<p>The <code>CreateKeyspace</code> operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.</p> <p> <code>CreateKeyspace</code> is an asynchronous operation. You can monitor the creation status of the new keyspace by using the <code>GetKeyspace</code> operation.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-keyspaces.html#keyspaces-create\">Creating keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "CreateTable":{
+ "name":"CreateTable",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"CreateTableRequest"},
+ "output":{"shape":"CreateTableResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>The <code>CreateTable</code> operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.</p> <p> <code>CreateTable</code> is an asynchronous operation. When the request is received, the status of the table is set to <code>CREATING</code>. You can monitor the creation status of the new table by using the <code>GetTable</code> operation, which returns the current <code>status</code> of the table. You can start using a table when the status is <code>ACTIVE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create\">Creating tables</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "DeleteKeyspace":{
+ "name":"DeleteKeyspace",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"DeleteKeyspaceRequest"},
+ "output":{"shape":"DeleteKeyspaceResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>The <code>DeleteKeyspace</code> operation deletes a keyspace and all of its tables. </p>"
+ },
+ "DeleteTable":{
+ "name":"DeleteTable",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"DeleteTableRequest"},
+ "output":{"shape":"DeleteTableResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>The <code>DeleteTable</code> operation deletes a table and all of its data. After a <code>DeleteTable</code> request is received, the specified table is in the <code>DELETING</code> state until Amazon Keyspaces completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is either in the <code>CREATING</code> or <code>UPDATING</code> states, then Amazon Keyspaces returns a <code>ResourceInUseException</code>. If the specified table does not exist, Amazon Keyspaces returns a <code>ResourceNotFoundException</code>. If the table is already in the <code>DELETING</code> state, no error is returned.</p>"
+ },
+ "GetKeyspace":{
+ "name":"GetKeyspace",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetKeyspaceRequest"},
+ "output":{"shape":"GetKeyspaceResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Returns the name and the Amazon Resource Name (ARN) of the specified table.</p>"
+ },
+ "GetTable":{
+ "name":"GetTable",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"GetTableRequest"},
+ "output":{"shape":"GetTableResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.</p> <p>To read table metadata using <code>GetTable</code>, <code>Select</code> action permissions for the table and system tables are required to complete the operation.</p>"
+ },
+ "ListKeyspaces":{
+ "name":"ListKeyspaces",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListKeyspacesRequest"},
+ "output":{"shape":"ListKeyspacesResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Returns a list of keyspaces.</p>"
+ },
+ "ListTables":{
+ "name":"ListTables",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListTablesRequest"},
+ "output":{"shape":"ListTablesResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Returns a list of tables for a specified keyspace.</p>"
+ },
+ "ListTagsForResource":{
+ "name":"ListTagsForResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"ListTagsForResourceRequest"},
+ "output":{"shape":"ListTagsForResourceResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Returns a list of all tags associated with the specified Amazon Keyspaces resource.</p>"
+ },
+ "RestoreTable":{
+ "name":"RestoreTable",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"RestoreTableRequest"},
+ "output":{"shape":"RestoreTableResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Restores the specified table to the specified point in time within the <code>earliest_restorable_timestamp</code> and the current time. For more information about restore points, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window\"> Time window for PITR continuous backups</a> in the <i>Amazon Keyspaces Developer Guide</i>. </p> <p>Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.</p> <p>When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp <code>(day:hour:minute:second)</code> to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.</p> <p>In addition to the table's schema, data, and TTL settings, <code>RestoreTable</code> restores the capacity mode, encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.</p> <p>You can also overwrite these settings during restore:</p> <p>• Read/write capacity mode</p> <p>• Provisioned throughput capacity settings</p> <p>• Point-in-time (PITR) settings</p> <p>• Tags</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_settings\">PITR restore settings</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>Note that the following settings are not restored, and you must configure them manually for the new table:</p> <p>• Automatic scaling policies (for tables that use provisioned capacity mode)</p> <p>• Identity and Access Management (IAM) policies</p> <p>• Amazon CloudWatch metrics and alarms</p>"
+ },
+ "TagResource":{
+ "name":"TagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"TagResourceRequest"},
+ "output":{"shape":"TagResourceResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html\">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples-tags\">Amazon Keyspaces resource access based on tags</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "UntagResource":{
+ "name":"UntagResource",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"UntagResourceRequest"},
+ "output":{"shape":"UntagResourceResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Removes the association of tags from a Amazon Keyspaces resource.</p>"
+ },
+ "UpdateTable":{
+ "name":"UpdateTable",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"UpdateTableRequest"},
+ "output":{"shape":"UpdateTableResponse"},
+ "errors":[
+ {"shape":"ValidationException"},
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"},
+ {"shape":"ConflictException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ResourceNotFoundException"}
+ ],
+ "documentation":"<p>Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.</p>"
+ }
+ },
+ "shapes":{
+ "ARN":{
+ "type":"string",
+ "max":1000,
+ "min":20,
+ "pattern":"arn:(aws[a-zA-Z0-9-]*):cassandra:.+.*"
+ },
+ "AccessDeniedException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "documentation":"<p>You do not have sufficient access to perform this action. </p>",
+ "exception":true
+ },
+ "CapacitySpecification":{
+ "type":"structure",
+ "required":["throughputMode"],
+ "members":{
+ "throughputMode":{
+ "shape":"ThroughputMode",
+ "documentation":"<p>The read/write throughput capacity mode for a table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> and </p> <p>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "readCapacityUnits":{
+ "shape":"CapacityUnits",
+ "documentation":"<p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code> <code>(RCUs)</code>.</p>"
+ },
+ "writeCapacityUnits":{
+ "shape":"CapacityUnits",
+ "documentation":"<p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code> <code>(WCUs)</code>.</p>"
+ }
+ },
+ "documentation":"<p>Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables: </p> <p>• On-demand (default)</p> <p>• Provisioned</p> <p> The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "CapacitySpecificationSummary":{
+ "type":"structure",
+ "required":["throughputMode"],
+ "members":{
+ "throughputMode":{
+ "shape":"ThroughputMode",
+ "documentation":"<p>The read/write throughput capacity mode for a table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> and </p> <p>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input. </p> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "readCapacityUnits":{
+ "shape":"CapacityUnits",
+ "documentation":"<p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code> <code>(RCUs)</code>.</p>"
+ },
+ "writeCapacityUnits":{
+ "shape":"CapacityUnits",
+ "documentation":"<p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code> <code>(WCUs)</code>.</p>"
+ },
+ "lastUpdateToPayPerRequestTimestamp":{
+ "shape":"Timestamp",
+ "documentation":"<p>The timestamp of the last operation that changed the provisioned throughput capacity of a table.</p>"
+ }
+ },
+ "documentation":"<p>The read/write throughput capacity mode for a table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> and </p> <p>• <code>throughputMode:PROVISIONED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "CapacityUnits":{
+ "type":"long",
+ "box":true,
+ "min":1
+ },
+ "ClusteringKey":{
+ "type":"structure",
+ "required":[
+ "name",
+ "orderBy"
+ ],
+ "members":{
+ "name":{
+ "shape":"GenericString",
+ "documentation":"<p>The name(s) of the clustering column(s).</p>"
+ },
+ "orderBy":{
+ "shape":"SortOrder",
+ "documentation":"<p>Sets the ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p>"
+ }
+ },
+ "documentation":"<p>The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.</p>"
+ },
+ "ClusteringKeyList":{
+ "type":"list",
+ "member":{"shape":"ClusteringKey"}
+ },
+ "ColumnDefinition":{
+ "type":"structure",
+ "required":[
+ "name",
+ "type"
+ ],
+ "members":{
+ "name":{
+ "shape":"GenericString",
+ "documentation":"<p>The name of the column.</p>"
+ },
+ "type":{
+ "shape":"GenericString",
+ "documentation":"<p>The data type of the column. For a list of available data types, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types\">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ }
+ },
+ "documentation":"<p>The names and data types of regular columns.</p>"
+ },
+ "ColumnDefinitionList":{
+ "type":"list",
+ "member":{"shape":"ColumnDefinition"},
+ "min":1
+ },
+ "Comment":{
+ "type":"structure",
+ "required":["message"],
+ "members":{
+ "message":{
+ "shape":"String",
+ "documentation":"<p>An optional description of the table.</p>"
+ }
+ },
+ "documentation":"<p>An optional comment that describes the table.</p>"
+ },
+ "ConflictException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "documentation":"<p>Amazon Keyspaces could not complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists. </p>",
+ "exception":true
+ },
+ "CreateKeyspaceRequest":{
+ "type":"structure",
+ "required":["keyspaceName"],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace to be created.</p>"
+ },
+ "tags":{
+ "shape":"TagList",
+ "documentation":"<p>A list of key-value pair tags to be attached to the keyspace.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html\">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ }
+ }
+ },
+ "CreateKeyspaceResponse":{
+ "type":"structure",
+ "required":["resourceArn"],
+ "members":{
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>"
+ }
+ }
+ },
+ "CreateTableRequest":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "tableName",
+ "schemaDefinition"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace that the table is going to be created in.</p>"
+ },
+ "tableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the table.</p>"
+ },
+ "schemaDefinition":{
+ "shape":"SchemaDefinition",
+ "documentation":"<p>The <code>schemaDefinition</code> consists of the following parameters.</p> <p>For each column to be created:</p> <p>• <code>name</code> - The name of the column.</p> <p>• <code>type</code> - An Amazon Keyspaces data type. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types\">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>The primary key of the table consists of the following columns:</p> <p>• <code>partitionKeys</code> - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.</p> <p>• <code>name</code> - The name of each partition key column.</p> <p>• <code>clusteringKeys</code> - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.</p> <p>• <code>name</code> - The name of the clustering column. </p> <p>• <code>orderBy</code> - Sets the ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p> <p>To define a column as static use <code>staticColumns</code> - Static columns store values that are shared by all rows in the same partition:</p> <p>• <code>name</code> - The name of the column.</p> <p>• <code>type</code> - An Amazon Keyspaces data type.</p>"
+ },
+ "comment":{
+ "shape":"Comment",
+ "documentation":"<p>This parameter allows to enter a description of the table.</p>"
+ },
+ "capacitySpecification":{
+ "shape":"CapacitySpecification",
+ "documentation":"<p>Specifies the read/write throughput capacity mode for the table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> and </p> <p>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "encryptionSpecification":{
+ "shape":"EncryptionSpecification",
+ "documentation":"<p>Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):</p> <p>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> <p>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input.</p> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html\">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "pointInTimeRecovery":{
+ "shape":"PointInTimeRecovery",
+ "documentation":"<p>Specifies if <code>pointInTimeRecovery</code> is enabled or disabled for the table. The options are:</p> <p>• <code>ENABLED</code> </p> <p>• <code>DISABLED</code> </p> <p>If it's not specified, the default is <code>DISABLED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html\">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "ttl":{
+ "shape":"TimeToLive",
+ "documentation":"<p>Enables Time to Live custom settings for the table. The options are:</p> <p>• <code>status:enabled</code> </p> <p>• <code>status:disabled</code> </p> <p>The default is <code>status:disabled</code>. After <code>ttl</code> is enabled, you can't disable it for the table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html\">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "defaultTimeToLive":{
+ "shape":"DefaultTimeToLive",
+ "documentation":"<p>The default Time to Live setting in seconds for the table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl\">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "tags":{
+ "shape":"TagList",
+ "documentation":"<p>A list of key-value pair tags to be attached to the resource. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html\">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ }
+ }
+ },
+ "CreateTableResponse":{
+ "type":"structure",
+ "required":["resourceArn"],
+ "members":{
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>"
+ }
+ }
+ },
+ "DefaultTimeToLive":{
+ "type":"integer",
+ "box":true,
+ "max":630720000,
+ "min":1
+ },
+ "DeleteKeyspaceRequest":{
+ "type":"structure",
+ "required":["keyspaceName"],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace to be deleted.</p>"
+ }
+ }
+ },
+ "DeleteKeyspaceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "DeleteTableRequest":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "tableName"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace of the to be deleted table.</p>"
+ },
+ "tableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the table to be deleted.</p>"
+ }
+ }
+ },
+ "DeleteTableResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "EncryptionSpecification":{
+ "type":"structure",
+ "required":["type"],
+ "members":{
+ "type":{
+ "shape":"EncryptionType",
+ "documentation":"<p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p> <p>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> <p>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html\">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "kmsKeyIdentifier":{
+ "shape":"kmsKeyARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</p>"
+ }
+ },
+ "documentation":"<p>Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):</p> <p>• Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge). </p> <p>• Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).</p> <p>For more information about encryption at rest in Amazon Keyspaces, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html\">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>For more information about KMS, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html\">KMS management service concepts</a> in the <i>Key Management Service Developer Guide</i>.</p>"
+ },
+ "EncryptionType":{
+ "type":"string",
+ "enum":[
+ "CUSTOMER_MANAGED_KMS_KEY",
+ "AWS_OWNED_KMS_KEY"
+ ]
+ },
+ "GenericString":{"type":"string"},
+ "GetKeyspaceRequest":{
+ "type":"structure",
+ "required":["keyspaceName"],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace.</p>"
+ }
+ }
+ },
+ "GetKeyspaceResponse":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "resourceArn"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace.</p>"
+ },
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The ARN of the keyspace.</p>"
+ }
+ }
+ },
+ "GetTableRequest":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "tableName"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace that the table is stored in.</p>"
+ },
+ "tableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the table.</p>"
+ }
+ }
+ },
+ "GetTableResponse":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "tableName",
+ "resourceArn"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace that the specified table is stored in.</p>"
+ },
+ "tableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the specified table.</p>"
+ },
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the specified table.</p>"
+ },
+ "creationTimestamp":{
+ "shape":"Timestamp",
+ "documentation":"<p>The creation timestamp of the specified table.</p>"
+ },
+ "status":{
+ "shape":"TableStatus",
+ "documentation":"<p>The current status of the specified table.</p>"
+ },
+ "schemaDefinition":{
+ "shape":"SchemaDefinition",
+ "documentation":"<p>The schema definition of the specified table.</p>"
+ },
+ "capacitySpecification":{
+ "shape":"CapacitySpecificationSummary",
+ "documentation":"<p>The read/write throughput capacity mode for a table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> </p> <p>• <code>throughputMode:PROVISIONED</code> </p>"
+ },
+ "encryptionSpecification":{
+ "shape":"EncryptionSpecification",
+ "documentation":"<p>The encryption settings of the specified table.</p>"
+ },
+ "pointInTimeRecovery":{
+ "shape":"PointInTimeRecoverySummary",
+ "documentation":"<p>The point-in-time recovery status of the specified table.</p>"
+ },
+ "ttl":{
+ "shape":"TimeToLive",
+ "documentation":"<p>The custom Time to Live settings of the specified table.</p>"
+ },
+ "defaultTimeToLive":{
+ "shape":"DefaultTimeToLive",
+ "documentation":"<p>The default Time to Live settings of the specified table.</p>"
+ },
+ "comment":{
+ "shape":"Comment",
+ "documentation":"<p>The the description of the specified table.</p>"
+ }
+ }
+ },
+ "InternalServerException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "documentation":"<p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>",
+ "exception":true,
+ "fault":true
+ },
+ "KeyspaceName":{
+ "type":"string",
+ "max":48,
+ "min":1,
+ "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{1,47}"
+ },
+ "KeyspaceSummary":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "resourceArn"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace.</p>"
+ },
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>"
+ }
+ },
+ "documentation":"<p>Represents the properties of a keyspace.</p>"
+ },
+ "KeyspaceSummaryList":{
+ "type":"list",
+ "member":{"shape":"KeyspaceSummary"}
+ },
+ "ListKeyspacesRequest":{
+ "type":"structure",
+ "members":{
+ "nextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>"
+ },
+ "maxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>"
+ }
+ }
+ },
+ "ListKeyspacesResponse":{
+ "type":"structure",
+ "required":["keyspaces"],
+ "members":{
+ "nextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>"
+ },
+ "keyspaces":{
+ "shape":"KeyspaceSummaryList",
+ "documentation":"<p>A list of keyspaces.</p>"
+ }
+ }
+ },
+ "ListTablesRequest":{
+ "type":"structure",
+ "required":["keyspaceName"],
+ "members":{
+ "nextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>"
+ },
+ "maxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The total number of tables to return in the output. If the total number of tables available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>"
+ },
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace.</p>"
+ }
+ }
+ },
+ "ListTablesResponse":{
+ "type":"structure",
+ "members":{
+ "nextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>"
+ },
+ "tables":{
+ "shape":"TableSummaryList",
+ "documentation":"<p>A list of tables.</p>"
+ }
+ }
+ },
+ "ListTagsForResourceRequest":{
+ "type":"structure",
+ "required":["resourceArn"],
+ "members":{
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.</p>"
+ },
+ "nextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>"
+ },
+ "maxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The total number of tags to return in the output. If the total number of tags available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>"
+ }
+ }
+ },
+ "ListTagsForResourceResponse":{
+ "type":"structure",
+ "members":{
+ "nextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>"
+ },
+ "tags":{
+ "shape":"TagList",
+ "documentation":"<p>A list of tags.</p>"
+ }
+ }
+ },
+ "MaxResults":{
+ "type":"integer",
+ "box":true,
+ "max":1000,
+ "min":1
+ },
+ "NextToken":{
+ "type":"string",
+ "max":2048,
+ "min":1
+ },
+ "PartitionKey":{
+ "type":"structure",
+ "required":["name"],
+ "members":{
+ "name":{
+ "shape":"GenericString",
+ "documentation":"<p>The name(s) of the partition key column(s).</p>"
+ }
+ },
+ "documentation":"<p>The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.</p>"
+ },
+ "PartitionKeyList":{
+ "type":"list",
+ "member":{"shape":"PartitionKey"},
+ "min":1
+ },
+ "PointInTimeRecovery":{
+ "type":"structure",
+ "required":["status"],
+ "members":{
+ "status":{
+ "shape":"PointInTimeRecoveryStatus",
+ "documentation":"<p>The options are:</p> <p>• <code>ENABLED</code> </p> <p>• <code>DISABLED</code> </p>"
+ }
+ },
+ "documentation":"<p>Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html\">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "PointInTimeRecoveryStatus":{
+ "type":"string",
+ "enum":[
+ "ENABLED",
+ "DISABLED"
+ ]
+ },
+ "PointInTimeRecoverySummary":{
+ "type":"structure",
+ "required":["status"],
+ "members":{
+ "status":{
+ "shape":"PointInTimeRecoveryStatus",
+ "documentation":"<p>Shows if point-in-time recovery is enabled or disabled for the specified table.</p>"
+ },
+ "earliestRestorableTimestamp":{
+ "shape":"Timestamp",
+ "documentation":"<p>Specifies the earliest possible restore point of the table in ISO 8601 format.</p>"
+ }
+ },
+ "documentation":"<p>The point-in-time recovery status of the specified table.</p>"
+ },
+ "ResourceNotFoundException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"String"},
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.</p>"
+ }
+ },
+ "documentation":"<p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>",
+ "exception":true
+ },
+ "RestoreTableRequest":{
+ "type":"structure",
+ "required":[
+ "sourceKeyspaceName",
+ "sourceTableName",
+ "targetKeyspaceName",
+ "targetTableName"
+ ],
+ "members":{
+ "sourceKeyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The keyspace name of the source table.</p>"
+ },
+ "sourceTableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the source table.</p>"
+ },
+ "targetKeyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the target keyspace.</p>"
+ },
+ "targetTableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the target table.</p>"
+ },
+ "restoreTimestamp":{
+ "shape":"Timestamp",
+ "documentation":"<p>The restore timestamp in ISO 8601 format.</p>"
+ },
+ "capacitySpecificationOverride":{
+ "shape":"CapacitySpecification",
+ "documentation":"<p>Specifies the read/write throughput capacity mode for the target table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> </p> <p>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "encryptionSpecificationOverride":{
+ "shape":"EncryptionSpecification",
+ "documentation":"<p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p> <p>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> <p>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html\">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "pointInTimeRecoveryOverride":{
+ "shape":"PointInTimeRecovery",
+ "documentation":"<p>Specifies the <code>pointInTimeRecovery</code> settings for the target table. The options are:</p> <p>• <code>ENABLED</code> </p> <p>• <code>DISABLED</code> </p> <p>If it's not specified, the default is <code>DISABLED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html\">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "tagsOverride":{
+ "shape":"TagList",
+ "documentation":"<p>A list of key-value pair tags to be attached to the restored table. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html\">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ }
+ }
+ },
+ "RestoreTableResponse":{
+ "type":"structure",
+ "required":["restoredTableARN"],
+ "members":{
+ "restoredTableARN":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the restored table.</p>"
+ }
+ }
+ },
+ "SchemaDefinition":{
+ "type":"structure",
+ "required":[
+ "allColumns",
+ "partitionKeys"
+ ],
+ "members":{
+ "allColumns":{
+ "shape":"ColumnDefinitionList",
+ "documentation":"<p>The regular columns of the table.</p>"
+ },
+ "partitionKeys":{
+ "shape":"PartitionKeyList",
+ "documentation":"<p>The columns that are part of the partition key of the table .</p>"
+ },
+ "clusteringKeys":{
+ "shape":"ClusteringKeyList",
+ "documentation":"<p>The columns that are part of the clustering key of the table.</p>"
+ },
+ "staticColumns":{
+ "shape":"StaticColumnList",
+ "documentation":"<p>The columns that have been defined as <code>STATIC</code>. Static columns store values that are shared by all rows in the same partition.</p>"
+ }
+ },
+ "documentation":"<p>Describes the schema of the table.</p>"
+ },
+ "ServiceQuotaExceededException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "documentation":"<p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html\">Quotas</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>",
+ "exception":true
+ },
+ "SortOrder":{
+ "type":"string",
+ "enum":[
+ "ASC",
+ "DESC"
+ ]
+ },
+ "StaticColumn":{
+ "type":"structure",
+ "required":["name"],
+ "members":{
+ "name":{
+ "shape":"GenericString",
+ "documentation":"<p>The name of the static column.</p>"
+ }
+ },
+ "documentation":"<p>The static columns of the table. Static columns store values that are shared by all rows in the same partition.</p>"
+ },
+ "StaticColumnList":{
+ "type":"list",
+ "member":{"shape":"StaticColumn"}
+ },
+ "String":{"type":"string"},
+ "TableName":{
+ "type":"string",
+ "max":48,
+ "min":1,
+ "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{1,47}"
+ },
+ "TableStatus":{
+ "type":"string",
+ "enum":[
+ "ACTIVE",
+ "CREATING",
+ "UPDATING",
+ "DELETING",
+ "DELETED",
+ "RESTORING",
+ "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
+ ]
+ },
+ "TableSummary":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "tableName",
+ "resourceArn"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace that the table is stored in.</p>"
+ },
+ "tableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the table.</p>"
+ },
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>"
+ }
+ },
+ "documentation":"<p>Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).</p>"
+ },
+ "TableSummaryList":{
+ "type":"list",
+ "member":{"shape":"TableSummary"}
+ },
+ "Tag":{
+ "type":"structure",
+ "required":[
+ "key",
+ "value"
+ ],
+ "members":{
+ "key":{
+ "shape":"TagKey",
+ "documentation":"<p>The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to 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":"TagValue",
+ "documentation":"<p>The value of the tag. Tag values are case-sensitive and can be null.</p>"
+ }
+ },
+ "documentation":"<p>Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.</p> <p>Amazon Web Services-assigned tag names and values are automatically assigned the <code>aws:</code> prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix <code>user:</code> in the Cost Allocation Report. You cannot backdate the application of a tag.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html\">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "TagKey":{
+ "type":"string",
+ "max":128,
+ "min":1
+ },
+ "TagList":{
+ "type":"list",
+ "member":{"shape":"Tag"},
+ "max":60,
+ "min":1
+ },
+ "TagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "resourceArn",
+ "tags"
+ ],
+ "members":{
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.</p>"
+ },
+ "tags":{
+ "shape":"TagList",
+ "documentation":"<p>The tags to be assigned to the Amazon Keyspaces resource.</p>"
+ }
+ }
+ },
+ "TagResourceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "TagValue":{
+ "type":"string",
+ "max":256,
+ "min":1
+ },
+ "ThroughputMode":{
+ "type":"string",
+ "enum":[
+ "PAY_PER_REQUEST",
+ "PROVISIONED"
+ ]
+ },
+ "TimeToLive":{
+ "type":"structure",
+ "required":["status"],
+ "members":{
+ "status":{
+ "shape":"TimeToLiveStatus",
+ "documentation":"<p>Shows how to enable custom Time to Live (TTL) settings for the specified table.</p>"
+ }
+ },
+ "documentation":"<p>Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling\">Enabling TTL on tables</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "TimeToLiveStatus":{
+ "type":"string",
+ "enum":["ENABLED"]
+ },
+ "Timestamp":{"type":"timestamp"},
+ "UntagResourceRequest":{
+ "type":"structure",
+ "required":[
+ "resourceArn",
+ "tags"
+ ],
+ "members":{
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).</p>"
+ },
+ "tags":{
+ "shape":"TagList",
+ "documentation":"<p>A list of existing tags to be removed from the Amazon Keyspaces resource.</p>"
+ }
+ }
+ },
+ "UntagResourceResponse":{
+ "type":"structure",
+ "members":{
+ }
+ },
+ "UpdateTableRequest":{
+ "type":"structure",
+ "required":[
+ "keyspaceName",
+ "tableName"
+ ],
+ "members":{
+ "keyspaceName":{
+ "shape":"KeyspaceName",
+ "documentation":"<p>The name of the keyspace the specified table is stored in.</p>"
+ },
+ "tableName":{
+ "shape":"TableName",
+ "documentation":"<p>The name of the table.</p>"
+ },
+ "addColumns":{
+ "shape":"ColumnDefinitionList",
+ "documentation":"<p>For each column to be added to the specified table:</p> <p>• <code>name</code> - The name of the column.</p> <p>• <code>type</code> - An Amazon Keyspaces data type. For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types\">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "capacitySpecification":{
+ "shape":"CapacitySpecification",
+ "documentation":"<p>Modifies the read/write throughput capacity mode for the table. The options are:</p> <p>• <code>throughputMode:PAY_PER_REQUEST</code> and </p> <p>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html\">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "encryptionSpecification":{
+ "shape":"EncryptionSpecification",
+ "documentation":"<p>Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):</p> <p>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> <p>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> <p>The default is <code>AWS_OWNED_KMS_KEY</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html\">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "pointInTimeRecovery":{
+ "shape":"PointInTimeRecovery",
+ "documentation":"<p>Modifies the <code>pointInTimeRecovery</code> settings of the table. The options are:</p> <p>• <code>ENABLED</code> </p> <p>• <code>DISABLED</code> </p> <p>If it's not specified, the default is <code>DISABLED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html\">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "ttl":{
+ "shape":"TimeToLive",
+ "documentation":"<p>Modifies Time to Live custom settings for the table. The options are:</p> <p>• <code>status:enabled</code> </p> <p>• <code>status:disabled</code> </p> <p>The default is <code>status:disabled</code>. After <code>ttl</code> is enabled, you can't disable it for the table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html\">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ },
+ "defaultTimeToLive":{
+ "shape":"DefaultTimeToLive",
+ "documentation":"<p>The default Time to Live setting in seconds for the table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl\">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"
+ }
+ }
+ },
+ "UpdateTableResponse":{
+ "type":"structure",
+ "required":["resourceArn"],
+ "members":{
+ "resourceArn":{
+ "shape":"ARN",
+ "documentation":"<p>The Amazon Resource Name (ARN) of the modified table.</p>"
+ }
+ }
+ },
+ "ValidationException":{
+ "type":"structure",
+ "members":{
+ "message":{"shape":"String"}
+ },
+ "documentation":"<p>The operation failed due to an invalid or malformed request.</p>",
+ "exception":true
+ },
+ "kmsKeyARN":{
+ "type":"string",
+ "max":5096,
+ "min":1
+ }
+ },
+ "documentation":"<p>Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software. </p> <p>In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI. This API reference describes the supported DDL operations in detail.</p> <p>For the list of all supported CQL APIs, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html\">Supported Cassandra APIs, operations, and data types in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href=\"https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail\">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>"
+}
diff --git a/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/waiters-2.json b/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/waiters-2.json
new file mode 100644
index 0000000000..4b20636aa4
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/keyspaces/2022-02-10/waiters-2.json
@@ -0,0 +1,5 @@
+{
+ "version": 2,
+ "waiters": {
+ }
+} \ No newline at end of file
diff --git a/contrib/python/botocore/py3/botocore/data/lakeformation/2017-03-31/service-2.json b/contrib/python/botocore/py3/botocore/data/lakeformation/2017-03-31/service-2.json
index a0248d6b72..b411f81352 100644
--- a/contrib/python/botocore/py3/botocore/data/lakeformation/2017-03-31/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/lakeformation/2017-03-31/service-2.json
@@ -2531,10 +2531,7 @@
"CREATE_TABLE",
"DATA_LOCATION_ACCESS",
"CREATE_TAG",
- "ALTER_TAG",
- "DELETE_TAG",
- "DESCRIBE_TAG",
- "ASSOCIATE_TAG"
+ "ASSOCIATE"
]
},
"PermissionList":{
diff --git a/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/service-2.json b/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/service-2.json
index dfec8854f2..a9ba840b36 100644
--- a/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/service-2.json
@@ -48,7 +48,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"PreconditionFailedException"}
],
- "documentation":"<p>Grants an Amazon Web Services service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.</p> <p>To grant permission to another account, specify the account ID as the <code>Principal</code>. For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like <code>s3.amazonaws.com</code> or <code>sns.amazonaws.com</code>. For Amazon Web Services services, you can also specify the ARN of the associated resource as the <code>SourceArn</code>. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.</p> <p>This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html\">Lambda Function Policies</a>. </p>"
+ "documentation":"<p>Grants an Amazon Web Services service, account, or organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.</p> <p>To grant permission to another account, specify the account ID as the <code>Principal</code>. To grant permission to an organization defined in Organizations, specify the organization ID as the <code>PrincipalOrgID</code>. For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like <code>s3.amazonaws.com</code> or <code>sns.amazonaws.com</code>. For Amazon Web Services services, you can also specify the ARN of the associated resource as the <code>SourceArn</code>. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.</p> <p>This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html\">Lambda Function Policies</a>. </p>"
},
"CreateAlias":{
"name":"CreateAlias",
@@ -1002,7 +1002,7 @@
{"shape":"InvalidCodeSignatureException"},
{"shape":"CodeSigningConfigNotFoundException"}
],
- "documentation":"<p>Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-trustedcode.html\">Configuring code signing</a>.</p> <p>The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.</p> <note> <p>For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.</p> </note>"
+ "documentation":"<p>Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-trustedcode.html\">Configuring code signing</a>.</p> <p>If the function's package type is <code>Image</code>, you must specify the code package in <code>ImageUri</code> as the URI of a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html\">container image</a> in the Amazon ECR registry. </p> <p>If the function's package type is <code>Zip</code>, you must specify the deployment package as a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip\">.zip file archive</a>. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the <code>ZipFile</code> field. </p> <p>The code in the deployment package must be compatible with the target instruction set architecture of the function (<code>x86-64</code> or <code>arm64</code>). </p> <p>The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.</p> <note> <p>For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.</p> </note>"
},
"UpdateFunctionConfiguration":{
"name":"UpdateFunctionConfiguration",
@@ -1197,6 +1197,10 @@
"RevisionId":{
"shape":"String",
"documentation":"<p>Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.</p>"
+ },
+ "PrincipalOrgID":{
+ "shape":"PrincipalOrgID",
+ "documentation":"<p>The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.</p>"
}
}
},
@@ -1665,6 +1669,10 @@
"Architectures":{
"shape":"ArchitecturesList",
"documentation":"<p>The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is <code>x86_64</code>.</p>"
+ },
+ "EphemeralStorage":{
+ "shape":"EphemeralStorage",
+ "documentation":"<p>The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.</p>"
}
}
},
@@ -2014,6 +2022,22 @@
"value":{"shape":"EnvironmentVariableValue"},
"sensitive":true
},
+ "EphemeralStorage":{
+ "type":"structure",
+ "required":["Size"],
+ "members":{
+ "Size":{
+ "shape":"EphemeralStorageSize",
+ "documentation":"<p>The size of the function’s /tmp directory.</p>"
+ }
+ },
+ "documentation":"<p>The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.</p>"
+ },
+ "EphemeralStorageSize":{
+ "type":"integer",
+ "max":10240,
+ "min":512
+ },
"EventSourceMappingConfiguration":{
"type":"structure",
"members":{
@@ -2368,6 +2392,10 @@
"Architectures":{
"shape":"ArchitecturesList",
"documentation":"<p>The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is <code>x86_64</code>.</p>"
+ },
+ "EphemeralStorage":{
+ "shape":"EphemeralStorage",
+ "documentation":"<p>The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.</p>"
}
},
"documentation":"<p>Details about a function's configuration.</p>"
@@ -3882,6 +3910,12 @@
"type":"string",
"pattern":"[^\\s]+"
},
+ "PrincipalOrgID":{
+ "type":"string",
+ "max":34,
+ "min":12,
+ "pattern":"^o-[a-z0-9]{10,32}$"
+ },
"ProvisionedConcurrencyConfigList":{
"type":"list",
"member":{"shape":"ProvisionedConcurrencyConfigListItem"}
@@ -4359,6 +4393,7 @@
"dotnetcore2.0",
"dotnetcore2.1",
"dotnetcore3.1",
+ "dotnet6",
"nodejs4.3-edge",
"go1.x",
"ruby2.5",
@@ -4807,15 +4842,15 @@
},
"ZipFile":{
"shape":"Blob",
- "documentation":"<p>The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.</p>"
+ "documentation":"<p>The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.</p>"
},
"S3Bucket":{
"shape":"S3Bucket",
- "documentation":"<p>An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.</p>"
+ "documentation":"<p>An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.</p>"
},
"S3Key":{
"shape":"S3Key",
- "documentation":"<p>The Amazon S3 key of the deployment package.</p>"
+ "documentation":"<p>The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.</p>"
},
"S3ObjectVersion":{
"shape":"S3ObjectVersion",
@@ -4823,7 +4858,7 @@
},
"ImageUri":{
"shape":"String",
- "documentation":"<p>URI of a container image in the Amazon ECR registry.</p>"
+ "documentation":"<p>URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.</p>"
},
"Publish":{
"shape":"Boolean",
@@ -4912,6 +4947,10 @@
"ImageConfig":{
"shape":"ImageConfig",
"documentation":"<p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html\">Container image configuration values</a> that override the values in the container image Docker file.</p>"
+ },
+ "EphemeralStorage":{
+ "shape":"EphemeralStorage",
+ "documentation":"<p>The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.</p>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/waiters-2.json b/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/waiters-2.json
index af39bfc169..b4c18f6431 100644
--- a/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/waiters-2.json
+++ b/contrib/python/botocore/py3/botocore/data/lambda/2015-03-31/waiters-2.json
@@ -22,7 +22,7 @@
"delay": 5,
"maxAttempts": 60,
"operation": "GetFunctionConfiguration",
- "description": "Waits for the function's State to be Active.",
+ "description": "Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.",
"acceptors": [
{
"state": "success",
@@ -48,7 +48,7 @@
"delay": 5,
"maxAttempts": 60,
"operation": "GetFunctionConfiguration",
- "description": "Waits for the function's LastUpdateStatus to be Successful.",
+ "description": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.",
"acceptors": [
{
"state": "success",
@@ -69,6 +69,58 @@
"expected": "InProgress"
}
]
+ },
+ "FunctionActiveV2": {
+ "delay": 1,
+ "maxAttempts": 300,
+ "operation": "GetFunction",
+ "description": "Waits for the function's State to be Active. This waiter uses GetFunction API. This should be used after new function creation.",
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "Configuration.State",
+ "expected": "Active"
+ },
+ {
+ "state": "failure",
+ "matcher": "path",
+ "argument": "Configuration.State",
+ "expected": "Failed"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "Configuration.State",
+ "expected": "Pending"
+ }
+ ]
+ },
+ "FunctionUpdatedV2": {
+ "delay": 1,
+ "maxAttempts": 300,
+ "operation": "GetFunction",
+ "description": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.",
+ "acceptors": [
+ {
+ "state": "success",
+ "matcher": "path",
+ "argument": "Configuration.LastUpdateStatus",
+ "expected": "Successful"
+ },
+ {
+ "state": "failure",
+ "matcher": "path",
+ "argument": "Configuration.LastUpdateStatus",
+ "expected": "Failed"
+ },
+ {
+ "state": "retry",
+ "matcher": "path",
+ "argument": "Configuration.LastUpdateStatus",
+ "expected": "InProgress"
+ }
+ ]
}
}
}
diff --git a/contrib/python/botocore/py3/botocore/data/lexv2-models/2020-08-07/service-2.json b/contrib/python/botocore/py3/botocore/data/lexv2-models/2020-08-07/service-2.json
index 6ade36a082..1738ad91c7 100644
--- a/contrib/python/botocore/py3/botocore/data/lexv2-models/2020-08-07/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/lexv2-models/2020-08-07/service-2.json
@@ -2872,7 +2872,6 @@
"type":"structure",
"required":[
"slotName",
- "slotTypeId",
"valueElicitationSetting",
"botId",
"botVersion",
@@ -8051,7 +8050,6 @@
"required":[
"slotId",
"slotName",
- "slotTypeId",
"valueElicitationSetting",
"botId",
"botVersion",
diff --git a/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json b/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json
index 086059aa1e..125f7e18dc 100644
--- a/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json
@@ -194,7 +194,7 @@
{"shape":"ServiceException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a>GetBucketAccessKeys</a> action to get a list of current access keys for a specific bucket. For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>"
+ "documentation":"<p>Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html\">GetBucketAccessKeys</a> action to get a list of current access keys for a specific bucket. For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>"
},
"CreateCertificate":{
"name":"CreateCertificate",
@@ -488,7 +488,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Creates an SSH key pair.</p> <p>The <code>create key pair</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>"
+ "documentation":"<p>Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.</p> <note> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html\">DownloadDefaultKeyPair</a> action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.</p> </note> <p>The <code>create key pair</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>"
},
"CreateLoadBalancer":{
"name":"CreateLoadBalancer",
@@ -873,7 +873,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Deletes a specific SSH key pair.</p> <p>The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>key pair name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>"
+ "documentation":"<p>Deletes the specified key pair by removing the public key from Amazon Lightsail.</p> <p>You can delete key pairs that were created using the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html\">ImportKeyPair</a> and <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html\">CreateKeyPair</a> actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html\">DownloadDefaultKeyPair</a> API. </p> <p>The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>key pair name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>"
},
"DeleteKnownHostKeys":{
"name":"DeleteKnownHostKeys",
@@ -1080,7 +1080,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Downloads the default SSH key pair from the user's account.</p>"
+ "documentation":"<p>Downloads the regional Amazon Lightsail default key pair.</p> <p>This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.</p>"
},
"EnableAddOn":{
"name":"EnableAddOn",
@@ -1208,7 +1208,7 @@
{"shape":"ServiceException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Returns the existing access key IDs for the specified Amazon Lightsail bucket.</p> <important> <p>This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the <a>CreateBucketAccessKey</a> action. If you lose the secret access key, you must create a new access key.</p> </important>"
+ "documentation":"<p>Returns the existing access key IDs for the specified Amazon Lightsail bucket.</p> <important> <p>This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action. If you lose the secret access key, you must create a new access key.</p> </important>"
},
"GetBucketBundles":{
"name":"GetBucketBundles",
@@ -1224,7 +1224,7 @@
{"shape":"ServiceException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Returns the bundles that you can apply to a Amazon Lightsail bucket.</p> <p>The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.</p> <p>Use the <a>UpdateBucketBundle</a> action to update the bundle for a bucket.</p>"
+ "documentation":"<p>Returns the bundles that you can apply to a Amazon Lightsail bucket.</p> <p>The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html\">UpdateBucketBundle</a> action to update the bundle for a bucket.</p>"
},
"GetBucketMetricData":{
"name":"GetBucketMetricData",
@@ -1653,7 +1653,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Returns all export snapshot records created as a result of the <code>export snapshot</code> operation.</p> <p>An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the <a>CreateCloudFormationStack</a> action.</p>"
+ "documentation":"<p>Returns all export snapshot records created as a result of the <code>export snapshot</code> operation.</p> <p>An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html\">CreateCloudFormationStack</a> action.</p>"
},
"GetInstance":{
"name":"GetInstance",
@@ -2705,7 +2705,7 @@
{"shape":"ServiceException"},
{"shape":"UnauthenticatedException"}
],
- "documentation":"<p>Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the <a>GetBuckets</a> action. The <code>ableToUpdateBundle</code> parameter in the response will indicate whether you can currently update a bucket's bundle.</p> <p>Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.</p>"
+ "documentation":"<p>Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html\">GetBuckets</a> action. The <code>ableToUpdateBundle</code> parameter in the response will indicate whether you can currently update a bucket's bundle.</p> <p>Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.</p>"
},
"UpdateContainerService":{
"name":"UpdateContainerService",
@@ -2877,10 +2877,10 @@
},
"lastUsed":{
"shape":"AccessKeyLastUsed",
- "documentation":"<p>An object that describes the last time the access key was used.</p> <note> <p>This object does not include data in the response of a <a>CreateBucketAccessKey</a> action. If the access key has not been used, the <code>region</code> and <code>serviceName</code> values are <code>N/A</code>, and the <code>lastUsedDate</code> value is null.</p> </note>"
+ "documentation":"<p>An object that describes the last time the access key was used.</p> <note> <p>This object does not include data in the response of a <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action. If the access key has not been used, the <code>region</code> and <code>serviceName</code> values are <code>N/A</code>, and the <code>lastUsedDate</code> value is null.</p> </note>"
}
},
- "documentation":"<p>Describes an access key for an Amazon Lightsail bucket.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a>CreateBucketAccessKey</a> action to create an access key for a specific bucket. For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>"
+ "documentation":"<p>Describes an access key for an Amazon Lightsail bucket.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action to create an access key for a specific bucket. For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>"
},
"AccessKeyLastUsed":{
"type":"structure",
@@ -2898,7 +2898,7 @@
"documentation":"<p>The name of the AWS service with which this access key was most recently used.</p> <p>This value is <code>N/A</code> if the access key has not been used.</p>"
}
},
- "documentation":"<p>Describes the last time an access key was used.</p> <note> <p>This object does not include data in the response of a <a>CreateBucketAccessKey</a> action.</p> </note>"
+ "documentation":"<p>Describes the last time an access key was used.</p> <note> <p>This object does not include data in the response of a <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action.</p> </note>"
},
"AccessKeyList":{
"type":"list",
@@ -3421,7 +3421,7 @@
},
"bundleId":{
"shape":"NonEmptyString",
- "documentation":"<p>The ID of the bundle currently applied to the bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.</p> <p>Use the <a>UpdateBucketBundle</a> action to change the bundle of a bucket.</p>"
+ "documentation":"<p>The ID of the bundle currently applied to the bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html\">UpdateBucketBundle</a> action to change the bundle of a bucket.</p>"
},
"createdAt":{
"shape":"IsoDate",
@@ -3450,7 +3450,7 @@
},
"ableToUpdateBundle":{
"shape":"boolean",
- "documentation":"<p>Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.</p> <p>You can update a bucket's bundle only one time within a monthly AWS billing cycle.</p> <p>Use the <a>UpdateBucketBundle</a> action to change a bucket's bundle.</p>"
+ "documentation":"<p>Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.</p> <p>You can update a bucket's bundle only one time within a monthly AWS billing cycle.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html\">UpdateBucketBundle</a> action to change a bucket's bundle.</p>"
},
"readonlyAccessAccounts":{
"shape":"PartnerIdList",
@@ -3458,7 +3458,7 @@
},
"resourcesReceivingAccess":{
"shape":"AccessReceiverList",
- "documentation":"<p>An array of objects that describe Lightsail instances that have access to the bucket.</p> <p>Use the <a>SetResourceAccessForBucket</a> action to update the instances that have access to a bucket.</p>"
+ "documentation":"<p>An array of objects that describe Lightsail instances that have access to the bucket.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html\">SetResourceAccessForBucket</a> action to update the instances that have access to a bucket.</p>"
},
"state":{
"shape":"BucketState",
@@ -3641,7 +3641,7 @@
"documentation":"<p>The cache behavior for the specified path.</p> <p>You can specify one of the following per-path cache behaviors:</p> <ul> <li> <p> <b> <code>cache</code> </b> - This behavior caches the specified path. </p> </li> <li> <p> <b> <code>dont-cache</code> </b> - This behavior doesn't cache the specified path. </p> </li> </ul>"
}
},
- "documentation":"<p>Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the <code>cacheBehavior</code> is set to <code>cache</code>, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's <code>cacheBehavior</code> is <code>dont-cache</code>, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.</p> <p>if the cacheBehavior's behavior is set to 'cache', then</p>"
+ "documentation":"<p>Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the <code>cacheBehavior</code> is set to <code>cache</code>, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's <code>cacheBehavior</code> is <code>dont-cache</code>, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.</p>"
},
"CacheSettings":{
"type":"structure",
@@ -4502,11 +4502,11 @@
},
"bundleId":{
"shape":"NonEmptyString",
- "documentation":"<p>The ID of the bundle to use for the bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.</p> <p>Use the <a>GetBucketBundles</a> action to get a list of bundle IDs that you can specify.</p> <p>Use the <a>UpdateBucketBundle</a> action to change the bundle after the bucket is created.</p>"
+ "documentation":"<p>The ID of the bundle to use for the bucket.</p> <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html\">GetBucketBundles</a> action to get a list of bundle IDs that you can specify.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html\">UpdateBucketBundle</a> action to change the bundle after the bucket is created.</p>"
},
"tags":{
"shape":"TagList",
- "documentation":"<p>The tag keys and optional values to add to the bucket during creation.</p> <p>Use the <a>TagResource</a> action to tag the bucket after it's created.</p>"
+ "documentation":"<p>The tag keys and optional values to add to the bucket during creation.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html\">TagResource</a> action to tag the bucket after it's created.</p>"
},
"enableObjectVersioning":{
"shape":"boolean",
@@ -4834,7 +4834,7 @@
},
"origin":{
"shape":"InputOrigin",
- "documentation":"<p>An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"
+ "documentation":"<p>An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"
},
"defaultCacheBehavior":{
"shape":"CacheBehavior",
@@ -5414,7 +5414,7 @@
},
"accessKeyId":{
"shape":"NonEmptyString",
- "documentation":"<p>The ID of the access key to delete.</p> <p>Use the <a>GetBucketAccessKeys</a> action to get a list of access key IDs that you can specify.</p>"
+ "documentation":"<p>The ID of the access key to delete.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html\">GetBucketAccessKeys</a> action to get a list of access key IDs that you can specify.</p>"
}
}
},
@@ -5433,11 +5433,11 @@
"members":{
"bucketName":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket to delete.</p> <p>Use the <a>GetBuckets</a> action to get a list of bucket names that you can specify.</p>"
+ "documentation":"<p>The name of the bucket to delete.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html\">GetBuckets</a> action to get a list of bucket names that you can specify.</p>"
},
"forceDelete":{
"shape":"boolean",
- "documentation":"<p>A Boolean value that indicates whether to force delete the bucket.</p> <p>You must force delete the bucket if it has one of the following conditions:</p> <ul> <li> <p>The bucket is the origin of a distribution.</p> </li> <li> <p>The bucket has instances that were granted access to it using the <a>SetResourceAccessForBucket</a> action.</p> </li> <li> <p>The bucket has objects.</p> </li> <li> <p>The bucket has access keys.</p> </li> </ul> <important> <p>Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.</p> </important>"
+ "documentation":"<p>A Boolean value that indicates whether to force delete the bucket.</p> <p>You must force delete the bucket if it has one of the following conditions:</p> <ul> <li> <p>The bucket is the origin of a distribution.</p> </li> <li> <p>The bucket has instances that were granted access to it using the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html\">SetResourceAccessForBucket</a> action.</p> </li> <li> <p>The bucket has objects.</p> </li> <li> <p>The bucket has access keys.</p> </li> </ul> <important> <p>Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.</p> </important>"
}
}
},
@@ -5679,6 +5679,10 @@
"keyPairName":{
"shape":"ResourceName",
"documentation":"<p>The name of the key pair to delete.</p>"
+ },
+ "expectedFingerprint":{
+ "shape":"string",
+ "documentation":"<p>The RSA fingerprint of the Lightsail default key pair to delete.</p> <note> <p>The <code>expectedFingerprint</code> parameter is required only when specifying to delete a Lightsail default key pair.</p> </note>"
}
}
},
@@ -6318,6 +6322,10 @@
"privateKeyBase64":{
"shape":"Base64",
"documentation":"<p>A base64-encoded RSA private key.</p>"
+ },
+ "createdAt":{
+ "shape":"IsoDate",
+ "documentation":"<p>The timestamp when the default key pair was created.</p>"
}
}
},
@@ -6699,7 +6707,7 @@
},
"includeConnectedResources":{
"shape":"boolean",
- "documentation":"<p>A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the <a>SetResourceAccessForBucket</a> action.</p>"
+ "documentation":"<p>A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html\">SetResourceAccessForBucket</a> action.</p>"
}
}
},
@@ -7464,6 +7472,10 @@
"pageToken":{
"shape":"string",
"documentation":"<p>The token to advance to the next page of results from your request.</p> <p>To get a page token, perform an initial <code>GetKeyPairs</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p>"
+ },
+ "includeDefaultKeyPair":{
+ "shape":"boolean",
+ "documentation":"<p>A Boolean value that indicates whether to include the default key pair in the response of your request.</p>"
}
}
},
@@ -8193,7 +8205,7 @@
"documentation":"<p>The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.</p>"
}
},
- "documentation":"<p>Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>An origin can be a Lightsail instance or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.</p>"
+ "documentation":"<p>Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.</p>"
},
"Instance":{
"type":"structure",
@@ -8827,7 +8839,7 @@
},
"origin":{
"shape":"Origin",
- "documentation":"<p>An object that describes the origin resource of the distribution, such as a Lightsail instance or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"
+ "documentation":"<p>An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"
},
"originPublicDNS":{
"shape":"string",
@@ -9632,7 +9644,7 @@
"documentation":"<p>The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.</p>"
}
},
- "documentation":"<p>Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>An origin can be a Lightsail instance or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.</p>"
+ "documentation":"<p>Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.</p>"
},
"OriginProtocolPolicyEnum":{
"type":"string",
@@ -10984,7 +10996,7 @@
},
"bundleId":{
"shape":"NonEmptyString",
- "documentation":"<p>The ID of the new bundle to apply to the bucket.</p> <p>Use the <a>GetBucketBundles</a> action to get a list of bundle IDs that you can specify.</p>"
+ "documentation":"<p>The ID of the new bundle to apply to the bucket.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html\">GetBucketBundles</a> action to get a list of bundle IDs that you can specify.</p>"
}
}
},
@@ -11100,7 +11112,7 @@
},
"origin":{
"shape":"InputOrigin",
- "documentation":"<p>An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"
+ "documentation":"<p>An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.</p> <p>The distribution pulls, caches, and serves content from the origin.</p>"
},
"defaultCacheBehavior":{
"shape":"CacheBehavior",
diff --git a/contrib/python/botocore/py3/botocore/data/location/2020-11-19/paginators-1.json b/contrib/python/botocore/py3/botocore/data/location/2020-11-19/paginators-1.json
index eabc8ede2a..05d55b620b 100644
--- a/contrib/python/botocore/py3/botocore/data/location/2020-11-19/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/location/2020-11-19/paginators-1.json
@@ -3,7 +3,8 @@
"GetDevicePositionHistory": {
"input_token": "NextToken",
"output_token": "NextToken",
- "result_key": "DevicePositions"
+ "result_key": "DevicePositions",
+ "limit_key": "MaxResults"
},
"ListGeofenceCollections": {
"input_token": "NextToken",
diff --git a/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json b/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json
index 58af9261ee..079aa194b6 100644
--- a/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json
@@ -1799,7 +1799,7 @@
},
"AvoidTolls":{
"shape":"Boolean",
- "documentation":"<p>Avoids ferries when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>"
+ "documentation":"<p>Avoids tolls when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>"
},
"Dimensions":{
"shape":"TruckDimensions",
@@ -2588,7 +2588,7 @@
},
"Position":{
"shape":"Position",
- "documentation":"<p>The latest device position defined in <a href=\"https://earth-info.nga.mil/GandG/wgs84/index.html\">WGS 84</a> format: <code>[X or longitude, Y or latitude]</code>.</p>"
+ "documentation":"<p>The latest device position defined in <a href=\"https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84\">WGS 84</a> format: <code>[X or longitude, Y or latitude]</code>.</p>"
},
"PositionProperties":{
"shape":"PropertyMap",
@@ -2672,6 +2672,10 @@
"shape":"Timestamp",
"documentation":"<p>Specify the end time for the position history in <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time that the request is made.</p> <p>Requirement:</p> <ul> <li> <p>The time specified for <code>EndTimeExclusive</code> must be after the time for <code>StartTimeInclusive</code>.</p> </li> </ul>"
},
+ "MaxResults":{
+ "shape":"GetDevicePositionHistoryRequestMaxResultsInteger",
+ "documentation":"<p>An optional limit for the number of device positions returned in a single call.</p> <p>Default value: <code>100</code> </p>"
+ },
"NextToken":{
"shape":"Token",
"documentation":"<p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </p> <p>Default value: <code>null</code> </p>"
@@ -2688,6 +2692,12 @@
}
}
},
+ "GetDevicePositionHistoryRequestMaxResultsInteger":{
+ "type":"integer",
+ "box":true,
+ "max":100,
+ "min":1
+ },
"GetDevicePositionHistoryResponse":{
"type":"structure",
"required":["DevicePositions"],
@@ -2820,7 +2830,7 @@
"members":{
"FontStack":{
"shape":"String",
- "documentation":"<p>A comma-separated list of fonts to load glyphs from in order of preference. For example, <code>Noto Sans Regular, Arial Unicode</code>.</p> <p>Valid fonts stacks for <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/esri.html\">Esri</a> styles: </p> <ul> <li> <p>VectorEsriDarkGrayCanvas – <code>Ubuntu Medium Italic</code> | <code>Ubuntu Medium</code> | <code>Ubuntu Italic</code> | <code>Ubuntu Regular</code> | <code>Ubuntu Bold</code> </p> </li> <li> <p>VectorEsriLightGrayCanvas – <code>Ubuntu Italic</code> | <code>Ubuntu Regular</code> | <code>Ubuntu Light</code> | <code>Ubuntu Bold</code> </p> </li> <li> <p>VectorEsriTopographic – <code>Noto Sans Italic</code> | <code>Noto Sans Regular</code> | <code>Noto Sans Bold</code> | <code>Noto Serif Regular</code> | <code>Roboto Condensed Light Italic</code> </p> </li> <li> <p>VectorEsriStreets – <code>Arial Regular</code> | <code>Arial Italic</code> | <code>Arial Bold</code> </p> </li> <li> <p>VectorEsriNavigation – <code>Arial Regular</code> | <code>Arial Italic</code> | <code>Arial Bold</code> </p> </li> </ul> <p>Valid font stacks for <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/HERE.html\">HERE Technologies</a> styles: </p> <ul> <li> <p>VectorHereBerlin – <code>Fira GO Regular</code> | <code>Fira GO Bold</code> </p> </li> </ul>",
+ "documentation":"<p>A comma-separated list of fonts to load glyphs from in order of preference. For example, <code>Noto Sans Regular, Arial Unicode</code>.</p> <p>Valid fonts stacks for <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/esri.html\">Esri</a> styles: </p> <ul> <li> <p>VectorEsriDarkGrayCanvas – <code>Ubuntu Medium Italic</code> | <code>Ubuntu Medium</code> | <code>Ubuntu Italic</code> | <code>Ubuntu Regular</code> | <code>Ubuntu Bold</code> </p> </li> <li> <p>VectorEsriLightGrayCanvas – <code>Ubuntu Italic</code> | <code>Ubuntu Regular</code> | <code>Ubuntu Light</code> | <code>Ubuntu Bold</code> </p> </li> <li> <p>VectorEsriTopographic – <code>Noto Sans Italic</code> | <code>Noto Sans Regular</code> | <code>Noto Sans Bold</code> | <code>Noto Serif Regular</code> | <code>Roboto Condensed Light Italic</code> </p> </li> <li> <p>VectorEsriStreets – <code>Arial Regular</code> | <code>Arial Italic</code> | <code>Arial Bold</code> </p> </li> <li> <p>VectorEsriNavigation – <code>Arial Regular</code> | <code>Arial Italic</code> | <code>Arial Bold</code> </p> </li> </ul> <p>Valid font stacks for <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/HERE.html\">HERE Technologies</a> styles: </p> <ul> <li> <p>VectorHereBerlin – <code>Fira GO Regular</code> | <code>Fira GO Bold</code> </p> </li> <li> <p>VectorHereExplore, VectorHereExploreTruck – <code>Firo GO Italic</code> | <code>Fira GO Map</code> | <code>Fira GO Map Bold</code> | <code>Noto Sans CJK JP Bold</code> | <code>Noto Sans CJK JP Light</code> | <code>Noto Sans CJK JP Regular</code> </p> </li> </ul>",
"location":"uri",
"locationName":"FontStack"
},
@@ -3699,7 +3709,7 @@
"members":{
"Style":{
"shape":"MapStyle",
- "documentation":"<p>Specifies the map style selected from an available data provider.</p> <p>Valid <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/esri.html\">Esri map styles</a>:</p> <ul> <li> <p> <code>VectorEsriDarkGrayCanvas</code> – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content. </p> </li> <li> <p> <code>RasterEsriImagery</code> – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide. </p> </li> <li> <p> <code>VectorEsriLightGrayCanvas</code> – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content. </p> </li> <li> <p> <code>VectorEsriTopographic</code> – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.</p> </li> <li> <p> <code>VectorEsriStreets</code> – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.</p> </li> <li> <p> <code>VectorEsriNavigation</code> – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.</p> </li> </ul> <p>Valid <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/HERE.html\">HERE Technologies map styles</a>:</p> <ul> <li> <p> <code>VectorHereBerlin</code> – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.</p> <note> <p>When using HERE as your data provider, and selecting the Style <code>VectorHereBerlin</code>, you may not use HERE Technologies maps for Asset Management. See the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> for Amazon Location Service.</p> </note> </li> </ul>"
+ "documentation":"<p>Specifies the map style selected from an available data provider.</p> <p>Valid <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/esri.html\">Esri map styles</a>:</p> <ul> <li> <p> <code>VectorEsriDarkGrayCanvas</code> – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content. </p> </li> <li> <p> <code>RasterEsriImagery</code> – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide. </p> </li> <li> <p> <code>VectorEsriLightGrayCanvas</code> – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content. </p> </li> <li> <p> <code>VectorEsriTopographic</code> – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.</p> </li> <li> <p> <code>VectorEsriStreets</code> – The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.</p> </li> <li> <p> <code>VectorEsriNavigation</code> – The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.</p> </li> </ul> <p>Valid <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/HERE.html\">HERE Technologies map styles</a>:</p> <ul> <li> <p> <code>VectorHereBerlin</code> – The HERE Berlin map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.</p> </li> <li> <p> <code>VectorHereExplore</code> – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.</p> </li> <li> <p> <code>VectorHereExploreTruck</code> – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.</p> </li> </ul>"
}
},
"documentation":"<p>Specifies the map tile style selected from an available provider.</p>"
@@ -3930,7 +3940,7 @@
"documentation":"<p>An error corresponding to the calculation of a route between the <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>"
}
},
- "documentation":"<p>The result for one <code>SnappedDeparturePosition</code> <code>SnappedDestinationPosition</code> pair.</p>"
+ "documentation":"<p>The result for the calculated route of one <code>DeparturePosition</code> <code>DestinationPosition</code> pair.</p>"
},
"RouteMatrixEntryDistanceDouble":{
"type":"double",
diff --git a/contrib/python/botocore/py3/botocore/data/macie/2017-12-19/service-2.json b/contrib/python/botocore/py3/botocore/data/macie/2017-12-19/service-2.json
index 5d040fd113..08d5be4182 100644
--- a/contrib/python/botocore/py3/botocore/data/macie/2017-12-19/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/macie/2017-12-19/service-2.json
@@ -24,7 +24,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalException"}
],
- "documentation":"<p>Associates a specified AWS account with Amazon Macie Classic as a member account.</p>"
+ "documentation":"<p>(Discontinued) Associates a specified Amazon Web Services account with Amazon Macie Classic as a member account.</p>"
},
"AssociateS3Resources":{
"name":"AssociateS3Resources",
@@ -40,7 +40,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalException"}
],
- "documentation":"<p>Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action associates specified S3 resources with Macie Classic for the specified member account. </p>"
+ "documentation":"<p>(Discontinued) Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification. If <code>memberAccountId</code> isn't specified, the action associates specified S3 resources with Macie Classic for the current Macie Classic administrator account. If <code>memberAccountId</code> is specified, the action associates specified S3 resources with Macie Classic for the specified member account.</p>"
},
"DisassociateMemberAccount":{
"name":"DisassociateMemberAccount",
@@ -53,7 +53,7 @@
{"shape":"InvalidInputException"},
{"shape":"InternalException"}
],
- "documentation":"<p>Removes the specified member account from Amazon Macie Classic.</p>"
+ "documentation":"<p>(Discontinued) Removes the specified member account from Amazon Macie Classic.</p>"
},
"DisassociateS3Resources":{
"name":"DisassociateS3Resources",
@@ -68,7 +68,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
- "documentation":"<p>Removes specified S3 resources from being monitored by Amazon Macie Classic. If memberAccountId isn't specified, the action removes specified S3 resources from Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action removes specified S3 resources from Macie Classic for the specified member account.</p>"
+ "documentation":"<p>(Discontinued) Removes specified S3 resources from being monitored by Amazon Macie Classic. If <code>memberAccountId</code> isn't specified, the action removes specified S3 resources from Macie Classic for the current Macie Classic administrator account. If <code>memberAccountId</code> is specified, the action removes specified S3 resources from Macie Classic for the specified member account.</p>"
},
"ListMemberAccounts":{
"name":"ListMemberAccounts",
@@ -82,7 +82,7 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"}
],
- "documentation":"<p>Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.</p>"
+ "documentation":"<p>(Discontinued) Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.</p>"
},
"ListS3Resources":{
"name":"ListS3Resources",
@@ -97,7 +97,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
- "documentation":"<p>Lists all the S3 resources associated with Amazon Macie Classic. If memberAccountId isn't specified, the action lists the S3 resources associated with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action lists the S3 resources associated with Macie Classic for the specified member account. </p>"
+ "documentation":"<p>(Discontinued) Lists all the S3 resources associated with Amazon Macie Classic. If <code>memberAccountId</code> isn't specified, the action lists the S3 resources associated with Macie Classic for the current Macie Classic administrator account. If <code>memberAccountId</code> is specified, the action lists the S3 resources associated with Macie Classic for the specified member account. </p>"
},
"UpdateS3Resources":{
"name":"UpdateS3Resources",
@@ -112,7 +112,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
- "documentation":"<p>Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Macie Classic for the specified member account. </p>"
+ "documentation":"<p>(Discontinued) Updates the classification types for the specified S3 resources. If <code>memberAccountId</code> isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the current Macie Classic administrator account. If <code>memberAccountId</code> is specified, the action updates the classification types of the S3 resources associated with Macie Classic for the specified member account.</p>"
}
},
"shapes":{
@@ -126,7 +126,7 @@
"message":{"shape":"ExceptionMessage"},
"resourceType":{"shape":"ResourceType"}
},
- "documentation":"<p>You do not have required permissions to access the requested resource.</p>",
+ "documentation":"<p>(Discontinued) You do not have required permissions to access the requested resource.</p>",
"exception":true
},
"AssociateMemberAccountRequest":{
@@ -135,7 +135,7 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The ID of the AWS account that you want to associate with Amazon Macie Classic as a member account.</p>"
+ "documentation":"<p>(Discontinued) The ID of the Amazon Web Services account that you want to associate with Amazon Macie Classic as a member account.</p>"
}
}
},
@@ -145,11 +145,11 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The ID of the Amazon Macie Classic member account whose resources you want to associate with Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) The ID of the Amazon Macie Classic member account whose resources you want to associate with Macie Classic.</p>"
},
"s3Resources":{
"shape":"S3ResourcesClassification",
- "documentation":"<p>The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification. </p>"
+ "documentation":"<p>(Discontinued) The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification.</p>"
}
}
},
@@ -158,7 +158,7 @@
"members":{
"failedS3Resources":{
"shape":"FailedS3Resources",
- "documentation":"<p>S3 resources that couldn't be associated with Amazon Macie Classic. An error code and an error message are provided for each failed item. </p>"
+ "documentation":"<p>(Discontinued) S3 resources that couldn't be associated with Amazon Macie Classic. An error code and an error message are provided for each failed item.</p>"
}
}
},
@@ -175,28 +175,28 @@
"members":{
"oneTime":{
"shape":"S3OneTimeClassificationType",
- "documentation":"<p>A one-time classification of all of the existing objects in a specified S3 bucket. </p>"
+ "documentation":"<p>(Discontinued) A one-time classification of all of the existing objects in a specified S3 bucket. </p>"
},
"continuous":{
"shape":"S3ContinuousClassificationType",
- "documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Macie Classic.</p>"
}
},
- "documentation":"<p>The classification type that Amazon Macie Classic applies to the associated S3 resources. </p>"
+ "documentation":"<p>(Discontinued) The classification type that Amazon Macie Classic applies to the associated S3 resources.</p>"
},
"ClassificationTypeUpdate":{
"type":"structure",
"members":{
"oneTime":{
"shape":"S3OneTimeClassificationType",
- "documentation":"<p>A one-time classification of all of the existing objects in a specified S3 bucket. </p>"
+ "documentation":"<p>(Discontinued) A one-time classification of all of the existing objects in a specified S3 bucket. </p>"
},
"continuous":{
"shape":"S3ContinuousClassificationType",
- "documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Macie Classic. </p>"
}
},
- "documentation":"<p>The classification type that Amazon Macie Classic applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified. </p>"
+ "documentation":"<p>(Discontinued) The classification type that Amazon Macie Classic applies to the associated S3 resources. At least one of the classification types (<code>oneTime</code> or <code>continuous</code>) must be specified. </p>"
},
"DisassociateMemberAccountRequest":{
"type":"structure",
@@ -204,7 +204,7 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The ID of the member account that you want to remove from Amazon Macie Classic.</p>"
+ "documentation":"<p>(Discontinued) The ID of the member account that you want to remove from Amazon Macie Classic.</p>"
}
}
},
@@ -214,11 +214,11 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The ID of the Amazon Macie Classic member account whose resources you want to remove from being monitored by Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) The ID of the Amazon Macie Classic member account whose resources you want to remove from being monitored by Macie Classic.</p>"
},
"associatedS3Resources":{
"shape":"S3Resources",
- "documentation":"<p>The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie Classic.</p>"
}
}
},
@@ -227,7 +227,7 @@
"members":{
"failedS3Resources":{
"shape":"FailedS3Resources",
- "documentation":"<p>S3 resources that couldn't be removed from being monitored and classified by Amazon Macie Classic. An error code and an error message are provided for each failed item. </p>"
+ "documentation":"<p>(Discontinued) S3 resources that couldn't be removed from being monitored and classified by Amazon Macie Classic. An error code and an error message are provided for each failed item. </p>"
}
}
},
@@ -245,18 +245,18 @@
"members":{
"failedItem":{
"shape":"S3Resource",
- "documentation":"<p>The failed S3 resources.</p>"
+ "documentation":"<p>(Discontinued) The failed S3 resources.</p>"
},
"errorCode":{
"shape":"ErrorCode",
- "documentation":"<p>The status code of a failed item.</p>"
+ "documentation":"<p>(Discontinued) The status code of a failed item.</p>"
},
"errorMessage":{
"shape":"ExceptionMessage",
- "documentation":"<p>The error message of a failed item.</p>"
+ "documentation":"<p>(Discontinued) The error message of a failed item.</p>"
}
},
- "documentation":"<p>Includes details about the failed S3 resources.</p>"
+ "documentation":"<p>(Discontinued) Includes details about the failed S3 resources.</p>"
},
"FailedS3Resources":{
"type":"list",
@@ -273,7 +273,7 @@
"errorCode":{"shape":"ErrorCode"},
"message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>Internal server error.</p>",
+ "documentation":"<p>(Discontinued) Internal server error.</p>",
"exception":true,
"fault":true
},
@@ -284,7 +284,7 @@
"message":{"shape":"ExceptionMessage"},
"fieldName":{"shape":"FieldName"}
},
- "documentation":"<p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </p>",
+ "documentation":"<p>(Discontinued) The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>",
"exception":true
},
"LimitExceededException":{
@@ -294,7 +294,7 @@
"message":{"shape":"ExceptionMessage"},
"resourceType":{"shape":"ResourceType"}
},
- "documentation":"<p>The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded. </p>",
+ "documentation":"<p>(Discontinued) The request was rejected because it attempted to create resources beyond the current Amazon Web Services account quotas. The error code describes the quota exceeded.</p>",
"exception":true
},
"ListMemberAccountsRequest":{
@@ -302,11 +302,11 @@
"members":{
"nextToken":{
"shape":"NextToken",
- "documentation":"<p>Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. </p>"
+ "documentation":"<p>(Discontinued) Use this parameter when paginating results. Set the value of this parameter to null on your first call to the <code>ListMemberAccounts</code> action. Subsequent calls to the action fill <code>nextToken</code> in the request with the value of <code>nextToken</code> from the previous response to continue listing data.</p>"
},
"maxResults":{
"shape":"MaxResults",
- "documentation":"<p>Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. </p>"
+ "documentation":"<p>(Discontinued) Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.</p>"
}
}
},
@@ -315,11 +315,11 @@
"members":{
"memberAccounts":{
"shape":"MemberAccounts",
- "documentation":"<p>A list of the Amazon Macie Classic member accounts returned by the action. The current Macie Classic administrator account is also included in this list. </p>"
+ "documentation":"<p>(Discontinued) A list of the Amazon Macie Classic member accounts returned by the action. The current Macie Classic administrator account is also included in this list.</p>"
},
"nextToken":{
"shape":"NextToken",
- "documentation":"<p>When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. </p>"
+ "documentation":"<p>(Discontinued) When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the <code>nextToken</code> parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. </p>"
}
}
},
@@ -328,15 +328,15 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The Amazon Macie Classic member account ID whose associated S3 resources you want to list. </p>"
+ "documentation":"<p>(Discontinued) The Amazon Macie Classic member account ID whose associated S3 resources you want to list. </p>"
},
"nextToken":{
"shape":"NextToken",
- "documentation":"<p>Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. </p>"
+ "documentation":"<p>(Discontinued) Use this parameter when paginating results. Set its value to null on your first call to the <code>ListS3Resources</code> action. Subsequent calls to the action fill <code>nextToken</code> in the request with the value of <code>nextToken</code> from the previous response to continue listing data. </p>"
},
"maxResults":{
"shape":"MaxResults",
- "documentation":"<p>Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. </p>"
+ "documentation":"<p>(Discontinued) Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. </p>"
}
}
},
@@ -345,11 +345,11 @@
"members":{
"s3Resources":{
"shape":"S3ResourcesClassification",
- "documentation":"<p>A list of the associated S3 resources returned by the action.</p>"
+ "documentation":"<p>(Discontinued) A list of the associated S3 resources returned by the action.</p>"
},
"nextToken":{
"shape":"NextToken",
- "documentation":"<p>When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. </p>"
+ "documentation":"<p>(Discontinued) When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the <code>nextToken</code> parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. </p>"
}
}
},
@@ -363,10 +363,10 @@
"members":{
"accountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The AWS account ID of the Amazon Macie Classic member account.</p>"
+ "documentation":"<p>(Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic member account.</p>"
}
},
- "documentation":"<p>Contains information about the Amazon Macie Classic member account.</p>"
+ "documentation":"<p>(Discontinued) Contains information about the Amazon Macie Classic member account.</p>"
},
"MemberAccounts":{
"type":"list",
@@ -402,14 +402,14 @@
"members":{
"bucketName":{
"shape":"BucketName",
- "documentation":"<p>The name of the S3 bucket.</p>"
+ "documentation":"<p>(Discontinued) The name of the S3 bucket.</p>"
},
"prefix":{
"shape":"Prefix",
- "documentation":"<p>The prefix of the S3 bucket. </p>"
+ "documentation":"<p>(Discontinued) The prefix of the S3 bucket.</p>"
}
},
- "documentation":"<p>Contains information about the S3 resource. This data type is used as a request parameter in the DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and UpdateS3Resources actions. </p>"
+ "documentation":"<p>(Discontinued) Contains information about the S3 resource. This data type is used as a request parameter in the <code>DisassociateS3Resources</code> action and can be used as a response parameter in the <code>AssociateS3Resources</code> and <code>UpdateS3Resources</code> actions. </p>"
},
"S3ResourceClassification":{
"type":"structure",
@@ -420,18 +420,18 @@
"members":{
"bucketName":{
"shape":"BucketName",
- "documentation":"<p>The name of the S3 bucket that you want to associate with Amazon Macie Classic.</p>"
+ "documentation":"<p>(Discontinued) The name of the S3 bucket that you want to associate with Amazon Macie Classic.</p>"
},
"prefix":{
"shape":"Prefix",
- "documentation":"<p>The prefix of the S3 bucket that you want to associate with Amazon Macie Classic.</p>"
+ "documentation":"<p>(Discontinued) The prefix of the S3 bucket that you want to associate with Amazon Macie Classic.</p>"
},
"classificationType":{
"shape":"ClassificationType",
- "documentation":"<p>The classification type that you want to specify for the resource associated with Amazon Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) The classification type that you want to specify for the resource associated with Amazon Macie Classic. </p>"
}
},
- "documentation":"<p>The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action. </p>"
+ "documentation":"<p>(Discontinued) The S3 resources that you want to associate with Amazon Macie Classic for monitoring and data classification. This data type is used as a request parameter in the <code>AssociateS3Resources</code> action and a response parameter in the <code>ListS3Resources</code> action. </p>"
},
"S3ResourceClassificationUpdate":{
"type":"structure",
@@ -442,18 +442,18 @@
"members":{
"bucketName":{
"shape":"BucketName",
- "documentation":"<p>The name of the S3 bucket whose classification types you want to update.</p>"
+ "documentation":"<p>(Discontinued) The name of the S3 bucket whose classification types you want to update.</p>"
},
"prefix":{
"shape":"Prefix",
- "documentation":"<p>The prefix of the S3 bucket whose classification types you want to update.</p>"
+ "documentation":"<p>(Discontinued) The prefix of the S3 bucket whose classification types you want to update.</p>"
},
"classificationTypeUpdate":{
"shape":"ClassificationTypeUpdate",
- "documentation":"<p>The classification type that you want to update for the resource associated with Amazon Macie Classic. </p>"
+ "documentation":"<p>(Discontinued) The classification type that you want to update for the resource associated with Amazon Macie Classic. </p>"
}
},
- "documentation":"<p>The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action. </p>"
+ "documentation":"<p>(Discontinued) The S3 resources whose classification types you want to update. This data type is used as a request parameter in the <code>UpdateS3Resources</code> action. </p>"
},
"S3Resources":{
"type":"list",
@@ -473,11 +473,11 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
- "documentation":"<p>The AWS ID of the Amazon Macie Classic member account whose S3 resources' classification types you want to update. </p>"
+ "documentation":"<p>(Discontinued) The Amazon Web Services account ID of the Amazon Macie Classic member account whose S3 resources' classification types you want to update.</p>"
},
"s3ResourcesUpdate":{
"shape":"S3ResourcesClassificationUpdate",
- "documentation":"<p>The S3 resources whose classification types you want to update.</p>"
+ "documentation":"<p>(Discontinued) The S3 resources whose classification types you want to update.</p>"
}
}
},
@@ -486,10 +486,10 @@
"members":{
"failedS3Resources":{
"shape":"FailedS3Resources",
- "documentation":"<p>The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item. </p>"
+ "documentation":"<p>(Discontinued) The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item.</p>"
}
}
}
},
- "documentation":"<fullname>Amazon Macie Classic</fullname> <p>Amazon Macie Classic is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie Classic recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the <a href=\"https://docs.aws.amazon.com/macie/latest/userguide/what-is-macie.html\">Amazon Macie Classic User Guide</a>. </p>"
+ "documentation":"<fullname>Amazon Macie Classic</fullname> <p>Amazon Macie Classic has been discontinued and is no longer available.</p> <p>A new Amazon Macie is now available with significant design improvements and additional features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see <a href=\"http://aws.amazon.com/macie/\">Amazon Macie</a>. To learn how to use the new Macie, see the <a href=\"https://docs.aws.amazon.com/macie/latest/user/what-is-macie.html\">Amazon Macie User Guide</a>.</p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/mediaconnect/2018-11-14/service-2.json b/contrib/python/botocore/py3/botocore/data/mediaconnect/2018-11-14/service-2.json
index aade80949e..50d178e2a1 100644
--- a/contrib/python/botocore/py3/botocore/data/mediaconnect/2018-11-14/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/mediaconnect/2018-11-14/service-2.json
@@ -1360,6 +1360,26 @@
}
}
},
+ "AddMaintenance": {
+ "type": "structure",
+ "members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday."
+ },
+ "MaintenanceStartHour": {
+ "shape": "__string",
+ "locationName": "maintenanceStartHour",
+ "documentation": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00."
+ }
+ },
+ "documentation": "Create maintenance setting for a flow",
+ "required": [
+ "MaintenanceDay",
+ "MaintenanceStartHour"
+ ]
+ },
"AddMediaStreamRequest": {
"type": "structure",
"members": {
@@ -1590,6 +1610,10 @@
"shape": "__listOfVpcInterfaceRequest",
"locationName": "vpcInterfaces",
"documentation": "The VPC interfaces you want on the flow."
+ },
+ "Maintenance": {
+ "shape": "AddMaintenance",
+ "locationName": "maintenance"
}
},
"documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).",
@@ -2031,6 +2055,10 @@
"shape": "__listOfVpcInterface",
"locationName": "vpcInterfaces",
"documentation": "The VPC Interfaces for this flow."
+ },
+ "Maintenance": {
+ "shape": "Maintenance",
+ "locationName": "maintenance"
}
},
"documentation": "The settings for a flow, including its source, outputs, and entitlements.",
@@ -2546,6 +2574,10 @@
"shape": "Status",
"locationName": "status",
"documentation": "The current status of the flow."
+ },
+ "Maintenance": {
+ "shape": "Maintenance",
+ "locationName": "maintenance"
}
},
"documentation": "Provides a summary of a flow, including its ARN, Availability Zone, and source type.",
@@ -2558,6 +2590,44 @@
"Name"
]
},
+ "Maintenance": {
+ "type": "structure",
+ "members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday."
+ },
+ "MaintenanceDeadline": {
+ "shape": "__string",
+ "locationName": "maintenanceDeadline",
+ "documentation": "The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z."
+ },
+ "MaintenanceScheduledDate": {
+ "shape": "__string",
+ "locationName": "maintenanceScheduledDate",
+ "documentation": "A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30."
+ },
+ "MaintenanceStartHour": {
+ "shape": "__string",
+ "locationName": "maintenanceStartHour",
+ "documentation": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00."
+ }
+ },
+ "documentation": "The maintenance setting of a flow"
+ },
+ "MaintenanceDay": {
+ "type": "string",
+ "enum": [
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday",
+ "Sunday"
+ ]
+ },
"MaxResults": {
"type": "integer",
"min": 1,
@@ -4067,6 +4137,10 @@
"SourceFailoverConfig": {
"shape": "UpdateFailoverConfig",
"locationName": "sourceFailoverConfig"
+ },
+ "Maintenance": {
+ "shape": "UpdateMaintenance",
+ "locationName": "maintenance"
}
},
"documentation": "A request to update flow.",
@@ -4195,6 +4269,27 @@
}
}
},
+ "UpdateMaintenance": {
+ "type": "structure",
+ "members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday."
+ },
+ "MaintenanceScheduledDate": {
+ "shape": "__string",
+ "locationName": "maintenanceScheduledDate",
+ "documentation": "A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30."
+ },
+ "MaintenanceStartHour": {
+ "shape": "__string",
+ "locationName": "maintenanceStartHour",
+ "documentation": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00."
+ }
+ },
+ "documentation": "Update maintenance setting for a flow"
+ },
"VpcInterface": {
"type": "structure",
"members": {
diff --git a/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json b/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json
index bb51238397..9e22587a94 100644
--- a/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json
@@ -3149,14 +3149,14 @@
"TimedMetadata": {
"shape": "CmfcTimedMetadata",
"locationName": "timedMetadata",
- "documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output."
+ "documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank."
}
},
"documentation": "These settings relate to the fragmented MP4 container for the segments in your CMAF outputs."
},
"CmfcTimedMetadata": {
"type": "string",
- "documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.",
+ "documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.",
"enum": [
"PASSTHROUGH",
"NONE"
@@ -4891,6 +4891,14 @@
"DISABLED"
]
},
+ "EmbeddedTimecodeOverride": {
+ "type": "string",
+ "documentation": "Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USE_MDPM) when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata (MDPM). When you do, we recommend you also set Timecode source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override blank, or set to None (NONE), when your input does not contain MDPM timecode.",
+ "enum": [
+ "NONE",
+ "USE_MDPM"
+ ]
+ },
"Endpoint": {
"type": "structure",
"members": {
@@ -6291,6 +6299,14 @@
"NONE"
]
},
+ "HlsCaptionSegmentLengthControl": {
+ "type": "string",
+ "documentation": "Set Caption segment length control (CaptionSegmentLengthControl) to Match video (MATCH_VIDEO) to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments (LARGE_SEGMENTS) to create caption segments that are 300 seconds long.",
+ "enum": [
+ "LARGE_SEGMENTS",
+ "MATCH_VIDEO"
+ ]
+ },
"HlsClientCache": {
"type": "string",
"documentation": "Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.",
@@ -6405,6 +6421,11 @@
"locationName": "captionLanguageSetting",
"documentation": "Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest."
},
+ "CaptionSegmentLengthControl": {
+ "shape": "HlsCaptionSegmentLengthControl",
+ "locationName": "captionSegmentLengthControl",
+ "documentation": "Set Caption segment length control (CaptionSegmentLengthControl) to Match video (MATCH_VIDEO) to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments (LARGE_SEGMENTS) to create caption segments that are 300 seconds long."
+ },
"ClientCache": {
"shape": "HlsClientCache",
"locationName": "clientCache",
@@ -6513,12 +6534,12 @@
"TimedMetadataId3Frame": {
"shape": "HlsTimedMetadataId3Frame",
"locationName": "timedMetadataId3Frame",
- "documentation": "Indicates ID3 frame that has the timecode."
+ "documentation": "Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (NONE)."
},
"TimedMetadataId3Period": {
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "timedMetadataId3Period",
- "documentation": "Timed Metadata interval in seconds."
+ "documentation": "Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type (timedMetadataId3Frame) to PRIV (PRIV) or TDRL (TDRL), and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH)."
},
"TimestampDeltaMilliseconds": {
"shape": "__integerMinNegative2147483648Max2147483647",
@@ -6742,7 +6763,7 @@
},
"HlsTimedMetadataId3Frame": {
"type": "string",
- "documentation": "Indicates ID3 frame that has the timecode.",
+ "documentation": "Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (NONE).",
"enum": [
"NONE",
"PRIV",
@@ -6776,7 +6797,7 @@
"Id3": {
"shape": "__stringPatternAZaZ0902",
"locationName": "id3",
- "documentation": "Use ID3 tag (Id3) to provide a tag value in base64-encode format."
+ "documentation": "Use ID3 tag (Id3) to provide a fully formed ID3 tag in base64-encode format."
},
"Timecode": {
"shape": "__stringPattern010920405090509092",
@@ -6799,7 +6820,7 @@
},
"ImscAccessibilitySubs": {
"type": "string",
- "documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out.",
+ "documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.",
"enum": [
"DISABLED",
"ENABLED"
@@ -6811,7 +6832,7 @@
"Accessibility": {
"shape": "ImscAccessibilitySubs",
"locationName": "accessibility",
- "documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out."
+ "documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes."
},
"StylePassthrough": {
"shape": "ImscStylePassthrough",
@@ -7452,7 +7473,7 @@
"TimedMetadataInsertion": {
"shape": "TimedMetadataInsertion",
"locationName": "timedMetadataInsertion",
- "documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects."
+ "documentation": "Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH)."
}
},
"documentation": "JobSettings contains all the transcode settings for a job."
@@ -7613,7 +7634,7 @@
"TimedMetadataInsertion": {
"shape": "TimedMetadataInsertion",
"locationName": "timedMetadataInsertion",
- "documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects."
+ "documentation": "Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH)."
}
},
"documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it."
@@ -8549,12 +8570,12 @@
"TimedMetadata": {
"shape": "TimedMetadata",
"locationName": "timedMetadata",
- "documentation": "Applies to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output."
+ "documentation": "Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank."
},
"TimedMetadataPid": {
"shape": "__integerMin32Max8182",
"locationName": "timedMetadataPid",
- "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream."
+ "documentation": "Packet Identifier (PID) of the ID3 metadata stream in the transport stream."
},
"TransportStreamId": {
"shape": "__integerMin0Max65535",
@@ -8915,14 +8936,14 @@
"TimedMetadata": {
"shape": "MpdTimedMetadata",
"locationName": "timedMetadata",
- "documentation": "Applies to DASH outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output."
+ "documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank."
}
},
"documentation": "These settings relate to the fragmented MP4 container for the segments in your DASH outputs."
},
"MpdTimedMetadata": {
"type": "string",
- "documentation": "Applies to DASH outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.",
+ "documentation": "To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.",
"enum": [
"PASSTHROUGH",
"NONE"
@@ -9549,7 +9570,7 @@
},
"NoiseFilterPostTemporalSharpening": {
"type": "string",
- "documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.",
+ "documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the bandwidth and sharpness of your output is reduced. You can optionally use Post temporal sharpening (postTemporalSharpening) to apply sharpening to the edges of your output. Note that Post temporal sharpening will also make the bandwidth reduction from the Noise reducer smaller. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (postTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.",
"enum": [
"DISABLED",
"ENABLED",
@@ -9558,7 +9579,7 @@
},
"NoiseFilterPostTemporalSharpeningStrength": {
"type": "string",
- "documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.",
+ "documentation": "Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), Medium (MEDIUM), or High (HIGH) to indicate the amount of sharpening.",
"enum": [
"LOW",
"MEDIUM",
@@ -9648,12 +9669,12 @@
"PostTemporalSharpening": {
"shape": "NoiseFilterPostTemporalSharpening",
"locationName": "postTemporalSharpening",
- "documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening."
+ "documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the bandwidth and sharpness of your output is reduced. You can optionally use Post temporal sharpening (postTemporalSharpening) to apply sharpening to the edges of your output. Note that Post temporal sharpening will also make the bandwidth reduction from the Noise reducer smaller. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (postTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening."
},
"PostTemporalSharpeningStrength": {
"shape": "NoiseFilterPostTemporalSharpeningStrength",
"locationName": "postTemporalSharpeningStrength",
- "documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening."
+ "documentation": "Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), Medium (MEDIUM), or High (HIGH) to indicate the amount of sharpening."
},
"Speed": {
"shape": "__integerMinNegative1Max3",
@@ -10819,7 +10840,7 @@
},
"TimedMetadata": {
"type": "string",
- "documentation": "Applies to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.",
+ "documentation": "Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank.",
"enum": [
"PASSTHROUGH",
"NONE"
@@ -10834,7 +10855,7 @@
"documentation": "Id3Insertions contains the array of Id3Insertion instances."
}
},
- "documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects."
+ "documentation": "Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH)."
},
"Timing": {
"type": "structure",
@@ -11435,6 +11456,11 @@
"locationName": "colorSpaceUsage",
"documentation": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings."
},
+ "EmbeddedTimecodeOverride": {
+ "shape": "EmbeddedTimecodeOverride",
+ "locationName": "embeddedTimecodeOverride",
+ "documentation": "Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USE_MDPM) when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata (MDPM). When you do, we recommend you also set Timecode source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override blank, or set to None (NONE), when your input does not contain MDPM timecode."
+ },
"Hdr10Metadata": {
"shape": "Hdr10Metadata",
"locationName": "hdr10Metadata",
@@ -11761,7 +11787,7 @@
},
"WebvttAccessibilitySubs": {
"type": "string",
- "documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out.",
+ "documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.",
"enum": [
"DISABLED",
"ENABLED"
@@ -11773,7 +11799,7 @@
"Accessibility": {
"shape": "WebvttAccessibilitySubs",
"locationName": "accessibility",
- "documentation": "Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out."
+ "documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes."
},
"StylePassthrough": {
"shape": "WebvttStylePassthrough",
diff --git a/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json b/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json
index cb606f7643..acea225540 100644
--- a/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json
@@ -1131,7 +1131,7 @@
},
{
"shape": "GatewayTimeoutException",
- "documentation": "Gateway Timeout Error"
+ "documentation": "Gateway Timeout"
},
{
"shape": "TooManyRequestsException",
@@ -1713,7 +1713,7 @@
},
{
"shape": "GatewayTimeoutException",
- "documentation": "Gateway Timeout Error"
+ "documentation": "Gateway Timeout"
},
{
"shape": "TooManyRequestsException",
@@ -4403,6 +4403,11 @@
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -4539,6 +4544,11 @@
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -4644,6 +4654,11 @@
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceCreateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -4715,6 +4730,11 @@
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceCreateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -5275,6 +5295,11 @@
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -5698,6 +5723,11 @@
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -6882,7 +6912,7 @@
"CopyrightHolder": {
"shape": "__stringMax1000",
"locationName": "copyrightHolder",
- "documentation": "Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML"
+ "documentation": "Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata."
},
"FillLineGap": {
"shape": "EbuTtDFillLineGapControl",
@@ -11160,6 +11190,82 @@
"PASSTHROUGH"
]
},
+ "MaintenanceCreateSettings": {
+ "type": "structure",
+ "members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows."
+ },
+ "MaintenanceStartTime": {
+ "shape": "__stringPattern010920300",
+ "locationName": "maintenanceStartTime",
+ "documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows."
+ }
+ },
+ "documentation": "Placeholder documentation for MaintenanceCreateSettings"
+ },
+ "MaintenanceDay": {
+ "type": "string",
+ "documentation": "The currently selected maintenance day.",
+ "enum": [
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY",
+ "SUNDAY"
+ ]
+ },
+ "MaintenanceStatus": {
+ "type": "structure",
+ "members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "The currently selected maintenance day."
+ },
+ "MaintenanceDeadline": {
+ "shape": "__string",
+ "locationName": "maintenanceDeadline",
+ "documentation": "Maintenance is required by the displayed date and time. Date and time is in ISO."
+ },
+ "MaintenanceScheduledDate": {
+ "shape": "__string",
+ "locationName": "maintenanceScheduledDate",
+ "documentation": "The currently scheduled maintenance date and time. Date and time is in ISO."
+ },
+ "MaintenanceStartTime": {
+ "shape": "__string",
+ "locationName": "maintenanceStartTime",
+ "documentation": "The currently selected maintenance start time. Time is in UTC."
+ }
+ },
+ "documentation": "Placeholder documentation for MaintenanceStatus"
+ },
+ "MaintenanceUpdateSettings": {
+ "type": "structure",
+ "members": {
+ "MaintenanceDay": {
+ "shape": "MaintenanceDay",
+ "locationName": "maintenanceDay",
+ "documentation": "Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows."
+ },
+ "MaintenanceScheduledDate": {
+ "shape": "__string",
+ "locationName": "maintenanceScheduledDate",
+ "documentation": "Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only."
+ },
+ "MaintenanceStartTime": {
+ "shape": "__stringPattern010920300",
+ "locationName": "maintenanceStartTime",
+ "documentation": "Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows."
+ }
+ },
+ "documentation": "Placeholder documentation for MaintenanceUpdateSettings"
+ },
"MaxResults": {
"type": "integer",
"min": 1,
@@ -12367,7 +12473,7 @@
"Name": {
"shape": "__stringMax32",
"locationName": "name",
- "documentation": "Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed."
+ "documentation": "Custom output group name optionally defined by the user."
},
"OutputGroupSettings": {
"shape": "OutputGroupSettings",
@@ -13721,6 +13827,11 @@
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -14001,6 +14112,11 @@
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceStatus",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -14357,7 +14473,7 @@
"StyleControl": {
"shape": "TtmlDestinationStyleControl",
"locationName": "styleControl",
- "documentation": "When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output."
+ "documentation": "This field is not currently supported and will not affect the output styling. Leave the default value."
}
},
"documentation": "Ttml Destination Settings"
@@ -14491,6 +14607,11 @@
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceUpdateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -14597,6 +14718,11 @@
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
+ "Maintenance": {
+ "shape": "MaintenanceUpdateSettings",
+ "locationName": "maintenance",
+ "documentation": "Maintenance settings for this channel."
+ },
"Name": {
"shape": "__string",
"locationName": "name",
@@ -16171,6 +16297,11 @@
"max": 6,
"documentation": "Placeholder documentation for __stringMin6Max6"
},
+ "__stringPattern010920300": {
+ "type": "string",
+ "pattern": "^([0,1]?[0-9]|2[0-3]):00$",
+ "documentation": "Placeholder documentation for __stringPattern010920300"
+ },
"__timestampIso8601": {
"type": "timestamp",
"timestampFormat": "iso8601",
diff --git a/contrib/python/botocore/py3/botocore/data/mediapackage/2017-10-12/service-2.json b/contrib/python/botocore/py3/botocore/data/mediapackage/2017-10-12/service-2.json
index 01b1278905..46bcb24077 100644
--- a/contrib/python/botocore/py3/botocore/data/mediapackage/2017-10-12/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/mediapackage/2017-10-12/service-2.json
@@ -2423,7 +2423,8 @@
"Profile": {
"enum": [
"NONE",
- "HBBTV_1_5"
+ "HBBTV_1_5",
+ "HYBRIDCAST"
],
"type": "string"
},
diff --git a/contrib/python/botocore/py3/botocore/data/mgn/2020-02-26/service-2.json b/contrib/python/botocore/py3/botocore/data/mgn/2020-02-26/service-2.json
index f171d45bb8..f067f5a53e 100644
--- a/contrib/python/botocore/py3/botocore/data/mgn/2020-02-26/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/mgn/2020-02-26/service-2.json
@@ -110,7 +110,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Deletes a single vCenter client by ID.</p>",
+ "documentation":"<p>Deletes a given vCenter client by ID.</p>",
"idempotent":true
},
"DescribeJobLogItems":{
@@ -126,7 +126,7 @@
{"shape":"UninitializedAccountException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Retrieves detailed Job log with paging.</p>"
+ "documentation":"<p>Retrieves detailed job log items with paging.</p>"
},
"DescribeJobs":{
"name":"DescribeJobs",
@@ -141,7 +141,7 @@
{"shape":"UninitializedAccountException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normaly created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.</p>"
+ "documentation":"<p>Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.</p>"
},
"DescribeReplicationConfigurationTemplates":{
"name":"DescribeReplicationConfigurationTemplates",
@@ -188,7 +188,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Lists all vCenter clients.</p>"
+ "documentation":"<p>Returns a list of the installed vCenter clients.</p>"
},
"DisconnectFromService":{
"name":"DisconnectFromService",
@@ -204,7 +204,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communciating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.</p>"
+ "documentation":"<p>Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.</p>"
},
"FinalizeCutover":{
"name":"FinalizeCutover",
@@ -221,7 +221,7 @@
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.</p>"
+ "documentation":"<p>Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.</p>"
},
"GetLaunchConfiguration":{
"name":"GetLaunchConfiguration",
@@ -300,7 +300,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle.state which equals DISCONNECTED or CUTOVER.</p>"
+ "documentation":"<p>Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.</p>"
},
"RetryDataReplication":{
"name":"RetryDataReplication",
@@ -350,7 +350,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Starts replication on source server by ID.</p>"
+ "documentation":"<p>Starts replication for SNAPSHOT_SHIPPING agents.</p>"
},
"StartTest":{
"name":"StartTest",
@@ -366,7 +366,7 @@
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Lauches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.</p>"
+ "documentation":"<p>Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.</p>"
},
"TagResource":{
"name":"TagResource",
@@ -489,7 +489,7 @@
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Updates source server Replication Type by ID.</p>"
+ "documentation":"<p>Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.</p>"
}
},
"shapes":{
@@ -515,6 +515,13 @@
"type":"boolean",
"box":true
},
+ "BootMode":{
+ "type":"string",
+ "enum":[
+ "LEGACY_BIOS",
+ "UEFI"
+ ]
+ },
"BoundedString":{
"type":"string",
"max":256,
@@ -577,11 +584,11 @@
"message":{"shape":"LargeBoundedString"},
"resourceId":{
"shape":"LargeBoundedString",
- "documentation":"<p>A conflict occured when prompting for the Resource ID.</p>"
+ "documentation":"<p>A conflict occurred when prompting for the Resource ID.</p>"
},
"resourceType":{
"shape":"LargeBoundedString",
- "documentation":"<p>A conflict occured when prompting for resource type.</p>"
+ "documentation":"<p>A conflict occurred when prompting for resource type.</p>"
}
},
"documentation":"<p>The request could not be completed due to a conflict with the current state of the target resource.</p>",
@@ -631,15 +638,15 @@
},
"defaultLargeStagingDiskType":{
"shape":"ReplicationConfigurationDefaultLargeStagingDiskType",
- "documentation":"<p>Request to configure the Staging Disk EBS volume type to \"gp2\" during Replication Settings template creation.</p>"
+ "documentation":"<p>Request to configure the default large staging disk EBS volume type during Replication Settings template creation.</p>"
},
"ebsEncryption":{
"shape":"ReplicationConfigurationEbsEncryption",
- "documentation":"<p>Request to configure EBS enryption during Replication Settings template creation.</p>"
+ "documentation":"<p>Request to configure EBS encryption during Replication Settings template creation.</p>"
},
"ebsEncryptionKeyArn":{
"shape":"ARN",
- "documentation":"<p>Request to configure an EBS enryption key during Replication Settings template creation.</p>"
+ "documentation":"<p>Request to configure an EBS encryption key during Replication Settings template creation.</p>"
},
"replicationServerInstanceType":{
"shape":"EC2InstanceType",
@@ -647,7 +654,7 @@
},
"replicationServersSecurityGroupsIDs":{
"shape":"ReplicationServersSecurityGroupsIDs",
- "documentation":"<p>Request to configure the Replication Server Secuirity group ID during Replication Settings template creation.</p>"
+ "documentation":"<p>Request to configure the Replication Server Security group ID during Replication Settings template creation.</p>"
},
"stagingAreaSubnetId":{
"shape":"SubnetID",
@@ -655,7 +662,7 @@
},
"stagingAreaTags":{
"shape":"TagsMap",
- "documentation":"<p>Request to configure Staiging Area tags during Replication Settings template creation.</p>"
+ "documentation":"<p>Request to configure Staging Area tags during Replication Settings template creation.</p>"
},
"tags":{
"shape":"TagsMap",
@@ -723,7 +730,7 @@
},
"lagDuration":{
"shape":"ISO8601DatetimeString",
- "documentation":"<p>Request to query data replication lag durating.</p>"
+ "documentation":"<p>Request to query data replication lag duration.</p>"
},
"lastSnapshotDateTime":{
"shape":"ISO8601DatetimeString",
@@ -798,7 +805,7 @@
"documentation":"<p>Request to query data initiation status.</p>"
}
},
- "documentation":"<p>Data replication intiation step.</p>"
+ "documentation":"<p>Data replication initiation step.</p>"
},
"DataReplicationInitiationStepName":{
"type":"string",
@@ -943,11 +950,11 @@
},
"maxResults":{
"shape":"StrictlyPositiveInteger",
- "documentation":"<p>Request to describe Job log by max results.</p>"
+ "documentation":"<p>Request to describe job log items by max results.</p>"
},
"nextToken":{
"shape":"PaginationToken",
- "documentation":"<p>Request to describe Job logby next token.</p>"
+ "documentation":"<p>Request to describe job log items by next token.</p>"
}
}
},
@@ -964,7 +971,7 @@
},
"toDate":{
"shape":"ISO8601DatetimeString",
- "documentation":"<p>Request to describe Job log by last date.</p>"
+ "documentation":"<p>Request to describe job log items by last date.</p>"
}
},
"documentation":"<p>Request to describe Job log filters.</p>"
@@ -1155,7 +1162,7 @@
"members":{
"sourceServerID":{
"shape":"SourceServerID",
- "documentation":"<p>Request to finalize Cutover by Soure Server ID.</p>"
+ "documentation":"<p>Request to finalize Cutover by Source Server ID.</p>"
}
}
},
@@ -1184,7 +1191,7 @@
"members":{
"sourceServerID":{
"shape":"SourceServerID",
- "documentation":"<p>Request to get Replication Configuaration by Source Server ID.</p>"
+ "documentation":"<p>Request to get Replication Configuration by Source Server ID.</p>"
}
}
},
@@ -1294,7 +1301,7 @@
},
"tags":{
"shape":"TagsMap",
- "documentation":"<p>Tags associated with spcific Job.</p>"
+ "documentation":"<p>Tags associated with specific Job.</p>"
},
"type":{
"shape":"JobType",
@@ -1401,6 +1408,10 @@
"LaunchConfiguration":{
"type":"structure",
"members":{
+ "bootMode":{
+ "shape":"BootMode",
+ "documentation":"<p>Launch configuration boot mode.</p>"
+ },
"copyPrivateIp":{
"shape":"Boolean",
"documentation":"<p>Copy Private IP during Launch Configuration.</p>"
@@ -1411,27 +1422,27 @@
},
"ec2LaunchTemplateID":{
"shape":"BoundedString",
- "documentation":"<p>Configure EC2 lauch configuration template ID.</p>"
+ "documentation":"<p>Launch configuration EC2 Launch template ID.</p>"
},
"launchDisposition":{
"shape":"LaunchDisposition",
- "documentation":"<p>Configure launch dispostion for launch configuration.</p>"
+ "documentation":"<p>Launch disposition for launch configuration.</p>"
},
"licensing":{
"shape":"Licensing",
- "documentation":"<p>Configure launch configuration OS licensing.</p>"
+ "documentation":"<p>Launch configuration OS licensing.</p>"
},
"name":{
"shape":"SmallBoundedString",
- "documentation":"<p>Configure launch configuration name.</p>"
+ "documentation":"<p>Launch configuration name.</p>"
},
"sourceServerID":{
"shape":"SourceServerID",
- "documentation":"<p>Configure launch configuration Source Server ID.</p>"
+ "documentation":"<p>Launch configuration Source Server ID.</p>"
},
"targetInstanceTypeRightSizingMethod":{
"shape":"TargetInstanceTypeRightSizingMethod",
- "documentation":"<p>Configure launch configuration Target instance type right sizing method.</p>"
+ "documentation":"<p>Launch configuration Target instance type right sizing method.</p>"
}
}
},
@@ -1457,18 +1468,18 @@
"members":{
"ec2InstanceID":{
"shape":"EC2InstanceID",
- "documentation":"<p>Configure launced instance EC2 ID.</p>"
+ "documentation":"<p>Launched instance EC2 ID.</p>"
},
"firstBoot":{
"shape":"FirstBoot",
- "documentation":"<p>Configure launced instance first boot.</p>"
+ "documentation":"<p>Launched instance first boot.</p>"
},
"jobID":{
"shape":"JobID",
- "documentation":"<p>Configure launced instance Job ID.</p>"
+ "documentation":"<p>Launched instance Job ID.</p>"
}
},
- "documentation":"<p>Configure launced instance.</p>"
+ "documentation":"<p>Launched instance.</p>"
},
"Licensing":{
"type":"structure",
@@ -1571,7 +1582,7 @@
"members":{
"finalized":{
"shape":"LifeCycleLastTestFinalized",
- "documentation":"<p>Lifecycle last Test finlized.</p>"
+ "documentation":"<p>Lifecycle last Test finalized.</p>"
},
"initiated":{
"shape":"LifeCycleLastTestInitiated",
@@ -1592,7 +1603,7 @@
"documentation":"<p>Lifecycle Test failed API call date and time.</p>"
}
},
- "documentation":"<p>Lifecycle last Test finlized.</p>"
+ "documentation":"<p>Lifecycle last Test finalized.</p>"
},
"LifeCycleLastTestInitiated":{
"type":"structure",
@@ -1806,7 +1817,8 @@
"type":"string",
"enum":[
"GP2",
- "ST1"
+ "ST1",
+ "GP3"
]
},
"ReplicationConfigurationEbsEncryption":{
@@ -1834,6 +1846,10 @@
"stagingDiskType":{
"shape":"ReplicationConfigurationReplicatedDiskStagingDiskType",
"documentation":"<p>Replication Configuration replicated disk staging disk type.</p>"
+ },
+ "throughput":{
+ "shape":"PositiveInteger",
+ "documentation":"<p>Replication Configuration replicated disk throughput.</p>"
}
},
"documentation":"<p>Replication Configuration replicated disk.</p>"
@@ -1846,7 +1862,9 @@
"IO1",
"SC1",
"ST1",
- "STANDARD"
+ "STANDARD",
+ "GP3",
+ "IO2"
]
},
"ReplicationConfigurationReplicatedDisks":{
@@ -1869,7 +1887,7 @@
},
"bandwidthThrottling":{
"shape":"PositiveInteger",
- "documentation":"<p>Replication Configuration template bandwidth throtting.</p>"
+ "documentation":"<p>Replication Configuration template bandwidth throttling.</p>"
},
"createPublicIP":{
"shape":"Boolean",
@@ -1881,7 +1899,7 @@
},
"defaultLargeStagingDiskType":{
"shape":"ReplicationConfigurationDefaultLargeStagingDiskType",
- "documentation":"<p>Replication Configuration template use dedault large Staging Disk type.</p>"
+ "documentation":"<p>Replication Configuration template use default large Staging Disk type.</p>"
},
"ebsEncryption":{
"shape":"ReplicationConfigurationEbsEncryption",
@@ -1893,7 +1911,7 @@
},
"replicationConfigurationTemplateID":{
"shape":"ReplicationConfigurationTemplateID",
- "documentation":"<p>Replication Configuration template template ID.</p>"
+ "documentation":"<p>Replication Configuration template ID.</p>"
},
"replicationServerInstanceType":{
"shape":"EC2InstanceType",
@@ -2004,7 +2022,7 @@
},
"resourceId":{
"shape":"LargeBoundedString",
- "documentation":"<p>Exceeded the service quota resource Id.</p>"
+ "documentation":"<p>Exceeded the service quota resource ID.</p>"
},
"resourceType":{
"shape":"LargeBoundedString",
@@ -2307,7 +2325,7 @@
"code":{"shape":"LargeBoundedString"},
"message":{"shape":"LargeBoundedString"}
},
- "documentation":"<p>Unitialized account exception.</p>",
+ "documentation":"<p>Uninitialized account exception.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
@@ -2339,6 +2357,10 @@
"type":"structure",
"required":["sourceServerID"],
"members":{
+ "bootMode":{
+ "shape":"BootMode",
+ "documentation":"<p>Update Launch configuration boot mode request.</p>"
+ },
"copyPrivateIp":{
"shape":"Boolean",
"documentation":"<p>Update Launch configuration copy Private IP request.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/migration-hub-refactor-spaces/2021-10-26/service-2.json b/contrib/python/botocore/py3/botocore/data/migration-hub-refactor-spaces/2021-10-26/service-2.json
index 35c776aeb1..0cdc50d56f 100644
--- a/contrib/python/botocore/py3/botocore/data/migration-hub-refactor-spaces/2021-10-26/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/migration-hub-refactor-spaces/2021-10-26/service-2.json
@@ -30,7 +30,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer for the application proxy inside your account.</p>"
+ "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.</p>"
},
"CreateEnvironment":{
"name":"CreateEnvironment",
@@ -50,7 +50,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and they are referred to as the <i>environment owner</i>. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.</p>"
+ "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the <i>environment owner</i>. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.</p>"
},
"CreateRoute":{
"name":"CreateRoute",
@@ -70,7 +70,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a <code>DEFAULT</code> <code>RouteType</code>.</p> <p>When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:</p> <ul> <li> <p>If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link. </p> </li> <li> <p>If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.</p> </li> <li> <p>If the service has an Lambda function endpoint, then Refactor Spaces uses the API Gateway Lambda integration.</p> </li> </ul> <p>A health check is performed on the service when the route is created. If the health check fails, the route transitions to <code>FAILED</code>, and no traffic is sent to the service.</p> <p>For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is <code>Failed</code>, then the route creation fails. For more information, see the <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State\">GetFunctionConfiguration's State response parameter</a> in the <i>Lambda Developer Guide</i>.</p> <p>For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target group is created and the target group health check is run.</p> <p>The <code>HealthCheckProtocol</code>, <code>HealthCheckPort</code>, and <code>HealthCheckPath</code> are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html\">Health checks for your target groups</a>. The health check is considered successful if at least one target within the target group transitions to a healthy state.</p>"
+ "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a <code>DEFAULT</code> <code>RouteType</code>.</p> <p>When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:</p> <ul> <li> <p>If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link. </p> </li> <li> <p>If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.</p> </li> <li> <p>If the service has an Lambda function endpoint, then Refactor Spaces configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function.</p> </li> </ul> <p>A one-time health check is performed on the service when the route is created. If the health check fails, the route transitions to <code>FAILED</code>, and no traffic is sent to the service.</p> <p>For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is <code>Failed</code>, then the route creation fails. For more information, see the <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State\">GetFunctionConfiguration's State response parameter</a> in the <i>Lambda Developer Guide</i>.</p> <p>For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target group is created and the target group health check is run.</p> <p>The <code>HealthCheckProtocol</code>, <code>HealthCheckPort</code>, and <code>HealthCheckPath</code> are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html\">Health checks for your target groups</a>. The health check is considered successful if at least one target within the target group transitions to a healthy state.</p> <p>Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed certificates are supported. Private Certificate Authorities (CAs) are permitted only if the CA's domain is publicly resolvable.</p>"
},
"CreateService":{
"name":"CreateService",
@@ -90,7 +90,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.</p> <important> <p>If an Amazon Web Services resourceis launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the <code>RefactorSpacesSecurityGroup</code> to the resource. Alternatively, to add more cross-account constraints, apply your own security group.</p> </important>"
+ "documentation":"<p>Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.</p> <important> <p>If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the <code>RefactorSpacesSecurityGroup</code> to the resource. Alternatively, to add more cross-account constraints, apply your own security group.</p> </important>"
},
"DeleteApplication":{
"name":"DeleteApplication",
@@ -317,7 +317,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
- "documentation":"<p>Lists all the virtual private clouds (VPCs) that are part of an Amazon Web Services Migration Hub Refactor Spaces environment. </p>"
+ "documentation":"<p>Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment. </p>"
},
"ListEnvironments":{
"name":"ListEnvironments",
@@ -616,7 +616,7 @@
},
"Arn":{
"shape":"ResourceArn",
- "documentation":"<p>he Amazon Resource Name (ARN) of the application. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the application. </p>"
},
"CreatedByAccountId":{
"shape":"AccountId",
@@ -644,7 +644,7 @@
},
"OwnerAccountId":{
"shape":"AccountId",
- "documentation":"<p>The Amazon Web Services account ID of the application owner.</p>"
+ "documentation":"<p>The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).</p>"
},
"ProxyType":{
"shape":"ProxyType",
@@ -785,7 +785,7 @@
},
"OwnerAccountId":{
"shape":"AccountId",
- "documentation":"<p>The Amazon Web Services account ID of the application owner.</p>"
+ "documentation":"<p>The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).</p>"
},
"ProxyType":{
"shape":"ProxyType",
@@ -961,11 +961,11 @@
},
"ServiceId":{
"shape":"ServiceId",
- "documentation":"<p>The ID of service in which the rute iscreated. Traffic that matches this route is forwarded to this service.</p>"
+ "documentation":"<p>The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.</p>"
},
"State":{
"shape":"RouteState",
- "documentation":"<p>he current state of the route. </p>"
+ "documentation":"<p>The current state of the route. </p>"
},
"Tags":{
"shape":"TagMap",
@@ -1239,7 +1239,7 @@
"members":{
"ApplicationId":{
"shape":"ApplicationId",
- "documentation":"<p>he ID of the application that the route belongs to.</p>"
+ "documentation":"<p>The ID of the application that the route belongs to.</p>"
},
"Arn":{
"shape":"ResourceArn",
@@ -1592,7 +1592,7 @@
},
"OwnerAccountId":{
"shape":"AccountId",
- "documentation":"<p>The Amazon Web Services account ID of the application owner.</p>"
+ "documentation":"<p>The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).</p>"
},
"ProxyType":{
"shape":"ProxyType",
@@ -2783,5 +2783,5 @@
"pattern":"^[a-z0-9]{10}$"
}
},
- "documentation":"<p><fullname>Amazon Web Services Migration Hub Refactor Spaces</fullname></p> <pre><code> &lt;p&gt;This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see &lt;a href=&quot;http://aws.amazon.com/tools/#SDKs&quot;&gt;Amazon Web Services SDKs&lt;/a&gt;.&lt;/p&gt; </code></pre>"
+ "documentation":"<p><fullname>Amazon Web Services Migration Hub Refactor Spaces</fullname></p> <pre><code> &lt;p&gt;This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see &lt;a href=&quot;http://aws.amazon.com/tools/#SDKs&quot;&gt;Amazon Web Services SDKs&lt;/a&gt;.&lt;/p&gt; &lt;p&gt;To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations and their OUs, use Resource Access Manager's &lt;code&gt;CreateResourceShare&lt;/code&gt; API. See &lt;a href=&quot;https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html&quot;&gt;CreateResourceShare&lt;/a&gt; in the &lt;i&gt;Amazon Web Services RAM API Reference&lt;/i&gt;.&lt;/p&gt; </code></pre>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/organizations/2016-11-28/service-2.json b/contrib/python/botocore/py3/botocore/data/organizations/2016-11-28/service-2.json
index 52471fdfdc..bee89e1b56 100644
--- a/contrib/python/botocore/py3/botocore/data/organizations/2016-11-28/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/organizations/2016-11-28/service-2.json
@@ -34,7 +34,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"AccessDeniedForDependencyException"}
],
- "documentation":"<p>Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.</p> <p>This operation can be called only by the following principals when they also have the relevant IAM permissions:</p> <ul> <li> <p> <b>Invitation to join</b> or <b>Approve all features request</b> handshakes: only a principal from the member account.</p> <p>The user who calls the API for an invitation to join must have the <code>organizations:AcceptHandshake</code> permission. If you enabled all features in the organization, the user must also have the <code>iam:CreateServiceLinkedRole</code> permission so that AWS Organizations can create the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles\">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p> <b>Enable all features final confirmation</b> handshake: only a principal from the management account.</p> <p>For more information about invitations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html\">Inviting an AWS Account to Join Your Organization</a> in the <i>AWS Organizations User Guide.</i> For more information about requests to enable all features in the organization, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p>After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.</p>"
+ "documentation":"<p>Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.</p> <p>This operation can be called only by the following principals when they also have the relevant IAM permissions:</p> <ul> <li> <p> <b>Invitation to join</b> or <b>Approve all features request</b> handshakes: only a principal from the member account.</p> <p>The user who calls the API for an invitation to join must have the <code>organizations:AcceptHandshake</code> permission. If you enabled all features in the organization, the user must also have the <code>iam:CreateServiceLinkedRole</code> permission so that Organizations can create the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integration_service-linked-roles\">Organizations and Service-Linked Roles</a> in the <i>Organizations User Guide</i>.</p> </li> <li> <p> <b>Enable all features final confirmation</b> handshake: only a principal from the management account.</p> <p>For more information about invitations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html\">Inviting an Amazon Web Services account to join your organization</a> in the <i>Organizations User Guide.</i> For more information about requests to enable all features in the organization, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling all features in your organization</a> in the <i>Organizations User Guide.</i> </p> </li> </ul> <p>After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.</p>"
},
"AttachPolicy":{
"name":"AttachPolicy",
@@ -58,7 +58,7 @@
{"shape":"UnsupportedAPIEndpointException"},
{"shape":"PolicyChangesInProgressException"}
],
- "documentation":"<p>Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the <i>AWS Organizations User Guide</i> for information about each policy type:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html\">AISERVICES_OPT_OUT_POLICY</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html\">BACKUP_POLICY</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html\">SERVICE_CONTROL_POLICY</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html\">TAG_POLICY</a> </p> </li> </ul> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the <i>Organizations User Guide</i> for information about each policy type:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html\">AISERVICES_OPT_OUT_POLICY</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html\">BACKUP_POLICY</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html\">SERVICE_CONTROL_POLICY</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html\">TAG_POLICY</a> </p> </li> </ul> <p>This operation can be called only from the organization's management account.</p>"
},
"CancelHandshake":{
"name":"CancelHandshake",
@@ -80,6 +80,28 @@
],
"documentation":"<p>Cancels a handshake. Canceling a handshake sets the handshake state to <code>CANCELED</code>.</p> <p>This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use <a>DeclineHandshake</a> instead. After a handshake is canceled, the recipient can no longer respond to that handshake.</p> <p>After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.</p>"
},
+ "CloseAccount":{
+ "name":"CloseAccount",
+ "http":{
+ "method":"POST",
+ "requestUri":"/"
+ },
+ "input":{"shape":"CloseAccountRequest"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"AccountAlreadyClosedException"},
+ {"shape":"AccountNotFoundException"},
+ {"shape":"AWSOrganizationsNotInUseException"},
+ {"shape":"ConcurrentModificationException"},
+ {"shape":"ConflictException"},
+ {"shape":"ConstraintViolationException"},
+ {"shape":"InvalidInputException"},
+ {"shape":"ServiceException"},
+ {"shape":"TooManyRequestsException"},
+ {"shape":"UnsupportedAPIEndpointException"}
+ ],
+ "documentation":"<p>Closes an Amazon Web Services account that is now a part of an Organizations, either created within the organization, or invited to join the organization.</p>"
+ },
"CreateAccount":{
"name":"CreateAccount",
"http":{
@@ -99,7 +121,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because <code>CreateAccount</code> operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:</p> <ul> <li> <p>Use the <code>Id</code> member of the <code>CreateAccountStatus</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> </li> <li> <p>Check the AWS CloudTrail log for the <code>CreateAccountResult</code> event. For information on using AWS CloudTrail with AWS Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration\">Logging and monitoring in AWS Organizations</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p>The user who calls the API to create an account must have the <code>organizations:CreateAccount</code> permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs\">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide</i>.</p> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>AWS Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's management account.</p> <p>This operation can be called only from the organization's management account.</p> <p>For more information about creating accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> <important> <ul> <li> <p>When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is <i>not</i> automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization as a member account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>If you get an exception that indicates that you exceeded your account limits for the organization, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>Using <code>CreateAccount</code> to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html\">Closing an AWS Account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> </ul> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note>"
+ "documentation":"<p>Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services performs in the background. Because <code>CreateAccount</code> operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:</p> <ul> <li> <p>Use the <code>Id</code> member of the <code>CreateAccountStatus</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> </li> <li> <p>Check the CloudTrail log for the <code>CreateAccountResult</code> event. For information on using CloudTrail with Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration\">Logging and monitoring in Organizations</a> in the <i>Organizations User Guide.</i> </p> </li> </ul> <p>The user who calls the API to create an account must have the <code>organizations:CreateAccount</code> permission. If you enabled all features in the organization, Organizations creates the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs\">Organizations and Service-Linked Roles</a> in the <i>Organizations User Guide</i>.</p> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants users in the management account administrator permissions in the new member account. Principals in the management account can assume the role. Organizations clones the company name and address information for the new account from the organization's management account.</p> <p>This operation can be called only from the organization's management account.</p> <p>For more information about creating accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an Amazon Web Services account in Your Organization</a> in the <i>Organizations User Guide.</i> </p> <important> <ul> <li> <p>When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is <i>not</i> automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization as a member account</a> in the <i>Organizations User Guide</i>.</p> </li> <li> <p>If you get an exception that indicates that you exceeded your account limits for the organization, contact <a href=\"https://console.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </li> <li> <p>If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact <a href=\"https://console.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </li> <li> <p>Using <code>CreateAccount</code> to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html\">Closing an Amazon Web Services account</a> in the <i>Organizations User Guide</i>.</p> </li> </ul> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note>"
},
"CreateGovCloudAccount":{
"name":"CreateGovCloudAccount",
@@ -120,7 +142,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>This action is available if all of the following are true:</p> <ul> <li> <p>You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the <a href=\"http://docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html\"> <i>AWS GovCloud User Guide</i>.</a> </p> </li> <li> <p>You already have an account in the AWS GovCloud (US) Region that is paired with a management account of an organization in the commercial Region.</p> </li> <li> <p>You call this action from the management account of your organization in the commercial Region.</p> </li> <li> <p>You have the <code>organizations:CreateGovCloudAccount</code> permission. </p> </li> </ul> <p>AWS Organizations automatically creates the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs\">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide.</i> </p> <p>AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:</p> <ul> <li> <p>Verify that AWS CloudTrail is enabled to store logs.</p> </li> <li> <p>Create an S3 bucket for AWS CloudTrail log storage.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html\">Verifying AWS CloudTrail Is Enabled</a> in the <i>AWS GovCloud User Guide</i>. </p> </li> </ul> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the <a>TagResource</a> operation in the GovCloud Region after the new GovCloud account exists.</p> <p>You call this action from the management account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the management account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see <a href=\"http://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html\">AWS Organizations</a> in the <i>AWS GovCloud User Guide.</i> </p> <p>Calling <code>CreateGovCloudAccount</code> is an asynchronous request that AWS performs in the background. Because <code>CreateGovCloudAccount</code> operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:</p> <ul> <li> <p>Use the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> </li> <li> <p>Check the AWS CloudTrail log for the <code>CreateAccountResult</code> event. For information on using AWS CloudTrail with Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html\">Monitoring the Activity in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p/> <p>When you call the <code>CreateGovCloudAccount</code> action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.</p> <p>A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see <a href=\"http://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html\">AWS Organizations</a> in the <i>AWS GovCloud User Guide.</i> </p> <p>For more information about creating accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> <important> <ul> <li> <p>When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is <i>not</i> automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization as a member account</a> in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>If you get an exception that indicates that you exceeded your account limits for the organization, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>Using <code>CreateGovCloudAccount</code> to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html\">Closing an AWS Account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> </ul> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note>"
+ "documentation":"<p>This action is available if all of the following are true:</p> <ul> <li> <p>You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more information on the Amazon Web Services GovCloud (US) Region, see the <a href=\"https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html\"> <i>Amazon Web Services GovCloud User Guide</i>.</a> </p> </li> <li> <p>You already have an account in the Amazon Web Services GovCloud (US) Region that is paired with a management account of an organization in the commercial Region.</p> </li> <li> <p>You call this action from the management account of your organization in the commercial Region.</p> </li> <li> <p>You have the <code>organizations:CreateGovCloudAccount</code> permission. </p> </li> </ul> <p>Organizations automatically creates the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs\">Organizations and Service-Linked Roles</a> in the <i>Organizations User Guide.</i> </p> <p>Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also do the following:</p> <ul> <li> <p>Verify that CloudTrail is enabled to store logs.</p> </li> <li> <p>Create an Amazon S3 bucket for CloudTrail log storage.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html\">Verifying CloudTrail Is Enabled</a> in the <i>Amazon Web Services GovCloud User Guide</i>. </p> </li> </ul> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission. The tags are attached to the commercial account associated with the GovCloud account, rather than the GovCloud account itself. To add tags to the GovCloud account, call the <a>TagResource</a> operation in the GovCloud Region after the new GovCloud account exists.</p> <p>You call this action from the management account of your organization in the commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US) Region. After the account is created, the management account of an organization in the Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see <a href=\"https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html\">Organizations</a> in the <i>Amazon Web Services GovCloud User Guide.</i> </p> <p>Calling <code>CreateGovCloudAccount</code> is an asynchronous request that Amazon Web Services performs in the background. Because <code>CreateGovCloudAccount</code> operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:</p> <ul> <li> <p>Use the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> </li> <li> <p>Check the CloudTrail log for the <code>CreateAccountResult</code> event. For information on using CloudTrail with Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html\">Monitoring the Activity in Your Organization</a> in the <i>Organizations User Guide.</i> </p> </li> </ul> <p/> <p>When you call the <code>CreateGovCloudAccount</code> action, you create two accounts: a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.</p> <p>A role is created in the new account in the commercial Region that allows the management account in the organization in the commercial Region to assume it. An Amazon Web Services GovCloud (US) account is then created and associated with the commercial account that you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management account of the commercial organization. For more information and to view a diagram that explains how account access works, see <a href=\"https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html\">Organizations</a> in the <i>Amazon Web Services GovCloud User Guide.</i> </p> <p>For more information about creating accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an Amazon Web Services account in Your Organization</a> in the <i>Organizations User Guide.</i> </p> <important> <ul> <li> <p>When you create an account in an organization using the Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is <i>not</i> automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization as a member account</a> in the <i>Organizations User Guide.</i> </p> </li> <li> <p>If you get an exception that indicates that you exceeded your account limits for the organization, contact <a href=\"https://console.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </li> <li> <p>If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact <a href=\"https://console.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </li> <li> <p>Using <code>CreateGovCloudAccount</code> to create multiple temporary accounts isn't recommended. You can only close an account from the Amazon Web Services Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html\">Closing an Amazon Web Services account</a> in the <i>Organizations User Guide</i>.</p> </li> </ul> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note>"
},
"CreateOrganization":{
"name":"CreateOrganization",
@@ -140,7 +162,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"AccessDeniedForDependencyException"}
],
- "documentation":"<p>Creates an AWS organization. The account whose user is calling the <code>CreateOrganization</code> operation automatically becomes the <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account\">management account</a> of the new organization.</p> <p>This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions.</p> <p>By default (or if you set the <code>FeatureSet</code> parameter to <code>ALL</code>), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the <code>FeatureSet</code> parameter to <code>CONSOLIDATED_BILLING\"</code>, no policy types are enabled by default, and you can't use organization policies</p>"
+ "documentation":"<p>Creates an Amazon Web Services organization. The account whose user is calling the <code>CreateOrganization</code> operation automatically becomes the <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account\">management account</a> of the new organization.</p> <p>This operation must be called using credentials from the account that is to become the new organization's management account. The principal must also have the relevant IAM permissions.</p> <p>By default (or if you set the <code>FeatureSet</code> parameter to <code>ALL</code>), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the <code>FeatureSet</code> parameter to <code>CONSOLIDATED_BILLING\"</code>, no policy types are enabled by default, and you can't use organization policies</p>"
},
"CreateOrganizationalUnit":{
"name":"CreateOrganizationalUnit",
@@ -161,7 +183,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.</p> <p>For more information about OUs, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html\">Managing Organizational Units</a> in the <i>AWS Organizations User Guide.</i> </p> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.</p> <p>For more information about OUs, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html\">Managing Organizational Units</a> in the <i>Organizations User Guide.</i> </p> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>This operation can be called only from the organization's management account.</p>"
},
"CreatePolicy":{
"name":"CreatePolicy",
@@ -184,7 +206,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.</p> <p>For more information about policies and their use, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html\">Managing Organization Policies</a>.</p> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.</p> <p>For more information about policies and their use, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html\">Managing Organization Policies</a>.</p> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>This operation can be called only from the organization's management account.</p>"
},
"DeclineHandshake":{
"name":"DeclineHandshake",
@@ -281,7 +303,7 @@
{"shape":"ServiceException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Removes the specified member AWS account as a delegated administrator for the specified AWS service.</p> <important> <p>Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled AWS service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts.</p> </important> <p>You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column <i>Supports Delegated Administrator</i> in the table at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html\">AWS Services that you can use with AWS Organizations</a> in the <i>AWS Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.</p> <important> <p>Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled Amazon Web Services service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts.</p> </important> <p>You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column <i>Supports Delegated Administrator</i> in the table at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html\">Amazon Web Services Services that you can use with Organizations</a> in the <i>Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account.</p>"
},
"DescribeAccount":{
"name":"DescribeAccount",
@@ -299,7 +321,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Retrieves AWS Organizations-related information about the specified account.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Retrieves Organizations-related information about the specified account.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"DescribeCreateAccountStatus":{
"name":"DescribeCreateAccountStatus",
@@ -318,7 +340,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Retrieves the current status of an asynchronous request to create an account.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Retrieves the current status of an asynchronous request to create an account.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"DescribeEffectivePolicy":{
"name":"DescribeEffectivePolicy",
@@ -339,7 +361,7 @@
{"shape":"InvalidInputException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.</p> <p>This operation applies only to policy types <i>other</i> than service control policies (SCPs).</p> <p>For more information about policy inheritance, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies-inheritance.html\">How Policy Inheritance Works</a> in the <i>AWS Organizations User Guide</i>.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.</p> <p>This operation applies only to policy types <i>other</i> than service control policies (SCPs).</p> <p>For more information about policy inheritance, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies-inheritance.html\">How Policy Inheritance Works</a> in the <i>Organizations User Guide</i>.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"DescribeHandshake":{
"name":"DescribeHandshake",
@@ -391,7 +413,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Retrieves information about an organizational unit (OU).</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Retrieves information about an organizational unit (OU).</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"DescribePolicy":{
"name":"DescribePolicy",
@@ -410,7 +432,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Retrieves information about a policy.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Retrieves information about a policy.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"DetachPolicy":{
"name":"DetachPolicy",
@@ -433,7 +455,7 @@
{"shape":"UnsupportedAPIEndpointException"},
{"shape":"PolicyChangesInProgressException"}
],
- "documentation":"<p>Detaches a policy from a target root, organizational unit (OU), or account.</p> <important> <p>If the policy being detached is a service control policy (SCP), the changes to permissions for AWS Identity and Access Management (IAM) users and roles in affected accounts are immediate.</p> </important> <p>Every root, OU, and account must have at least one SCP attached. If you want to replace the default <code>FullAWSAccess</code> policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an \"<a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_allowlist\">allow list</a>\". If you instead attach a second SCP and leave the <code>FullAWSAccess</code> SCP still attached, and specify <code>\"Effect\": \"Deny\"</code> in the second SCP to override the <code>\"Effect\": \"Allow\"</code> in the <code>FullAWSAccess</code> policy (or any other attached SCP), you're using the authorization strategy of a \"<a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_denylist\">deny list</a>\".</p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Detaches a policy from a target root, organizational unit (OU), or account.</p> <important> <p>If the policy being detached is a service control policy (SCP), the changes to permissions for Identity and Access Management (IAM) users and roles in affected accounts are immediate.</p> </important> <p>Every root, OU, and account must have at least one SCP attached. If you want to replace the default <code>FullAWSAccess</code> policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an \"<a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_allowlist\">allow list</a>\". If you instead attach a second SCP and leave the <code>FullAWSAccess</code> SCP still attached, and specify <code>\"Effect\": \"Deny\"</code> in the second SCP to override the <code>\"Effect\": \"Allow\"</code> in the <code>FullAWSAccess</code> policy (or any other attached SCP), you're using the authorization strategy of a \"<a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_denylist\">deny list</a>\".</p> <p>This operation can be called only from the organization's management account.</p>"
},
"DisableAWSServiceAccess":{
"name":"DisableAWSServiceAccess",
@@ -452,7 +474,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Disables the integration of an AWS service (the service that is specified by <code>ServicePrincipal</code>) with AWS Organizations. When you disable integration, the specified service no longer can create a <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html\">service-linked role</a> in <i>new</i> accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.</p> <important> <p>We <b> <i>strongly recommend</i> </b> that you don't use this command to disable integration between AWS Organizations and the specified AWS service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access. </p> <p>For information about how to disable trusted service access to your organization using the trusted service, see the <b>Learn more</b> link under the <b>Supports Trusted Access</b> column at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html\">AWS services that you can use with AWS Organizations</a>. on this page.</p> <p>If you disable access by using this command, it causes the following actions to occur:</p> <ul> <li> <p>The service can no longer create a service-linked role in the accounts in your organization. This means that the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations. </p> </li> <li> <p>The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant.</p> </li> <li> <p>Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration.</p> </li> </ul> <p>Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. </p> </important> <p>After you perform the <code>DisableAWSServiceAccess</code> operation, the specified service can no longer perform operations in your organization's accounts </p> <p>For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Integrating AWS Organizations with Other AWS Services</a> in the <i>AWS Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Disables the integration of an Amazon Web Services service (the service that is specified by <code>ServicePrincipal</code>) with Organizations. When you disable integration, the specified service no longer can create a <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html\">service-linked role</a> in <i>new</i> accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations.</p> <important> <p>We <b> <i>strongly recommend</i> </b> that you don't use this command to disable integration between Organizations and the specified Amazon Web Services service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access. </p> <p>For information about how to disable trusted service access to your organization using the trusted service, see the <b>Learn more</b> link under the <b>Supports Trusted Access</b> column at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html\">Amazon Web Services services that you can use with Organizations</a>. on this page.</p> <p>If you disable access by using this command, it causes the following actions to occur:</p> <ul> <li> <p>The service can no longer create a service-linked role in the accounts in your organization. This means that the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from Organizations. </p> </li> <li> <p>The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant.</p> </li> <li> <p>Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration.</p> </li> </ul> <p>Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service. </p> </important> <p>After you perform the <code>DisableAWSServiceAccess</code> operation, the specified service can no longer perform operations in your organization's accounts </p> <p>For more information about integrating other services with Organizations, including the list of services that work with Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Integrating Organizations with Other Amazon Web Services Services</a> in the <i>Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account.</p>"
},
"DisablePolicyType":{
"name":"DisablePolicyType",
@@ -475,7 +497,7 @@
{"shape":"UnsupportedAPIEndpointException"},
{"shape":"PolicyChangesInProgressException"}
],
- "documentation":"<p>Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This is an asynchronous request that AWS performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features</a> are enabled for the organization. AWS recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account.</p> <p> To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
+ "documentation":"<p>Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features</a> are enabled for the organization. Amazon Web Services recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account.</p> <p> To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
},
"EnableAWSServiceAccess":{
"name":"EnableAWSServiceAccess",
@@ -494,7 +516,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Enables the integration of an AWS service (the service that is specified by <code>ServicePrincipal</code>) with AWS Organizations. When you enable integration, you allow the specified service to create a <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html\">service-linked role</a> in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.</p> <important> <p>We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.</p> </important> <p>For more information about enabling services to integrate with AWS Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Integrating AWS Organizations with Other AWS Services</a> in the <i>AWS Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account and only if the organization has <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">enabled all features</a>.</p>"
+ "documentation":"<p>Enables the integration of an Amazon Web Services service (the service that is specified by <code>ServicePrincipal</code>) with Organizations. When you enable integration, you allow the specified service to create a <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html\">service-linked role</a> in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.</p> <important> <p>We recommend that you enable integration between Organizations and the specified Amazon Web Services service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other Amazon Web Services service.</p> </important> <p>For more information about enabling services to integrate with Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Integrating Organizations with Other Amazon Web Services Services</a> in the <i>Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account and only if the organization has <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">enabled all features</a>.</p>"
},
"EnableAllFeatures":{
"name":"EnableAllFeatures",
@@ -513,7 +535,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> <important> <p>This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.</p> </important> <p>After you enable all features, you can separately enable or disable individual policy types in a root using <a>EnablePolicyType</a> and <a>DisablePolicyType</a>. To see the status of policy types in a root, use <a>ListRoots</a>.</p> <p>After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains <code>\"Action\": \"ENABLE_ALL_FEATURES\"</code>. This completes the change.</p> <p>After you enable all features in your organization, the management account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The management account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.</p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that Organizations supports. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>Organizations User Guide.</i> </p> <important> <p>This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.</p> </important> <p>After you enable all features, you can separately enable or disable individual policy types in a root using <a>EnablePolicyType</a> and <a>DisablePolicyType</a>. To see the status of policy types in a root, use <a>ListRoots</a>.</p> <p>After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains <code>\"Action\": \"ENABLE_ALL_FEATURES\"</code>. This completes the change.</p> <p>After you enable all features in your organization, the management account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The management account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.</p> <p>This operation can be called only from the organization's management account.</p>"
},
"EnablePolicyType":{
"name":"EnablePolicyType",
@@ -537,7 +559,7 @@
{"shape":"UnsupportedAPIEndpointException"},
{"shape":"PolicyChangesInProgressException"}
],
- "documentation":"<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This is an asynchronous request that AWS performs in the background. AWS recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account.</p> <p>You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
+ "documentation":"<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation.</p> <p>This operation can be called only from the organization's management account.</p> <p>You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
},
"InviteAccountToOrganization":{
"name":"InviteAccountToOrganization",
@@ -560,7 +582,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Sends an invitation to another account to join your organization as a member account. AWS Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a <a>Handshake</a> whose details are in the response.</p> <important> <ul> <li> <p>You can invite AWS accounts only from the same seller as the management account. For example, if your organization's management account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, you can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS or from any other AWS seller. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html\">Consolidated Billing in India</a>.</p> </li> <li> <p>If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> </ul> </important> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a <a>Handshake</a> whose details are in the response.</p> <important> <ul> <li> <p>You can invite Amazon Web Services accounts only from the same seller as the management account. For example, if your organization's management account was created by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html\">Consolidated Billing in India</a>.</p> </li> <li> <p>If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact <a href=\"https://console.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </li> </ul> </important> <p>If the request includes tags, then the requester must have the <code>organizations:TagResource</code> permission.</p> <p>This operation can be called only from the organization's management account.</p>"
},
"LeaveOrganization":{
"name":"LeaveOrganization",
@@ -579,7 +601,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use <a>RemoveAccountFromOrganization</a> instead.</p> <p>This operation can be called only from a member account in the organization.</p> <important> <ul> <li> <p>The management account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling <code>LeaveOrganization</code> and leaving the organization.</p> </li> <li> <p>You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn't appear.</p> <ul> <li> <p>Choose a support plan</p> </li> <li> <p>Provide and verify the required contact information</p> </li> <li> <p>Provide a current payment method</p> </li> </ul> <p>AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>The account that you want to leave must not be a delegated administrator account for any AWS service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.</p> </li> <li> <p>You can leave an organization only after you enable IAM user access to billing in your account. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide.</i> </p> </li> <li> <p>After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. AWS accounts outside of an organization do not support tags.</p> </li> <li> <p>A newly created account has a waiting period before it can be removed from its organization. If you get an error that indicates that a wait period is required, then try again in a few days.</p> </li> </ul> </important>"
+ "documentation":"<p>Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use <a>RemoveAccountFromOrganization</a> instead.</p> <p>This operation can be called only from a member account in the organization.</p> <important> <ul> <li> <p>The management account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do. This includes preventing them from successfully calling <code>LeaveOrganization</code> and leaving the organization.</p> </li> <li> <p>You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For each account that you want to make standalone, you must perform the following steps. If any of the steps are already completed for this account, that step doesn't appear.</p> <ul> <li> <p>Choose a support plan</p> </li> <li> <p>Provide and verify the required contact information</p> </li> <li> <p>Provide a current payment method</p> </li> </ul> <p>Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. Follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>Organizations User Guide.</i> </p> </li> <li> <p>The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.</p> </li> <li> <p>You can leave an organization only after you enable IAM user access to billing in your account. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>Amazon Web Services Billing and Cost Management User Guide.</i> </p> </li> <li> <p>After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.</p> </li> <li> <p>A newly created account has a waiting period before it can be removed from its organization. If you get an error that indicates that a wait period is required, then try again in a few days.</p> </li> </ul> </important>"
},
"ListAWSServiceAccessForOrganization":{
"name":"ListAWSServiceAccessForOrganization",
@@ -598,7 +620,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.</p> <p>For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Integrating AWS Organizations with Other AWS Services</a> in the <i>AWS Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.</p> <p>For more information about integrating other services with Organizations, including the list of services that currently work with Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Integrating Organizations with Other Amazon Web Services Services</a> in the <i>Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListAccounts":{
"name":"ListAccounts",
@@ -615,7 +637,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the <a>ListAccountsForParent</a> operation instead.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the <a>ListAccountsForParent</a> operation instead.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListAccountsForParent":{
"name":"ListAccountsForParent",
@@ -633,7 +655,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the <a>ListAccounts</a> operation.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the <a>ListAccounts</a> operation.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListChildren":{
"name":"ListChildren",
@@ -651,7 +673,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with <a>ListParents</a> enables you to traverse the tree structure that makes up this root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with <a>ListParents</a> enables you to traverse the tree structure that makes up this root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListCreateAccountStatus":{
"name":"ListCreateAccountStatus",
@@ -669,7 +691,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Lists the account creation requests that match the specified status that is currently being tracked for the organization.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists the account creation requests that match the specified status that is currently being tracked for the organization.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListDelegatedAdministrators":{
"name":"ListDelegatedAdministrators",
@@ -688,7 +710,7 @@
{"shape":"ServiceException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Lists the AWS accounts that are designated as delegated administrators in this organization.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListDelegatedServicesForAccount":{
"name":"ListDelegatedServicesForAccount",
@@ -709,7 +731,7 @@
{"shape":"ServiceException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>List the AWS services for which the specified account is a delegated administrator.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>List the Amazon Web Services services for which the specified account is a delegated administrator.</p> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListHandshakesForAccount":{
"name":"ListHandshakesForAccount",
@@ -726,7 +748,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists the current handshakes that are associated with the account of the requesting user.</p> <p>Handshakes that are <code>ACCEPTED</code>, <code>DECLINED</code>, or <code>CANCELED</code> appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called from any account in the organization.</p>"
+ "documentation":"<p>Lists the current handshakes that are associated with the account of the requesting user.</p> <p>Handshakes that are <code>ACCEPTED</code>, <code>DECLINED</code>, <code>CANCELED</code>, or <code>EXPIRED</code> appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called from any account in the organization.</p>"
},
"ListHandshakesForOrganization":{
"name":"ListHandshakesForOrganization",
@@ -744,7 +766,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists the handshakes that are associated with the organization that the requesting user is part of. The <code>ListHandshakesForOrganization</code> operation returns a list of handshake structures. Each structure contains details and status about a handshake.</p> <p>Handshakes that are <code>ACCEPTED</code>, <code>DECLINED</code>, or <code>CANCELED</code> appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists the handshakes that are associated with the organization that the requesting user is part of. The <code>ListHandshakesForOrganization</code> operation returns a list of handshake structures. Each structure contains details and status about a handshake.</p> <p>Handshakes that are <code>ACCEPTED</code>, <code>DECLINED</code>, <code>CANCELED</code>, or <code>EXPIRED</code> appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListOrganizationalUnitsForParent":{
"name":"ListOrganizationalUnitsForParent",
@@ -762,7 +784,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists the organizational units (OUs) in a parent organizational unit or root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists the organizational units (OUs) in a parent organizational unit or root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListParents":{
"name":"ListParents",
@@ -780,7 +802,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with <a>ListChildren</a> enables you to traverse the tree structure that makes up this root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p> <note> <p>In the current release, a child can have only a single parent.</p> </note>"
+ "documentation":"<p>Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with <a>ListChildren</a> enables you to traverse the tree structure that makes up this root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p> <note> <p>In the current release, a child can have only a single parent.</p> </note>"
},
"ListPolicies":{
"name":"ListPolicies",
@@ -798,7 +820,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Retrieves the list of all policies in an organization of a specified type.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Retrieves the list of all policies in an organization of a specified type.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListPoliciesForTarget":{
"name":"ListPoliciesForTarget",
@@ -817,7 +839,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListRoots":{
"name":"ListRoots",
@@ -834,7 +856,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists the roots that are defined in the current organization.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p> <note> <p>Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use <a>DescribeOrganization</a>.</p> </note>"
+ "documentation":"<p>Lists the roots that are defined in the current organization.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p> <note> <p>Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use <a>DescribeOrganization</a>.</p> </note>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@@ -852,7 +874,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Lists tags that are attached to the specified resource.</p> <p>You can attach tags to the following resources in AWS Organizations.</p> <ul> <li> <p>AWS account</p> </li> <li> <p>Organization root</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Policy (any type)</p> </li> </ul> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists tags that are attached to the specified resource.</p> <p>You can attach tags to the following resources in Organizations.</p> <ul> <li> <p>Amazon Web Services account</p> </li> <li> <p>Organization root</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Policy (any type)</p> </li> </ul> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"ListTargetsForPolicy":{
"name":"ListTargetsForPolicy",
@@ -871,7 +893,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.</p>"
+ "documentation":"<p>Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a <code>List*</code> operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note> <p>This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.</p>"
},
"MoveAccount":{
"name":"MoveAccount",
@@ -913,7 +935,7 @@
{"shape":"ServiceException"},
{"shape":"UnsupportedAPIEndpointException"}
],
- "documentation":"<p>Enables the specified member account to administer the Organizations features of the specified AWS service. It grants read-only access to AWS Organizations service data. The account still requires IAM permissions to access and administer the AWS service.</p> <p>You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column <i>Supports Delegated Administrator</i> in the table at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html\">AWS Services that you can use with AWS Organizations</a> in the <i>AWS Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Organizations service data. The account still requires IAM permissions to access and administer the Amazon Web Services service.</p> <p>You can run this action only for Amazon Web Services services that support this feature. For a current list of services that support it, see the column <i>Supports Delegated Administrator</i> in the table at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html\">Amazon Web Services Services that you can use with Organizations</a> in the <i>Organizations User Guide.</i> </p> <p>This operation can be called only from the organization's management account.</p>"
},
"RemoveAccountFromOrganization":{
"name":"RemoveAccountFromOrganization",
@@ -933,7 +955,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Removes the specified account from the organization.</p> <p>The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization.</p> <p>This operation can be called only from the organization's management account. Member accounts can remove themselves with <a>LeaveOrganization</a> instead.</p> <important> <ul> <li> <p>You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For an account that you want to make standalone, you must choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account and follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>The account that you want to leave must not be a delegated administrator account for any AWS service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.</p> </li> <li> <p>After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. AWS accounts outside of an organization do not support tags.</p> </li> </ul> </important>"
+ "documentation":"<p>Removes the specified account from the organization.</p> <p>The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's management account is no longer charged for any expenses accrued by the member account after it's removed from the organization.</p> <p>This operation can be called only from the organization's management account. Member accounts can remove themselves with <a>LeaveOrganization</a> instead.</p> <important> <ul> <li> <p>You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For an account that you want to make standalone, you must choose a support plan, provide and verify the required contact information, and provide a current payment method. Amazon Web Services uses the payment method to charge for any billable (not free tier) Amazon Web Services activity that occurs while the account isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account and follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>Organizations User Guide.</i> </p> </li> <li> <p>The account that you want to leave must not be a delegated administrator account for any Amazon Web Services service enabled for your organization. If the account is a delegated administrator, you must first change the delegated administrator account to another account that is remaining in the organization.</p> </li> <li> <p>After the account leaves the organization, all tags that were attached to the account object in the organization are deleted. Amazon Web Services accounts outside of an organization do not support tags.</p> </li> </ul> </important>"
},
"TagResource":{
"name":"TagResource",
@@ -952,7 +974,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Adds one or more tags to the specified resource.</p> <p>Currently, you can attach tags to the following resources in AWS Organizations.</p> <ul> <li> <p>AWS account</p> </li> <li> <p>Organization root</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Policy (any type)</p> </li> </ul> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Adds one or more tags to the specified resource.</p> <p>Currently, you can attach tags to the following resources in Organizations.</p> <ul> <li> <p>Amazon Web Services account</p> </li> <li> <p>Organization root</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Policy (any type)</p> </li> </ul> <p>This operation can be called only from the organization's management account.</p>"
},
"UntagResource":{
"name":"UntagResource",
@@ -971,7 +993,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
- "documentation":"<p>Removes any tags with the specified keys from the specified resource.</p> <p>You can attach tags to the following resources in AWS Organizations.</p> <ul> <li> <p>AWS account</p> </li> <li> <p>Organization root</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Policy (any type)</p> </li> </ul> <p>This operation can be called only from the organization's management account.</p>"
+ "documentation":"<p>Removes any tags with the specified keys from the specified resource.</p> <p>You can attach tags to the following resources in Organizations.</p> <ul> <li> <p>Amazon Web Services account</p> </li> <li> <p>Organization root</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Policy (any type)</p> </li> </ul> <p>This operation can be called only from the organization's management account.</p>"
},
"UpdateOrganizationalUnit":{
"name":"UpdateOrganizationalUnit",
@@ -1060,7 +1082,7 @@
"Message":{"shape":"ExceptionMessage"},
"Reason":{"shape":"AccessDeniedForDependencyExceptionReason"}
},
- "documentation":"<p>The operation that you attempted requires you to have the <code>iam:CreateServiceLinkedRole</code> for <code>organizations.amazonaws.com</code> permission so that AWS Organizations can create the required service-linked role. You don't have that permission.</p>",
+ "documentation":"<p>The operation that you attempted requires you to have the <code>iam:CreateServiceLinkedRole</code> for <code>organizations.amazonaws.com</code> permission so that Organizations can create the required service-linked role. You don't have that permission.</p>",
"exception":true
},
"AccessDeniedForDependencyExceptionReason":{
@@ -1076,11 +1098,11 @@
},
"Arn":{
"shape":"AccountArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of the account.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the account.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"Email":{
"shape":"Email",
- "documentation":"<p>The email address associated with the AWS account.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for this parameter is a string of characters that represents a standard internet email address.</p>"
+ "documentation":"<p>The email address associated with the Amazon Web Services account.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for this parameter is a string of characters that represents a standard internet email address.</p>"
},
"Name":{
"shape":"AccountName",
@@ -1099,14 +1121,22 @@
"documentation":"<p>The date the account became a part of the organization.</p>"
}
},
- "documentation":"<p>Contains information about an AWS account that is a member of an organization.</p>"
+ "documentation":"<p>Contains information about an Amazon Web Services account that is a member of an organization.</p>"
+ },
+ "AccountAlreadyClosedException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>You attempted to close an account that is already closed.</p>",
+ "exception":true
},
"AccountAlreadyRegisteredException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>The specified account is already a delegated administrator for this AWS service.</p>",
+ "documentation":"<p>The specified account is already a delegated administrator for this Amazon Web Services service.</p>",
"exception":true
},
"AccountArn":{
@@ -1127,9 +1157,9 @@
},
"AccountName":{
"type":"string",
- "max":50,
+ "max":128,
"min":1,
- "pattern":"[\\u0020-\\u007E]+",
+ "pattern":"[\\s\\S]*",
"sensitive":true
},
"AccountNotFoundException":{
@@ -1137,7 +1167,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p> We can't find an AWS account with the <code>AccountId</code> that you specified, or the account whose credentials you used to make this request isn't a member of an organization.</p>",
+ "documentation":"<p> We can't find an Amazon Web Services account with the <code>AccountId</code> that you specified, or the account whose credentials you used to make this request isn't a member of an organization.</p>",
"exception":true
},
"AccountNotRegisteredException":{
@@ -1145,7 +1175,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>The specified account is not a delegated administrator for this AWS service. </p>",
+ "documentation":"<p>The specified account is not a delegated administrator for this Amazon Web Services service. </p>",
"exception":true
},
"AccountOwnerNotVerifiedException":{
@@ -1153,14 +1183,15 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>You can't invite an existing account to your organization until you verify that you own the email address associated with the management account. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html#about-email-verification\">Email Address Verification</a> in the <i>AWS Organizations User Guide.</i> </p>",
+ "documentation":"<p>You can't invite an existing account to your organization until you verify that you own the email address associated with the management account. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html#about-email-verification\">Email Address Verification</a> in the <i>Organizations User Guide.</i> </p>",
"exception":true
},
"AccountStatus":{
"type":"string",
"enum":[
"ACTIVE",
- "SUSPENDED"
+ "SUSPENDED",
+ "PENDING_CLOSURE"
]
},
"Accounts":{
@@ -1245,7 +1276,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>We can't find an organizational unit (OU) or AWS account with the <code>ChildId</code> that you specified.</p>",
+ "documentation":"<p>We can't find an organizational unit (OU) or Amazon Web Services account with the <code>ChildId</code> that you specified.</p>",
"exception":true
},
"ChildType":{
@@ -1259,6 +1290,16 @@
"type":"list",
"member":{"shape":"Child"}
},
+ "CloseAccountRequest":{
+ "type":"structure",
+ "required":["AccountId"],
+ "members":{
+ "AccountId":{
+ "shape":"AccountId",
+ "documentation":"<p>Retrieves the Amazon Web Services account Id for the current <code>CloseAccount</code> API request. </p>"
+ }
+ }
+ },
"ConcurrentModificationException":{
"type":"structure",
"members":{
@@ -1267,13 +1308,21 @@
"documentation":"<p>The target of the operation is currently being modified by a different request. Try again later.</p>",
"exception":true
},
+ "ConflictException":{
+ "type":"structure",
+ "members":{
+ "Message":{"shape":"ExceptionMessage"}
+ },
+ "documentation":"<p>The request failed because it conflicts with the current state of the specified resource.</p>",
+ "exception":true
+ },
"ConstraintViolationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"},
"Reason":{"shape":"ConstraintViolationExceptionReason"}
},
- "documentation":"<p>Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.</p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#orgs_manage_accounts_remove-from-master\">Removing a member account from your organization</a>in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#orgs_manage_accounts_remove-from-master\">Removing a member account from your organization</a> in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.</p> </li> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a> to request an increase in your limit. </p> <p>Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.</p> <note> <p>Deleted and closed accounts still count toward your limit.</p> </note> <important> <p>If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </important> </li> <li> <p>CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an AWS service integrated with Organizations. You can designate only a member account as a delegated administrator.</p> </li> <li> <p>CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator. </p> </li> <li> <p>CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.</p> </li> <li> <p>DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an AWS account as a delegated administrator for an AWS service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.</p> </li> <li> <p>EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.</p> </li> <li> <p>MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.</p> </li> <li> <p>MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.</p> </li> <li> <p>MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.</p> </li> <li> <p>MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the management account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see <a href=\"http://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html\">AWS Organizations</a> in the <i>AWS GovCloud User Guide.</i> </p> </li> <li> <p>MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal. </p> </li> <li> <p>MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.</p> </li> <li> <p>MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource. </p> </li> <li> <p>MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide.</i> </p> </li> <li> <p>MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.</p> </li> <li> <p>ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.</p> </li> <li> <p>OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.</p> </li> <li> <p>OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.</p> </li> <li> <p>POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.</p> </li> <li> <p>POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies that you can have in an organization.</p> </li> <li> <p>TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.</p> </li> </ul>",
+ "documentation":"<p>Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.</p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#orgs_manage_accounts_remove-from-master\">Removing a member account from your organization</a> in the <i>Organizations User Guide.</i> </p> </li> <li> <p>ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.</p> </li> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact <a href=\"https://docs.aws.amazon.com/support/home#/\">Amazon Web Services Support</a> to request an increase in your limit. </p> <p>Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact Amazon Web Services Support to request an increase in the number of accounts.</p> <note> <p>Deleted and closed accounts still count toward your limit.</p> </note> <important> <p>If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact <a href=\"https://docs.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </important> </li> <li> <p>CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an Amazon Web Services service integrated with Organizations. You can designate only a member account as a delegated administrator.</p> </li> <li> <p>CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator. </p> </li> <li> <p>CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.</p> </li> <li> <p>DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.</p> </li> <li> <p>EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.</p> </li> <li> <p>MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.</p> </li> <li> <p>MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services /&gt; Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.</p> </li> <li> <p>MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.</p> </li> <li> <p>MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the management account must have an associated account in the Amazon Web Services GovCloud (US-West) Region. For more information, see <a href=\"https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html\">Organizations</a> in the <i>Amazon Web Services GovCloud User Guide.</i> </p> </li> <li> <p>MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>Organizations User Guide.</i> </p> </li> <li> <p>MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal. </p> </li> <li> <p>MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.</p> </li> <li> <p>MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource. </p> </li> <li> <p>MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>Organizations User Guide.</i> </p> </li> <li> <p>MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.</p> </li> <li> <p>ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.</p> </li> <li> <p>OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.</p> </li> <li> <p>OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.</p> </li> <li> <p>POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.</p> </li> <li> <p>POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies that you can have in an organization.</p> </li> <li> <p>SERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated administrator before you enabled service access. Call the <code>EnableAWSServiceAccess</code> API first.</p> </li> <li> <p>TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.</p> </li> <li> <p>WAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a waiting period before you can remove it from the organization. If you get an error that indicates that a wait period is required, try again in a few days.</p> </li> </ul>",
"exception":true
},
"ConstraintViolationExceptionReason":{
@@ -1306,7 +1355,11 @@
"CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR",
"CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG",
"DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE",
- "MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE"
+ "MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE",
+ "CANNOT_CLOSE_MANAGEMENT_ACCOUNT",
+ "CLOSE_ACCOUNT_QUOTA_EXCEEDED",
+ "CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED",
+ "SERVICE_ACCESS_NOT_ENABLED"
]
},
"CreateAccountFailureReason":{
@@ -1327,6 +1380,13 @@
"MISSING_PAYMENT_INSTRUMENT"
]
},
+ "CreateAccountName":{
+ "type":"string",
+ "max":50,
+ "min":1,
+ "pattern":"[\\u0020-\\u007E]+",
+ "sensitive":true
+ },
"CreateAccountRequest":{
"type":"structure",
"required":[
@@ -1336,23 +1396,23 @@
"members":{
"Email":{
"shape":"Email",
- "documentation":"<p>The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address.</p>"
+ "documentation":"<p>The email address of the owner to assign to the new member account. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.</p> <p>The rules for a valid email address:</p> <ul> <li> <p>The address must be a minimum of 6 and a maximum of 64 characters long.</p> </li> <li> <p>All characters must be 7-bit ASCII characters.</p> </li> <li> <p>There must be one and only one @ symbol, which separates the local name from the domain name.</p> </li> <li> <p>The local name can't contain any of the following characters:</p> <p>whitespace, \" ' ( ) &lt; &gt; [ ] : ; , \\ | % &amp;</p> </li> <li> <p>The local name can't begin with a dot (.)</p> </li> <li> <p>The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)</p> </li> <li> <p>The domain name can't begin or end with a hyphen (-) or dot (.)</p> </li> <li> <p>The domain name must contain at least one dot</p> </li> </ul> <p>You can't access the root user of the account or remove an account that was created with an invalid email address.</p>"
},
"AccountName":{
- "shape":"AccountName",
+ "shape":"CreateAccountName",
"documentation":"<p>The friendly name of the member account.</p>"
},
"RoleName":{
"shape":"RoleName",
- "documentation":"<p>(Optional)</p> <p>The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.</p> <p>If you don't specify this parameter, the role name defaults to <code>OrganizationAccountAccessRole</code>.</p> <p>For more information about how to use this role to access the member account, see the following links:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role\">Accessing and Administering the Member Accounts in Your Organization</a> in the <i>AWS Organizations User Guide</i> </p> </li> <li> <p>Steps 2 and 3 in <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html\">Tutorial: Delegate Access Across AWS Accounts Using IAM Roles</a> in the <i>IAM User Guide</i> </p> </li> </ul> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-</p>"
+ "documentation":"<p>(Optional)</p> <p>The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.</p> <p>If you don't specify this parameter, the role name defaults to <code>OrganizationAccountAccessRole</code>.</p> <p>For more information about how to use this role to access the member account, see the following links:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role\">Accessing and Administering the Member Accounts in Your Organization</a> in the <i>Organizations User Guide</i> </p> </li> <li> <p>Steps 2 and 3 in <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html\">Tutorial: Delegate Access Across Amazon Web Services accounts Using IAM Roles</a> in the <i>IAM User Guide</i> </p> </li> </ul> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-</p>"
},
"IamUserAccessToBilling":{
"shape":"IAMUserAccessToBilling",
- "documentation":"<p>If set to <code>ALLOW</code>, the new account enables IAM users to access account billing information <i>if</i> they have the required permissions. If set to <code>DENY</code>, only the root user of the new account can access account billing information. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>If you don't specify this parameter, the value defaults to <code>ALLOW</code>, and IAM users and roles with the required permissions can access billing information for the new account.</p>"
+ "documentation":"<p>If set to <code>ALLOW</code>, the new account enables IAM users to access account billing information <i>if</i> they have the required permissions. If set to <code>DENY</code>, only the root user of the new account can access account billing information. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p> <p>If you don't specify this parameter, the value defaults to <code>ALLOW</code>, and IAM users and roles with the required permissions can access billing information for the new account.</p>"
},
"Tags":{
"shape":"Tags",
- "documentation":"<p>A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging AWS Organizations resources</a> in the AWS Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and the account is not created.</p> </note>"
+ "documentation":"<p>A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging Organizations resources</a> in the Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.</p> </note>"
}
}
},
@@ -1366,7 +1426,7 @@
"members":{
"CreateAccountStatus":{
"shape":"CreateAccountStatus",
- "documentation":"<p>A structure that contains details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned <code>CreateAccountStatus</code> ID as a parameter to <a>DescribeCreateAccountStatus</a> to get status about the progress of the request at later times. You can also check the AWS CloudTrail log for the <code>CreateAccountResult</code> event. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html\">Monitoring the Activity in Your Organization</a> in the <i>AWS Organizations User Guide</i>.</p>"
+ "documentation":"<p>A structure that contains details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned <code>CreateAccountStatus</code> ID as a parameter to <a>DescribeCreateAccountStatus</a> to get status about the progress of the request at later times. You can also check the CloudTrail log for the <code>CreateAccountResult</code> event. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html\">Monitoring the Activity in Your Organization</a> in the <i>Organizations User Guide</i>.</p>"
}
}
},
@@ -1390,12 +1450,12 @@
"documentation":"<p>The unique identifier (ID) that references this request. You get this value from the response of the initial <a>CreateAccount</a> request to create the account.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a create account request ID string requires \"car-\" followed by from 8 to 32 lowercase letters or digits.</p>"
},
"AccountName":{
- "shape":"AccountName",
+ "shape":"CreateAccountName",
"documentation":"<p>The account name given to the account when it was created.</p>"
},
"State":{
"shape":"CreateAccountState",
- "documentation":"<p>The status of the asynchronous request to create an AWS account.</p>"
+ "documentation":"<p>The status of the asynchronous request to create an Amazon Web Services account.</p>"
},
"RequestedTimestamp":{
"shape":"Timestamp",
@@ -1411,14 +1471,14 @@
},
"GovCloudAccountId":{
"shape":"AccountId",
- "documentation":"<p>If the account was created successfully, the unique identifier (ID) of the new account in the AWS GovCloud (US) Region.</p>"
+ "documentation":"<p>If the account was created successfully, the unique identifier (ID) of the new account in the Amazon Web Services GovCloud (US) Region.</p>"
},
"FailureReason":{
"shape":"CreateAccountFailureReason",
- "documentation":"<p>If the request failed, a description of the reason for the failure.</p> <ul> <li> <p>ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the limit on the number of accounts in your organization.</p> </li> <li> <p>CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information.</p> </li> <li> <p>EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.</p> </li> <li> <p>FAILED_BUSINESS_VALIDATION: The AWS account that owns your organization failed to receive business license validation.</p> </li> <li> <p>GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.</p> </li> <li> <p>IDENTITY_INVALID_BUSINESS_VALIDATION: The AWS account that owns your organization can't complete business license validation because it doesn't have valid identity data.</p> </li> <li> <p>INVALID_ADDRESS: The account could not be created because the address you provided is not valid.</p> </li> <li> <p>INVALID_EMAIL: The account could not be created because the email address you provided is not valid.</p> </li> <li> <p>INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact AWS Customer Support.</p> </li> <li> <p>MISSING_BUSINESS_VALIDATION: The AWS account that owns your organization has not received Business Validation.</p> </li> <li> <p> MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card.</p> </li> <li> <p>PENDING_BUSINESS_VALIDATION: The AWS account that owns your organization is still in the process of completing business license validation.</p> </li> <li> <p>UNKNOWN_BUSINESS_VALIDATION: The AWS account that owns your organization has an unknown issue with business license validation.</p> </li> </ul>"
+ "documentation":"<p>If the request failed, a description of the reason for the failure.</p> <ul> <li> <p>ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the limit on the number of accounts in your organization.</p> </li> <li> <p>CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information.</p> </li> <li> <p>EMAIL_ALREADY_EXISTS: The account could not be created because another Amazon Web Services account with that email address already exists.</p> </li> <li> <p>FAILED_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization failed to receive business license validation.</p> </li> <li> <p>GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the Amazon Web Services GovCloud (US) Region could not be created because this Region already includes an account with that email address.</p> </li> <li> <p>IDENTITY_INVALID_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization can't complete business license validation because it doesn't have valid identity data.</p> </li> <li> <p>INVALID_ADDRESS: The account could not be created because the address you provided is not valid.</p> </li> <li> <p>INVALID_EMAIL: The account could not be created because the email address you provided is not valid.</p> </li> <li> <p>INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Amazon Web Services Customer Support.</p> </li> <li> <p>MISSING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has not received Business Validation.</p> </li> <li> <p> MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card.</p> </li> <li> <p>PENDING_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization is still in the process of completing business license validation.</p> </li> <li> <p>UNKNOWN_BUSINESS_VALIDATION: The Amazon Web Services account that owns your organization has an unknown issue with business license validation.</p> </li> </ul>"
}
},
- "documentation":"<p>Contains the status about a <a>CreateAccount</a> or <a>CreateGovCloudAccount</a> request to create an AWS account or an AWS GovCloud (US) account in an organization.</p>"
+ "documentation":"<p>Contains the status about a <a>CreateAccount</a> or <a>CreateGovCloudAccount</a> request to create an Amazon Web Services account or an Amazon Web Services GovCloud (US) account in an organization.</p>"
},
"CreateAccountStatusNotFoundException":{
"type":"structure",
@@ -1441,23 +1501,23 @@
"members":{
"Email":{
"shape":"Email",
- "documentation":"<p>The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for <code>CreateGovCloudAccount</code>, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region.</p>"
+ "documentation":"<p>Specifies the email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another Amazon Web Services account. You must use a valid email address to complete account creation.</p> <p>The rules for a valid email address:</p> <ul> <li> <p>The address must be a minimum of 6 and a maximum of 64 characters long.</p> </li> <li> <p>All characters must be 7-bit ASCII characters.</p> </li> <li> <p>There must be one and only one @ symbol, which separates the local name from the domain name.</p> </li> <li> <p>The local name can't contain any of the following characters:</p> <p>whitespace, \" ' ( ) &lt; &gt; [ ] : ; , \\ | % &amp;</p> </li> <li> <p>The local name can't begin with a dot (.)</p> </li> <li> <p>The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.)</p> </li> <li> <p>The domain name can't begin or end with a hyphen (-) or dot (.)</p> </li> <li> <p>The domain name must contain at least one dot</p> </li> </ul> <p>You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for <code>CreateGovCloudAccount</code>, the request for the email address for the Amazon Web Services GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.</p>"
},
"AccountName":{
- "shape":"AccountName",
+ "shape":"CreateAccountName",
"documentation":"<p>The friendly name of the member account.</p>"
},
"RoleName":{
"shape":"RoleName",
- "documentation":"<p>(Optional)</p> <p>The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.</p> <p>If you don't specify this parameter, the role name defaults to <code>OrganizationAccountAccessRole</code>.</p> <p>For more information about how to use this role to access the member account, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role\">Accessing and Administering the Member Accounts in Your Organization</a> in the <i>AWS Organizations User Guide</i> and steps 2 and 3 in <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html\">Tutorial: Delegate Access Across AWS Accounts Using IAM Roles</a> in the <i>IAM User Guide.</i> </p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-</p>"
+ "documentation":"<p>(Optional)</p> <p>The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account.</p> <p>If you don't specify this parameter, the role name defaults to <code>OrganizationAccountAccessRole</code>.</p> <p>For more information about how to use this role to access the member account, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role\">Accessing and Administering the Member Accounts in Your Organization</a> in the <i>Organizations User Guide</i> and steps 2 and 3 in <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html\">Tutorial: Delegate Access Across Amazon Web Services accounts Using IAM Roles</a> in the <i>IAM User Guide.</i> </p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-</p>"
},
"IamUserAccessToBilling":{
"shape":"IAMUserAccessToBilling",
- "documentation":"<p>If set to <code>ALLOW</code>, the new linked account in the commercial Region enables IAM users to access account billing information <i>if</i> they have the required permissions. If set to <code>DENY</code>, only the root user of the new account can access account billing information. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide.</i> </p> <p>If you don't specify this parameter, the value defaults to <code>ALLOW</code>, and IAM users and roles with the required permissions can access billing information for the new account.</p>"
+ "documentation":"<p>If set to <code>ALLOW</code>, the new linked account in the commercial Region enables IAM users to access account billing information <i>if</i> they have the required permissions. If set to <code>DENY</code>, only the root user of the new account can access account billing information. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>Amazon Web Services Billing and Cost Management User Guide.</i> </p> <p>If you don't specify this parameter, the value defaults to <code>ALLOW</code>, and IAM users and roles with the required permissions can access billing information for the new account.</p>"
},
"Tags":{
"shape":"Tags",
- "documentation":"<p>A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the <a>TagResource</a> operation in the GovCloud region after the new GovCloud account exists.</p> <p>For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging AWS Organizations resources</a> in the AWS Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and the account is not created.</p> </note>"
+ "documentation":"<p>A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the <a>TagResource</a> operation in the GovCloud region after the new GovCloud account exists.</p> <p>For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging Organizations resources</a> in the Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.</p> </note>"
}
}
},
@@ -1472,7 +1532,7 @@
"members":{
"FeatureSet":{
"shape":"OrganizationFeatureSet",
- "documentation":"<p>Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.</p> <ul> <li> <p> <code>CONSOLIDATED_BILLING</code>: All member accounts have their bills consolidated to and paid by the management account. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only\">Consolidated billing</a> in the <i>AWS Organizations User Guide.</i> </p> <p> The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.</p> </li> <li> <p> <code>ALL</code>: In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all\">All features</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul>"
+ "documentation":"<p>Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.</p> <ul> <li> <p> <code>CONSOLIDATED_BILLING</code>: All member accounts have their bills consolidated to and paid by the management account. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only\">Consolidated billing</a> in the <i>Organizations User Guide.</i> </p> <p> The consolidated billing feature subset isn't available for organizations in the Amazon Web Services GovCloud (US) Region.</p> </li> <li> <p> <code>ALL</code>: In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all\">All features</a> in the <i>Organizations User Guide.</i> </p> </li> </ul>"
}
}
},
@@ -1502,7 +1562,7 @@
},
"Tags":{
"shape":"Tags",
- "documentation":"<p>A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging AWS Organizations resources</a> in the AWS Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.</p> </note>"
+ "documentation":"<p>A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging Organizations resources</a> in the Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.</p> </note>"
}
}
},
@@ -1542,7 +1602,7 @@
},
"Tags":{
"shape":"Tags",
- "documentation":"<p>A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging AWS Organizations resources</a> in the AWS Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.</p> </note>"
+ "documentation":"<p>A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging Organizations resources</a> in the Organizations User Guide.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.</p> </note>"
}
}
},
@@ -1587,7 +1647,7 @@
},
"Email":{
"shape":"Email",
- "documentation":"<p>The email address that is associated with the delegated administrator's AWS account.</p>"
+ "documentation":"<p>The email address that is associated with the delegated administrator's Amazon Web Services account.</p>"
},
"Name":{
"shape":"AccountName",
@@ -1621,14 +1681,14 @@
"members":{
"ServicePrincipal":{
"shape":"ServicePrincipal",
- "documentation":"<p>The name of an AWS service that can request an operation for the specified service. This is typically in the form of a URL, such as: <code> <i>servicename</i>.amazonaws.com</code>.</p>"
+ "documentation":"<p>The name of an Amazon Web Services service that can request an operation for the specified service. This is typically in the form of a URL, such as: <code> <i>servicename</i>.amazonaws.com</code>.</p>"
},
"DelegationEnabledDate":{
"shape":"Timestamp",
"documentation":"<p>The date that the account became a delegated administrator for this service. </p>"
}
},
- "documentation":"<p>Contains information about the AWS service for which the account is a delegated administrator.</p>"
+ "documentation":"<p>Contains information about the Amazon Web Services service for which the account is a delegated administrator.</p>"
},
"DelegatedServices":{
"type":"list",
@@ -1667,7 +1727,7 @@
},
"ServicePrincipal":{
"shape":"ServicePrincipal",
- "documentation":"<p>The service principal name of an AWS service for which the account is a delegated administrator.</p> <p>Delegated administrator privileges are revoked for only the specified AWS service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions.</p>"
+ "documentation":"<p>The service principal name of an Amazon Web Services service for which the account is a delegated administrator.</p> <p>Delegated administrator privileges are revoked for only the specified Amazon Web Services service from the member account. If the specified service is the only service for which the member account is a delegated administrator, the operation also revokes Organizations read action permissions.</p>"
}
}
},
@@ -1677,7 +1737,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
- "documentation":"<p>The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the <a>ListAccounts</a> or <a>ListAccountsForParent</a> operations.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for an account ID string requires exactly 12 digits.</p>"
+ "documentation":"<p>The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the <a>ListAccounts</a> or <a>ListAccountsForParent</a> operations.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for an account ID string requires exactly 12 digits.</p>"
}
}
},
@@ -1829,7 +1889,7 @@
"members":{
"ServicePrincipal":{
"shape":"ServicePrincipal",
- "documentation":"<p>The service principal name of the AWS service for which you want to disable integration with your organization. This is typically in the form of a URL, such as <code> <i>service-abbreviation</i>.amazonaws.com</code>.</p>"
+ "documentation":"<p>The service principal name of the Amazon Web Services service for which you want to disable integration with your organization. This is typically in the form of a URL, such as <code> <i>service-abbreviation</i>.amazonaws.com</code>.</p>"
}
}
},
@@ -1950,7 +2010,7 @@
"members":{
"ServicePrincipal":{
"shape":"ServicePrincipal",
- "documentation":"<p>The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as <code> <i>service-abbreviation</i>.amazonaws.com</code>.</p>"
+ "documentation":"<p>The service principal name of the Amazon Web Services service for which you want to enable integration with your organization. This is typically in the form of a URL, such as <code> <i>service-abbreviation</i>.amazonaws.com</code>.</p>"
}
}
},
@@ -2003,10 +2063,10 @@
},
"DateEnabled":{
"shape":"Timestamp",
- "documentation":"<p>The date that the service principal was enabled for integration with AWS Organizations.</p>"
+ "documentation":"<p>The date that the service principal was enabled for integration with Organizations.</p>"
}
},
- "documentation":"<p>A structure that contains details of a service principal that represents an AWS service that is enabled to integrate with AWS Organizations.</p>"
+ "documentation":"<p>A structure that contains details of a service principal that represents an Amazon Web Services service that is enabled to integrate with Organizations.</p>"
},
"EnabledServicePrincipals":{
"type":"list",
@@ -2019,7 +2079,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p>",
+ "documentation":"<p>Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact <a href=\"https://console.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p>",
"exception":true
},
"GenericArn":{
@@ -2035,7 +2095,7 @@
},
"Arn":{
"shape":"HandshakeArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of a handshake.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of a handshake.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"Parties":{
"shape":"HandshakeParties",
@@ -2062,7 +2122,7 @@
"documentation":"<p>Additional information that is needed to process the handshake.</p>"
}
},
- "documentation":"<p>Contains information that must be exchanged to securely establish a relationship between two accounts (an <i>originator</i> and a <i>recipient</i>). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.</p> <p> <b>Note:</b> Handshakes that are <code>CANCELED</code>, <code>ACCEPTED</code>, or <code>DECLINED</code> show up in lists for only 30 days after entering that state After that they are deleted.</p>"
+ "documentation":"<p>Contains information that must be exchanged to securely establish a relationship between two accounts (an <i>originator</i> and a <i>recipient</i>). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.</p> <p> <b>Note:</b> Handshakes that are <code>CANCELED</code>, <code>ACCEPTED</code>, <code>DECLINED</code>, or <code>EXPIRED</code> show up in lists for only 30 days after entering that state After that they are deleted.</p>"
},
"HandshakeAlreadyInStateException":{
"type":"structure",
@@ -2082,7 +2142,7 @@
"Message":{"shape":"ExceptionMessage"},
"Reason":{"shape":"HandshakeConstraintViolationExceptionReason"}
},
- "documentation":"<p>The requested operation would violate the constraint identified in the reason code.</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation:</p> </note> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note that deleted and closed accounts still count toward your limit.</p> <important> <p>If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </important> </li> <li> <p>ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.</p> </li> <li> <p>INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.</p> </li> <li> <p>ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.</p> </li> <li> <p>ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable all features.</p> </li> <li> <p>ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.</p> </li> <li> <p>ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.</p> </li> <li> <p>PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.</p> </li> </ul>",
+ "documentation":"<p>The requested operation would violate the constraint identified in the reason code.</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation:</p> </note> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note that deleted and closed accounts still count toward your limit.</p> <important> <p>If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact <a href=\"https://docs.aws.amazon.com/support/home#/\">Amazon Web Services Support</a>.</p> </important> </li> <li> <p>ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.</p> </li> <li> <p>INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.</p> </li> <li> <p>ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.</p> </li> <li> <p>ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable all features.</p> </li> <li> <p>ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.</p> </li> <li> <p>ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.</p> </li> <li> <p>PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.</p> </li> </ul>",
"exception":true
},
"HandshakeConstraintViolationExceptionReason":{
@@ -2096,7 +2156,8 @@
"INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES",
"PAYMENT_INSTRUMENT_REQUIRED",
"ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD",
- "ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED"
+ "ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED",
+ "MANAGEMENT_ACCOUNT_EMAIL_NOT_VERIFIED"
]
},
"HandshakeFilter":{
@@ -2178,7 +2239,7 @@
},
"Type":{
"shape":"HandshakeResourceType",
- "documentation":"<p>The type of information being passed, specifying how the value is to be interpreted by the other party:</p> <ul> <li> <p> <code>ACCOUNT</code> - Specifies an AWS account ID number.</p> </li> <li> <p> <code>ORGANIZATION</code> - Specifies an organization ID number.</p> </li> <li> <p> <code>EMAIL</code> - Specifies the email address that is associated with the account that receives the handshake. </p> </li> <li> <p> <code>OWNER_EMAIL</code> - Specifies the email address associated with the management account. Included as information about an organization. </p> </li> <li> <p> <code>OWNER_NAME</code> - Specifies the name associated with the management account. Included as information about an organization. </p> </li> <li> <p> <code>NOTES</code> - Additional text provided by the handshake initiator and intended for the recipient to read.</p> </li> </ul>"
+ "documentation":"<p>The type of information being passed, specifying how the value is to be interpreted by the other party:</p> <ul> <li> <p> <code>ACCOUNT</code> - Specifies an Amazon Web Services account ID number.</p> </li> <li> <p> <code>ORGANIZATION</code> - Specifies an organization ID number.</p> </li> <li> <p> <code>EMAIL</code> - Specifies the email address that is associated with the account that receives the handshake. </p> </li> <li> <p> <code>OWNER_EMAIL</code> - Specifies the email address associated with the management account. Included as information about an organization. </p> </li> <li> <p> <code>OWNER_NAME</code> - Specifies the name associated with the management account. Included as information about an organization. </p> </li> <li> <p> <code>NOTES</code> - Additional text provided by the handshake initiator and intended for the recipient to read.</p> </li> </ul>"
},
"Resources":{
"shape":"HandshakeResources",
@@ -2244,7 +2305,7 @@
"Message":{"shape":"ExceptionMessage"},
"Reason":{"shape":"InvalidInputExceptionReason"}
},
- "documentation":"<p>The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.</p> </li> <li> <p>IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.</p> </li> <li> <p>INPUT_REQUIRED: You must include a value for all required parameters.</p> </li> <li> <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.</p> </li> <li> <p>INVALID_ENUM: You specified an invalid value.</p> </li> <li> <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p> </li> <li> <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.</p> </li> <li> <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.</p> </li> <li> <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code> parameter from the response to a previous call of the operation.</p> </li> <li> <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.</p> </li> <li> <p>INVALID_PATTERN: You provided a value that doesn't match the required pattern.</p> </li> <li> <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.</p> </li> <li> <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p> </li> <li> <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.</p> </li> <li> <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p> </li> <li> <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.</p> </li> <li> <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.</p> </li> <li> <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.</p> </li> <li> <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.</p> </li> <li> <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.</p> </li> <li> <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.</p> </li> <li> <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.</p> </li> <li> <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.</p> </li> <li> <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.</p> </li> </ul>",
+ "documentation":"<p>The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.</p> </li> <li> <p>IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be modified.</p> </li> <li> <p>INPUT_REQUIRED: You must include a value for all required parameters.</p> </li> <li> <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.</p> </li> <li> <p>INVALID_ENUM: You specified an invalid value.</p> </li> <li> <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p> </li> <li> <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.</p> </li> <li> <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.</p> </li> <li> <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code> parameter from the response to a previous call of the operation.</p> </li> <li> <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.</p> </li> <li> <p>INVALID_PATTERN: You provided a value that doesn't match the required pattern.</p> </li> <li> <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.</p> </li> <li> <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p> </li> <li> <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.</p> </li> <li> <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p> </li> <li> <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for Amazon Web Services use. System tags don’t count against your tags per resource limit.</p> </li> <li> <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.</p> </li> <li> <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.</p> </li> <li> <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.</p> </li> <li> <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.</p> </li> <li> <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.</p> </li> <li> <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.</p> </li> <li> <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.</p> </li> <li> <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.</p> </li> </ul>",
"exception":true
},
"InvalidInputExceptionReason":{
@@ -2282,7 +2343,7 @@
"members":{
"Target":{
"shape":"HandshakeParty",
- "documentation":"<p>The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:</p> <p> <code>{ \"Type\": \"ACCOUNT\", \"Id\": \"&lt;<i> <b>account id number</b> </i>&gt;\" }</code> </p> <p>If you use the AWS CLI, you can submit this as a single string, similar to the following example:</p> <p> <code>--target Id=123456789012,Type=ACCOUNT</code> </p> <p>If you specify <code>\"Type\": \"ACCOUNT\"</code>, you must provide the AWS account ID number as the <code>Id</code>. If you specify <code>\"Type\": \"EMAIL\"</code>, you must specify the email address that is associated with the account.</p> <p> <code>--target Id=diego@example.com,Type=EMAIL</code> </p>"
+ "documentation":"<p>The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:</p> <p> <code>{ \"Type\": \"ACCOUNT\", \"Id\": \"&lt;<i> <b>account id number</b> </i>&gt;\" }</code> </p> <p>If you use the CLI, you can submit this as a single string, similar to the following example:</p> <p> <code>--target Id=123456789012,Type=ACCOUNT</code> </p> <p>If you specify <code>\"Type\": \"ACCOUNT\"</code>, you must provide the Amazon Web Services account ID number as the <code>Id</code>. If you specify <code>\"Type\": \"EMAIL\"</code>, you must specify the email address that is associated with the account.</p> <p> <code>--target Id=diego@example.com,Type=EMAIL</code> </p>"
},
"Notes":{
"shape":"HandshakeNotes",
@@ -2290,7 +2351,7 @@
},
"Tags":{
"shape":"Tags",
- "documentation":"<p>A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging AWS Organizations resources</a> in the AWS Organizations User Guide.</p> <important> <p>Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is <i> <b>not</b> </i> checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.</p> </important> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.</p> </note>"
+ "documentation":"<p>A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html\">Tagging Organizations resources</a> in the Organizations User Guide.</p> <important> <p>Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is <i> <b>not</b> </i> checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.</p> </important> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.</p> </note>"
}
}
},
@@ -2321,7 +2382,7 @@
"members":{
"EnabledServicePrincipals":{
"shape":"EnabledServicePrincipals",
- "documentation":"<p>A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with AWS Organizations.</p>"
+ "documentation":"<p>A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with Organizations.</p>"
},
"NextToken":{
"shape":"NextToken",
@@ -2738,7 +2799,7 @@
"members":{
"ResourceId":{
"shape":"TaggableResourceId",
- "documentation":"<p>The ID of the resource with the tags to list.</p> <p>You can specify any of the following taggable resources.</p> <ul> <li> <p>AWS account – specify the account ID number.</p> </li> <li> <p>Organizational unit – specify the OU ID that begins with <code>ou-</code> and looks similar to: <code>ou-<i>1a2b-34uvwxyz</i> </code> </p> </li> <li> <p>Root – specify the root ID that begins with <code>r-</code> and looks similar to: <code>r-<i>1a2b</i> </code> </p> </li> <li> <p>Policy – specify the policy ID that begins with <code>p-</code> andlooks similar to: <code>p-<i>12abcdefg3</i> </code> </p> </li> </ul>"
+ "documentation":"<p>The ID of the resource with the tags to list.</p> <p>You can specify any of the following taggable resources.</p> <ul> <li> <p>Amazon Web Services account – specify the account ID number.</p> </li> <li> <p>Organizational unit – specify the OU ID that begins with <code>ou-</code> and looks similar to: <code>ou-<i>1a2b-34uvwxyz</i> </code> </p> </li> <li> <p>Root – specify the root ID that begins with <code>r-</code> and looks similar to: <code>r-<i>1a2b</i> </code> </p> </li> <li> <p>Policy – specify the policy ID that begins with <code>p-</code> andlooks similar to: <code>p-<i>12abcdefg3</i> </code> </p> </li> </ul>"
},
"NextToken":{
"shape":"NextToken",
@@ -2795,7 +2856,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>The provided policy document doesn't meet the requirements of the specified policy type. For example, the syntax might be incorrect. For details about service control policy syntax, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html\">Service Control Policy Syntax</a> in the <i>AWS Organizations User Guide.</i> </p>",
+ "documentation":"<p>The provided policy document doesn't meet the requirements of the specified policy type. For example, the syntax might be incorrect. For details about service control policy syntax, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html\">Service Control Policy Syntax</a> in the <i>Organizations User Guide.</i> </p>",
"exception":true
},
"MasterCannotLeaveOrganizationException":{
@@ -2848,15 +2909,15 @@
},
"Arn":{
"shape":"OrganizationArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of an organization.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of an organization.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"FeatureSet":{
"shape":"OrganizationFeatureSet",
- "documentation":"<p>Specifies the functionality that currently is available to the organization. If set to \"ALL\", then all features are enabled and policies can be applied to accounts in the organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing functionality is available. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide</i>.</p>"
+ "documentation":"<p>Specifies the functionality that currently is available to the organization. If set to \"ALL\", then all features are enabled and policies can be applied to accounts in the organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing functionality is available. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>Organizations User Guide</i>.</p>"
},
"MasterAccountArn":{
"shape":"AccountArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"MasterAccountId":{
"shape":"AccountId",
@@ -2864,7 +2925,7 @@
},
"MasterAccountEmail":{
"shape":"Email",
- "documentation":"<p>The email address that is associated with the AWS account that is designated as the management account for the organization.</p>"
+ "documentation":"<p>The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.</p>"
},
"AvailablePolicyTypes":{
"shape":"PolicyTypes",
@@ -2905,14 +2966,14 @@
},
"Arn":{
"shape":"OrganizationalUnitArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of this OU.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of this OU.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"Name":{
"shape":"OrganizationalUnitName",
"documentation":"<p>The friendly name of this OU.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range.</p>"
}
},
- "documentation":"<p>Contains details about an organizational unit (OU). An OU is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.</p>"
+ "documentation":"<p>Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.</p>"
},
"OrganizationalUnitArn":{
"type":"string",
@@ -3072,7 +3133,7 @@
},
"Arn":{
"shape":"PolicyArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of the policy.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the policy.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"Name":{
"shape":"PolicyName",
@@ -3088,7 +3149,7 @@
},
"AwsManaged":{
"shape":"AwsManagedPolicy",
- "documentation":"<p>A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.</p>"
+ "documentation":"<p>A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.</p>"
}
},
"documentation":"<p>Contains information about a policy, but does not include the content. To see the content of a policy, see <a>DescribePolicy</a>.</p>"
@@ -3107,7 +3168,7 @@
},
"Arn":{
"shape":"GenericArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of the policy target.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the policy target.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"Name":{
"shape":"TargetName",
@@ -3146,7 +3207,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable SCPs only after you enable all features in the organization. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#enable_policies_on_root\">Managing AWS Organizations Policies</a>in the <i>AWS Organizations User Guide.</i> </p>",
+ "documentation":"<p>You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable SCPs only after you enable all features in the organization. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#enable_policies_on_root\">Managing Organizations Policies</a>in the <i>Organizations User Guide.</i> </p>",
"exception":true
},
"PolicyTypeNotEnabledException":{
@@ -3154,7 +3215,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>The specified policy type isn't currently enabled in this root. You can't attach policies of the specified type to entities in a root until you enable that type in the root. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p>",
+ "documentation":"<p>The specified policy type isn't currently enabled in this root. You can't attach policies of the specified type to entities in a root until you enable that type in the root. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>Organizations User Guide.</i> </p>",
"exception":true
},
"PolicyTypeStatus":{
@@ -3196,7 +3257,7 @@
},
"ServicePrincipal":{
"shape":"ServicePrincipal",
- "documentation":"<p>The service principal of the AWS service for which you want to make the member account a delegated administrator.</p>"
+ "documentation":"<p>The service principal of the Amazon Web Services service for which you want to make the member account a delegated administrator.</p>"
}
}
},
@@ -3224,7 +3285,7 @@
},
"Arn":{
"shape":"RootArn",
- "documentation":"<p>The Amazon Resource Name (ARN) of the root.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>AWS Service Authorization Reference</i>.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the root.</p> <p>For more information about ARNs in Organizations, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies\">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"
},
"Name":{
"shape":"RootName",
@@ -3235,7 +3296,7 @@
"documentation":"<p>The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.</p> <note> <p>Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using <a>EnablePolicyType</a> and <a>DisablePolicyType</a>. Use <a>DescribeOrganization</a> to see the availability of the policy types in that organization.</p> </note>"
}
},
- "documentation":"<p>Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every AWS account in the organization.</p>"
+ "documentation":"<p>Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every Amazon Web Services account in the organization.</p>"
},
"RootArn":{
"type":"string",
@@ -3268,7 +3329,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>AWS Organizations can't complete your request because of an internal service error. Try again later.</p>",
+ "documentation":"<p>Organizations can't complete your request because of an internal service error. Try again later.</p>",
"exception":true
},
"ServicePrincipal":{
@@ -3301,7 +3362,7 @@
"documentation":"<p>The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.</p>"
}
},
- "documentation":"<p>A custom key-value pair associated with a resource within your organization.</p> <p>You can attach tags to any of the following organization resources.</p> <ul> <li> <p>AWS account</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Organization root</p> </li> <li> <p>Policy</p> </li> </ul>"
+ "documentation":"<p>A custom key-value pair associated with a resource within your organization.</p> <p>You can attach tags to any of the following organization resources.</p> <ul> <li> <p>Amazon Web Services account</p> </li> <li> <p>Organizational unit (OU)</p> </li> <li> <p>Organization root</p> </li> <li> <p>Policy</p> </li> </ul>"
},
"TagKey":{
"type":"string",
@@ -3322,11 +3383,11 @@
"members":{
"ResourceId":{
"shape":"TaggableResourceId",
- "documentation":"<p>The ID of the resource to add a tag to.</p>"
+ "documentation":"<p>The ID of the resource to add a tag to.</p> <p>You can specify any of the following taggable resources.</p> <ul> <li> <p>Amazon Web Services account – specify the account ID number.</p> </li> <li> <p>Organizational unit – specify the OU ID that begins with <code>ou-</code> and looks similar to: <code>ou-<i>1a2b-34uvwxyz</i> </code> </p> </li> <li> <p>Root – specify the root ID that begins with <code>r-</code> and looks similar to: <code>r-<i>1a2b</i> </code> </p> </li> <li> <p>Policy – specify the policy ID that begins with <code>p-</code> andlooks similar to: <code>p-<i>12abcdefg3</i> </code> </p> </li> </ul>"
},
"Tags":{
"shape":"Tags",
- "documentation":"<p>A list of tags to add to the specified resource.</p> <p>You can specify any of the following taggable resources.</p> <ul> <li> <p>AWS account – specify the account ID number.</p> </li> <li> <p>Organizational unit – specify the OU ID that begins with <code>ou-</code> and looks similar to: <code>ou-<i>1a2b-34uvwxyz</i> </code> </p> </li> <li> <p>Root – specify the root ID that begins with <code>r-</code> and looks similar to: <code>r-<i>1a2b</i> </code> </p> </li> <li> <p>Policy – specify the policy ID that begins with <code>p-</code> andlooks similar to: <code>p-<i>12abcdefg3</i> </code> </p> </li> </ul> <p>For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to <code>null</code>.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed number of tags for an account user, then the entire request fails and the account is not created.</p> </note>"
+ "documentation":"<p>A list of tags to add to the specified resource.</p> <p>For each tag in the list, you must specify both a tag key and a value. The value can be an empty string, but you can't set it to <code>null</code>.</p> <note> <p>If any one of the tags is invalid or if you exceed the maximum allowed number of tags for a resource, then the entire request fails.</p> </note>"
}
}
},
@@ -3373,7 +3434,7 @@
"Type":{"shape":"ExceptionType"},
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later.</p> <p>For information about quotas that affect AWS Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html\">Quotas for AWS Organizations</a>in the <i>AWS Organizations User Guide.</i> </p>",
+ "documentation":"<p>You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later.</p> <p>For information about quotas that affect Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html\">Quotas for Organizations</a>in the <i>Organizations User Guide.</i> </p>",
"exception":true
},
"UnsupportedAPIEndpointException":{
@@ -3381,7 +3442,7 @@
"members":{
"Message":{"shape":"ExceptionMessage"}
},
- "documentation":"<p>This action isn't available in the current AWS Region.</p>",
+ "documentation":"<p>This action isn't available in the current Amazon Web Services Region.</p>",
"exception":true
},
"UntagResourceRequest":{
@@ -3393,7 +3454,7 @@
"members":{
"ResourceId":{
"shape":"TaggableResourceId",
- "documentation":"<p>The ID of the resource to remove a tag from.</p> <p>You can specify any of the following taggable resources.</p> <ul> <li> <p>AWS account – specify the account ID number.</p> </li> <li> <p>Organizational unit – specify the OU ID that begins with <code>ou-</code> and looks similar to: <code>ou-<i>1a2b-34uvwxyz</i> </code> </p> </li> <li> <p>Root – specify the root ID that begins with <code>r-</code> and looks similar to: <code>r-<i>1a2b</i> </code> </p> </li> <li> <p>Policy – specify the policy ID that begins with <code>p-</code> andlooks similar to: <code>p-<i>12abcdefg3</i> </code> </p> </li> </ul>"
+ "documentation":"<p>The ID of the resource to remove a tag from.</p> <p>You can specify any of the following taggable resources.</p> <ul> <li> <p>Amazon Web Services account – specify the account ID number.</p> </li> <li> <p>Organizational unit – specify the OU ID that begins with <code>ou-</code> and looks similar to: <code>ou-<i>1a2b-34uvwxyz</i> </code> </p> </li> <li> <p>Root – specify the root ID that begins with <code>r-</code> and looks similar to: <code>r-<i>1a2b</i> </code> </p> </li> <li> <p>Policy – specify the policy ID that begins with <code>p-</code> andlooks similar to: <code>p-<i>12abcdefg3</i> </code> </p> </li> </ul>"
},
"TagKeys":{
"shape":"TagKeys",
@@ -3442,7 +3503,7 @@
},
"Content":{
"shape":"PolicyContent",
- "documentation":"<p>If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html\">Service Control Policy Syntax</a> in the <i>AWS Organizations User Guide.</i> </p>"
+ "documentation":"<p>If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html\">Service Control Policy Syntax</a> in the <i>Organizations User Guide.</i> </p>"
}
}
},
@@ -3456,5 +3517,5 @@
}
}
},
- "documentation":"<p>AWS Organizations is a web service that enables you to consolidate your multiple AWS accounts into an <i>organization</i> and centrally manage your accounts and their resources.</p> <p>This guide provides descriptions of the Organizations operations. For more information about using this service, see the <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html\">AWS Organizations User Guide</a>.</p> <p> <b>Support and feedback for AWS Organizations</b> </p> <p>We welcome your feedback. Send your comments to <a href=\"mailto:feedback-awsorganizations@amazon.com\">feedback-awsorganizations@amazon.com</a> or post your feedback and questions in the <a href=\"http://forums.aws.amazon.com/forum.jspa?forumID=219\">AWS Organizations support forum</a>. For more information about the AWS support forums, see <a href=\"http://forums.aws.amazon.com/help.jspa\">Forums Help</a>.</p> <p> <b>Endpoint to call When using the AWS CLI or the AWS SDK</b> </p> <p>For the current release of Organizations, specify the <code>us-east-1</code> region for all AWS API and AWS CLI calls made from the commercial AWS Regions outside of China. If calling from one of the AWS Regions in China, then specify <code>cn-northwest-1</code>. You can do this in the AWS CLI by using these parameters and commands:</p> <ul> <li> <p>Use the following parameter with each command to specify both the endpoint and its region:</p> <p> <code>--endpoint-url https://organizations.us-east-1.amazonaws.com</code> <i>(from commercial AWS Regions outside of China)</i> </p> <p>or</p> <p> <code>--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn</code> <i>(from AWS Regions in China)</i> </p> </li> <li> <p>Use the default endpoint, but configure your default region with this command:</p> <p> <code>aws configure set default.region us-east-1</code> <i>(from commercial AWS Regions outside of China)</i> </p> <p>or</p> <p> <code>aws configure set default.region cn-northwest-1</code> <i>(from AWS Regions in China)</i> </p> </li> <li> <p>Use the following parameter with each command to specify the endpoint:</p> <p> <code>--region us-east-1</code> <i>(from commercial AWS Regions outside of China)</i> </p> <p>or</p> <p> <code>--region cn-northwest-1</code> <i>(from AWS Regions in China)</i> </p> </li> </ul> <p> <b>Recording API Requests</b> </p> <p>AWS Organizations supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by AWS CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about AWS Organizations and its support for AWS CloudTrail, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration\">Logging AWS Organizations Events with AWS CloudTrail</a> in the <i>AWS Organizations User Guide</i>. To learn more about AWS CloudTrail, including how to turn it on and find your log files, see the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html\">AWS CloudTrail User Guide</a>.</p>"
+ "documentation":"<p>Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an <i>organization</i> and centrally manage your accounts and their resources.</p> <p>This guide provides descriptions of the Organizations operations. For more information about using this service, see the <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html\">Organizations User Guide</a>.</p> <p> <b>Support and feedback for Organizations</b> </p> <p>We welcome your feedback. Send your comments to <a href=\"mailto:feedback-awsorganizations@amazon.com\">feedback-awsorganizations@amazon.com</a> or post your feedback and questions in the <a href=\"http://forums.aws.amazon.com/forum.jspa?forumID=219\">Organizations support forum</a>. For more information about the Amazon Web Services support forums, see <a href=\"http://forums.aws.amazon.com/help.jspa\">Forums Help</a>.</p> <p> <b>Endpoint to call When using the CLI or the Amazon Web Services SDK</b> </p> <p>For the current release of Organizations, specify the <code>us-east-1</code> region for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of China. If calling from one of the Amazon Web Services Regions in China, then specify <code>cn-northwest-1</code>. You can do this in the CLI by using these parameters and commands:</p> <ul> <li> <p>Use the following parameter with each command to specify both the endpoint and its region:</p> <p> <code>--endpoint-url https://organizations.us-east-1.amazonaws.com</code> <i>(from commercial Amazon Web Services Regions outside of China)</i> </p> <p>or</p> <p> <code>--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn</code> <i>(from Amazon Web Services Regions in China)</i> </p> </li> <li> <p>Use the default endpoint, but configure your default region with this command:</p> <p> <code>aws configure set default.region us-east-1</code> <i>(from commercial Amazon Web Services Regions outside of China)</i> </p> <p>or</p> <p> <code>aws configure set default.region cn-northwest-1</code> <i>(from Amazon Web Services Regions in China)</i> </p> </li> <li> <p>Use the following parameter with each command to specify the endpoint:</p> <p> <code>--region us-east-1</code> <i>(from commercial Amazon Web Services Regions outside of China)</i> </p> <p>or</p> <p> <code>--region cn-northwest-1</code> <i>(from Amazon Web Services Regions in China)</i> </p> </li> </ul> <p> <b>Recording API Requests</b> </p> <p>Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about Organizations and its support for CloudTrail, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration\">Logging Organizations Events with CloudTrail</a> in the <i>Organizations User Guide</i>. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html\">CloudTrail User Guide</a>.</p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/outposts/2019-12-03/service-2.json b/contrib/python/botocore/py3/botocore/data/outposts/2019-12-03/service-2.json
index dc36eeb451..3296ab333b 100644
--- a/contrib/python/botocore/py3/botocore/data/outposts/2019-12-03/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/outposts/2019-12-03/service-2.json
@@ -270,7 +270,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"}
],
- "documentation":"<p>Lists the sites for your Amazon Web Services account.</p>"
+ "documentation":"<p>Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address. </p> <p>If you specify multiple filters, the filters are joined with an <code>AND</code>, and the request returns only results that match all of the specified filters.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@@ -603,6 +603,10 @@
"min":1,
"pattern":"^\\S[\\S ]*$"
},
+ "CityList":{
+ "type":"list",
+ "member":{"shape":"City"}
+ },
"ConflictException":{
"type":"structure",
"members":{
@@ -638,6 +642,10 @@
"min":2,
"pattern":"^[A-Z]{2}$"
},
+ "CountryCodeList":{
+ "type":"list",
+ "member":{"shape":"CountryCode"}
+ },
"CreateOrderInput":{
"type":"structure",
"required":[
@@ -1205,6 +1213,24 @@
"shape":"MaxResults1000",
"location":"querystring",
"locationName":"MaxResults"
+ },
+ "OperatingAddressCountryCodeFilter":{
+ "shape":"CountryCodeList",
+ "documentation":"<p> A filter for the country code of the Outpost site. </p> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>",
+ "location":"querystring",
+ "locationName":"OperatingAddressCountryCodeFilter"
+ },
+ "OperatingAddressStateOrRegionFilter":{
+ "shape":"StateOrRegionList",
+ "documentation":"<p> A filter for the state/region of the Outpost site. </p> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>",
+ "location":"querystring",
+ "locationName":"OperatingAddressStateOrRegionFilter"
+ },
+ "OperatingAddressCityFilter":{
+ "shape":"CityList",
+ "documentation":"<p> A filter for the city of the Outpost site. </p> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>",
+ "location":"querystring",
+ "locationName":"OperatingAddressCityFilter"
}
}
},
@@ -1649,6 +1675,10 @@
"min":1,
"pattern":"^\\S[\\S ]*$"
},
+ "StateOrRegionList":{
+ "type":"list",
+ "member":{"shape":"StateOrRegion"}
+ },
"String":{
"type":"string",
"max":1000,
diff --git a/contrib/python/botocore/py3/botocore/data/panorama/2019-07-24/service-2.json b/contrib/python/botocore/py3/botocore/data/panorama/2019-07-24/service-2.json
index 4b8fdf72ef..dcc79c536a 100644
--- a/contrib/python/botocore/py3/botocore/data/panorama/2019-07-24/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/panorama/2019-07-24/service-2.json
@@ -17,15 +17,16 @@
"name":"CreateApplicationInstance",
"http":{
"method":"POST",
- "requestUri":"/application-instances"
+ "requestUri":"/application-instances",
+ "responseCode":200
},
"input":{"shape":"CreateApplicationInstanceRequest"},
"output":{"shape":"CreateApplicationInstanceResponse"},
"errors":[
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ServiceQuotaExceededException"}
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Creates an application instance and deploys it to a device.</p>"
},
@@ -33,16 +34,17 @@
"name":"CreateJobForDevices",
"http":{
"method":"POST",
- "requestUri":"/jobs"
+ "requestUri":"/jobs",
+ "responseCode":200
},
"input":{"shape":"CreateJobForDevicesRequest"},
"output":{"shape":"CreateJobForDevicesResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Creates a job to run on one or more devices.</p>"
},
@@ -50,15 +52,16 @@
"name":"CreateNodeFromTemplateJob",
"http":{
"method":"POST",
- "requestUri":"/packages/template-job"
+ "requestUri":"/packages/template-job",
+ "responseCode":200
},
"input":{"shape":"CreateNodeFromTemplateJobRequest"},
"output":{"shape":"CreateNodeFromTemplateJobResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Creates a camera stream node.</p>"
},
@@ -66,15 +69,16 @@
"name":"CreatePackage",
"http":{
"method":"POST",
- "requestUri":"/packages"
+ "requestUri":"/packages",
+ "responseCode":200
},
"input":{"shape":"CreatePackageRequest"},
"output":{"shape":"CreatePackageResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Creates a package and storage location in an Amazon S3 access point.</p>"
},
@@ -82,15 +86,16 @@
"name":"CreatePackageImportJob",
"http":{
"method":"POST",
- "requestUri":"/packages/import-jobs"
+ "requestUri":"/packages/import-jobs",
+ "responseCode":200
},
"input":{"shape":"CreatePackageImportJobRequest"},
"output":{"shape":"CreatePackageImportJobResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Imports a node package.</p>"
},
@@ -98,16 +103,17 @@
"name":"DeleteDevice",
"http":{
"method":"DELETE",
- "requestUri":"/devices/{DeviceId}"
+ "requestUri":"/devices/{DeviceId}",
+ "responseCode":200
},
"input":{"shape":"DeleteDeviceRequest"},
"output":{"shape":"DeleteDeviceResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Deletes a device.</p>"
},
@@ -115,33 +121,35 @@
"name":"DeletePackage",
"http":{
"method":"DELETE",
- "requestUri":"/packages/{PackageId}"
+ "requestUri":"/packages/{PackageId}",
+ "responseCode":200
},
"input":{"shape":"DeletePackageRequest"},
"output":{"shape":"DeletePackageResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
- "documentation":"<p>Deletes a package.</p>"
+ "documentation":"<p>Deletes a package.</p> <note> <p>To delete a package, you need permission to call <code>s3:DeleteObject</code> in addition to permissions for the AWS Panorama API.</p> </note>"
},
"DeregisterPackageVersion":{
"name":"DeregisterPackageVersion",
"http":{
"method":"DELETE",
- "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}"
+ "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}",
+ "responseCode":200
},
"input":{"shape":"DeregisterPackageVersionRequest"},
"output":{"shape":"DeregisterPackageVersionResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Deregisters a package version.</p>"
},
@@ -149,16 +157,17 @@
"name":"DescribeApplicationInstance",
"http":{
"method":"GET",
- "requestUri":"/application-instances/{applicationInstanceId}"
+ "requestUri":"/application-instances/{ApplicationInstanceId}",
+ "responseCode":200
},
"input":{"shape":"DescribeApplicationInstanceRequest"},
"output":{"shape":"DescribeApplicationInstanceResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about an application instance on a device.</p>"
},
@@ -166,16 +175,17 @@
"name":"DescribeApplicationInstanceDetails",
"http":{
"method":"GET",
- "requestUri":"/application-instances/{applicationInstanceId}/details"
+ "requestUri":"/application-instances/{ApplicationInstanceId}/details",
+ "responseCode":200
},
"input":{"shape":"DescribeApplicationInstanceDetailsRequest"},
"output":{"shape":"DescribeApplicationInstanceDetailsResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about an application instance's configuration manifest.</p>"
},
@@ -183,15 +193,16 @@
"name":"DescribeDevice",
"http":{
"method":"GET",
- "requestUri":"/devices/{DeviceId}"
+ "requestUri":"/devices/{DeviceId}",
+ "responseCode":200
},
"input":{"shape":"DescribeDeviceRequest"},
"output":{"shape":"DescribeDeviceResponse"},
"errors":[
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a device.</p>"
},
@@ -199,16 +210,17 @@
"name":"DescribeDeviceJob",
"http":{
"method":"GET",
- "requestUri":"/jobs/{JobId}"
+ "requestUri":"/jobs/{JobId}",
+ "responseCode":200
},
"input":{"shape":"DescribeDeviceJobRequest"},
"output":{"shape":"DescribeDeviceJobResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a device job.</p>"
},
@@ -216,16 +228,17 @@
"name":"DescribeNode",
"http":{
"method":"GET",
- "requestUri":"/nodes/{NodeId}"
+ "requestUri":"/nodes/{NodeId}",
+ "responseCode":200
},
"input":{"shape":"DescribeNodeRequest"},
"output":{"shape":"DescribeNodeResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a node.</p>"
},
@@ -233,15 +246,16 @@
"name":"DescribeNodeFromTemplateJob",
"http":{
"method":"GET",
- "requestUri":"/packages/template-job/{JobId}"
+ "requestUri":"/packages/template-job/{JobId}",
+ "responseCode":200
},
"input":{"shape":"DescribeNodeFromTemplateJobRequest"},
"output":{"shape":"DescribeNodeFromTemplateJobResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a job to create a camera stream node.</p>"
},
@@ -249,16 +263,17 @@
"name":"DescribePackage",
"http":{
"method":"GET",
- "requestUri":"/packages/metadata/{PackageId}"
+ "requestUri":"/packages/metadata/{PackageId}",
+ "responseCode":200
},
"input":{"shape":"DescribePackageRequest"},
"output":{"shape":"DescribePackageResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a package.</p>"
},
@@ -266,15 +281,16 @@
"name":"DescribePackageImportJob",
"http":{
"method":"GET",
- "requestUri":"/packages/import-jobs/{JobId}"
+ "requestUri":"/packages/import-jobs/{JobId}",
+ "responseCode":200
},
"input":{"shape":"DescribePackageImportJobRequest"},
"output":{"shape":"DescribePackageImportJobResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a package import job.</p>"
},
@@ -282,16 +298,17 @@
"name":"DescribePackageVersion",
"http":{
"method":"GET",
- "requestUri":"/packages/metadata/{PackageId}/versions/{PackageVersion}"
+ "requestUri":"/packages/metadata/{PackageId}/versions/{PackageVersion}",
+ "responseCode":200
},
"input":{"shape":"DescribePackageVersionRequest"},
"output":{"shape":"DescribePackageVersionResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns information about a package version.</p>"
},
@@ -299,7 +316,8 @@
"name":"ListApplicationInstanceDependencies",
"http":{
"method":"GET",
- "requestUri":"/application-instances/{applicationInstanceId}/package-dependencies"
+ "requestUri":"/application-instances/{ApplicationInstanceId}/package-dependencies",
+ "responseCode":200
},
"input":{"shape":"ListApplicationInstanceDependenciesRequest"},
"output":{"shape":"ListApplicationInstanceDependenciesResponse"},
@@ -313,7 +331,8 @@
"name":"ListApplicationInstanceNodeInstances",
"http":{
"method":"GET",
- "requestUri":"/application-instances/{applicationInstanceId}/node-instances"
+ "requestUri":"/application-instances/{ApplicationInstanceId}/node-instances",
+ "responseCode":200
},
"input":{"shape":"ListApplicationInstanceNodeInstancesRequest"},
"output":{"shape":"ListApplicationInstanceNodeInstancesResponse"},
@@ -327,7 +346,8 @@
"name":"ListApplicationInstances",
"http":{
"method":"GET",
- "requestUri":"/application-instances"
+ "requestUri":"/application-instances",
+ "responseCode":200
},
"input":{"shape":"ListApplicationInstancesRequest"},
"output":{"shape":"ListApplicationInstancesResponse"},
@@ -341,15 +361,16 @@
"name":"ListDevices",
"http":{
"method":"GET",
- "requestUri":"/devices"
+ "requestUri":"/devices",
+ "responseCode":200
},
"input":{"shape":"ListDevicesRequest"},
"output":{"shape":"ListDevicesResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
- {"shape":"AccessDeniedException"}
+ {"shape":"AccessDeniedException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list of devices.</p>"
},
@@ -357,16 +378,17 @@
"name":"ListDevicesJobs",
"http":{
"method":"GET",
- "requestUri":"/jobs"
+ "requestUri":"/jobs",
+ "responseCode":200
},
"input":{"shape":"ListDevicesJobsRequest"},
"output":{"shape":"ListDevicesJobsResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list of jobs.</p>"
},
@@ -374,15 +396,16 @@
"name":"ListNodeFromTemplateJobs",
"http":{
"method":"GET",
- "requestUri":"/packages/template-job"
+ "requestUri":"/packages/template-job",
+ "responseCode":200
},
"input":{"shape":"ListNodeFromTemplateJobsRequest"},
"output":{"shape":"ListNodeFromTemplateJobsResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list of camera stream node jobs.</p>"
},
@@ -390,7 +413,8 @@
"name":"ListNodes",
"http":{
"method":"GET",
- "requestUri":"/nodes"
+ "requestUri":"/nodes",
+ "responseCode":200
},
"input":{"shape":"ListNodesRequest"},
"output":{"shape":"ListNodesResponse"},
@@ -405,15 +429,16 @@
"name":"ListPackageImportJobs",
"http":{
"method":"GET",
- "requestUri":"/packages/import-jobs"
+ "requestUri":"/packages/import-jobs",
+ "responseCode":200
},
"input":{"shape":"ListPackageImportJobsRequest"},
"output":{"shape":"ListPackageImportJobsResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list of package import jobs.</p>"
},
@@ -421,16 +446,17 @@
"name":"ListPackages",
"http":{
"method":"GET",
- "requestUri":"/packages"
+ "requestUri":"/packages",
+ "responseCode":200
},
"input":{"shape":"ListPackagesRequest"},
"output":{"shape":"ListPackagesResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list of packages.</p>"
},
@@ -438,13 +464,14 @@
"name":"ListTagsForResource",
"http":{
"method":"GET",
- "requestUri":"/tags/{ResourceArn}"
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":200
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
- {"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
+ {"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list of tags for a resource.</p>"
@@ -453,16 +480,17 @@
"name":"ProvisionDevice",
"http":{
"method":"POST",
- "requestUri":"/devices"
+ "requestUri":"/devices",
+ "responseCode":200
},
"input":{"shape":"ProvisionDeviceRequest"},
"output":{"shape":"ProvisionDeviceResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ServiceQuotaExceededException"}
+ {"shape":"ServiceQuotaExceededException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.</p>"
},
@@ -470,15 +498,16 @@
"name":"RegisterPackageVersion",
"http":{
"method":"PUT",
- "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}"
+ "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}",
+ "responseCode":200
},
"input":{"shape":"RegisterPackageVersionRequest"},
"output":{"shape":"RegisterPackageVersionResponse"},
"errors":[
+ {"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ConflictException"}
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Registers a package version.</p>"
},
@@ -486,16 +515,17 @@
"name":"RemoveApplicationInstance",
"http":{
"method":"DELETE",
- "requestUri":"/application-instances/{applicationInstanceId}"
+ "requestUri":"/application-instances/{ApplicationInstanceId}",
+ "responseCode":200
},
"input":{"shape":"RemoveApplicationInstanceRequest"},
"output":{"shape":"RemoveApplicationInstanceResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Removes an application instance.</p>"
},
@@ -503,13 +533,14 @@
"name":"TagResource",
"http":{
"method":"POST",
- "requestUri":"/tags/{ResourceArn}"
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":200
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
- {"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
+ {"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Tags a resource.</p>"
@@ -518,13 +549,14 @@
"name":"UntagResource",
"http":{
"method":"DELETE",
- "requestUri":"/tags/{ResourceArn}"
+ "requestUri":"/tags/{ResourceArn}",
+ "responseCode":200
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
- {"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
+ {"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Removes tags from a resource.</p>"
@@ -533,16 +565,17 @@
"name":"UpdateDeviceMetadata",
"http":{
"method":"PUT",
- "requestUri":"/devices/{DeviceId}"
+ "requestUri":"/devices/{DeviceId}",
+ "responseCode":200
},
"input":{"shape":"UpdateDeviceMetadataRequest"},
"output":{"shape":"UpdateDeviceMetadataResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
- {"shape":"InternalServerException"},
{"shape":"AccessDeniedException"},
- {"shape":"ResourceNotFoundException"}
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"InternalServerException"}
],
"documentation":"<p>Updates a device's metadata.</p>"
}
@@ -555,20 +588,41 @@
"Message":{"shape":"String"}
},
"documentation":"<p>The requestor does not have permission to access the target action or resource.</p>",
- "error":{"httpStatusCode":403},
+ "error":{
+ "httpStatusCode":403,
+ "senderFault":true
+ },
"exception":true
},
+ "AlternateSoftwareMetadata":{
+ "type":"structure",
+ "members":{
+ "Version":{
+ "shape":"Version",
+ "documentation":"<p>The appliance software version.</p>"
+ }
+ },
+ "documentation":"<p>Details about a beta appliance software update.</p>"
+ },
+ "AlternateSoftwares":{
+ "type":"list",
+ "member":{"shape":"AlternateSoftwareMetadata"}
+ },
"ApplicationInstance":{
"type":"structure",
"members":{
- "Name":{
- "shape":"ApplicationInstanceName",
- "documentation":"<p>The application instance's name.</p>"
- },
"ApplicationInstanceId":{
"shape":"ApplicationInstanceId",
"documentation":"<p>The application instance's ID.</p>"
},
+ "Arn":{
+ "shape":"ApplicationInstanceArn",
+ "documentation":"<p>The application instance's ARN.</p>"
+ },
+ "CreatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the application instance was created.</p>"
+ },
"DefaultRuntimeContextDevice":{
"shape":"DefaultRuntimeContextDevice",
"documentation":"<p>The device's ID.</p>"
@@ -581,26 +635,22 @@
"shape":"Description",
"documentation":"<p>The application instance's description.</p>"
},
- "Status":{
- "shape":"ApplicationInstanceStatus",
- "documentation":"<p>The application instance's status.</p>"
- },
"HealthStatus":{
"shape":"ApplicationInstanceHealthStatus",
"documentation":"<p>The application instance's health status.</p>"
},
+ "Name":{
+ "shape":"ApplicationInstanceName",
+ "documentation":"<p>The application instance's name.</p>"
+ },
+ "Status":{
+ "shape":"ApplicationInstanceStatus",
+ "documentation":"<p>The application instance's status.</p>"
+ },
"StatusDescription":{
"shape":"ApplicationInstanceStatusDescription",
"documentation":"<p>The application instance's status description.</p>"
},
- "CreatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the application instance was created.</p>"
- },
- "Arn":{
- "shape":"ApplicationInstanceArn",
- "documentation":"<p>The application instance's ARN.</p>"
- },
"Tags":{
"shape":"TagMap",
"documentation":"<p>The application instance's tags.</p>"
@@ -680,6 +730,14 @@
"ResourceType"
],
"members":{
+ "ErrorArguments":{
+ "shape":"ConflictExceptionErrorArgumentList",
+ "documentation":"<p>A list of attributes that led to the exception and their values.</p>"
+ },
+ "ErrorId":{
+ "shape":"String",
+ "documentation":"<p>A unique ID for the error.</p>"
+ },
"Message":{"shape":"String"},
"ResourceId":{
"shape":"String",
@@ -688,18 +746,13 @@
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource's type.</p>"
- },
- "ErrorId":{
- "shape":"String",
- "documentation":"<p>A unique ID for the error.</p>"
- },
- "ErrorArguments":{
- "shape":"ConflictExceptionErrorArgumentList",
- "documentation":"<p>A list of attributes that led to the exception and their values.</p>"
}
},
"documentation":"<p>The target resource is in use.</p>",
- "error":{"httpStatusCode":409},
+ "error":{
+ "httpStatusCode":409,
+ "senderFault":true
+ },
"exception":true
},
"ConflictExceptionErrorArgument":{
@@ -734,38 +787,38 @@
"CreateApplicationInstanceRequest":{
"type":"structure",
"required":[
- "ManifestPayload",
- "DefaultRuntimeContextDevice"
+ "DefaultRuntimeContextDevice",
+ "ManifestPayload"
],
"members":{
- "Name":{
- "shape":"ApplicationInstanceName",
- "documentation":"<p>A name for the application instance.</p>"
+ "ApplicationInstanceIdToReplace":{
+ "shape":"ApplicationInstanceId",
+ "documentation":"<p>The ID of an application instance to replace with the new instance.</p>"
+ },
+ "DefaultRuntimeContextDevice":{
+ "shape":"DefaultRuntimeContextDevice",
+ "documentation":"<p>A device's ID.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description for the application instance.</p>"
},
- "ManifestPayload":{
- "shape":"ManifestPayload",
- "documentation":"<p>The application's manifest document.</p>"
- },
"ManifestOverridesPayload":{
"shape":"ManifestOverridesPayload",
"documentation":"<p>Setting overrides for the application manifest.</p>"
},
- "ApplicationInstanceIdToReplace":{
- "shape":"ApplicationInstanceId",
- "documentation":"<p>The ID of an application instance to replace with the new instance.</p>"
+ "ManifestPayload":{
+ "shape":"ManifestPayload",
+ "documentation":"<p>The application's manifest document.</p>"
+ },
+ "Name":{
+ "shape":"ApplicationInstanceName",
+ "documentation":"<p>A name for the application instance.</p>"
},
"RuntimeRoleArn":{
"shape":"RuntimeRoleArn",
"documentation":"<p>The ARN of a runtime role for the application instance.</p>"
},
- "DefaultRuntimeContextDevice":{
- "shape":"DefaultRuntimeContextDevice",
- "documentation":"<p>A device's ID.</p>"
- },
"Tags":{
"shape":"TagMap",
"documentation":"<p>Tags for the application instance.</p>"
@@ -817,16 +870,24 @@
"CreateNodeFromTemplateJobRequest":{
"type":"structure",
"required":[
- "TemplateType",
+ "NodeName",
"OutputPackageName",
"OutputPackageVersion",
- "NodeName",
- "TemplateParameters"
+ "TemplateParameters",
+ "TemplateType"
],
"members":{
- "TemplateType":{
- "shape":"TemplateType",
- "documentation":"<p>The type of node.</p>"
+ "JobTags":{
+ "shape":"JobTagsList",
+ "documentation":"<p>Tags for the job.</p>"
+ },
+ "NodeDescription":{
+ "shape":"Description",
+ "documentation":"<p>A description for the node.</p>"
+ },
+ "NodeName":{
+ "shape":"NodeName",
+ "documentation":"<p>A name for the node.</p>"
},
"OutputPackageName":{
"shape":"NodePackageName",
@@ -836,21 +897,13 @@
"shape":"NodePackageVersion",
"documentation":"<p>An output package version for the node.</p>"
},
- "NodeName":{
- "shape":"NodeName",
- "documentation":"<p>A name for the node.</p>"
- },
- "NodeDescription":{
- "shape":"Description",
- "documentation":"<p>A description for the node.</p>"
- },
"TemplateParameters":{
"shape":"TemplateParametersMap",
"documentation":"<p>Template parameters for the node.</p>"
},
- "JobTags":{
- "shape":"JobTagsList",
- "documentation":"<p>Tags for the job.</p>"
+ "TemplateType":{
+ "shape":"TemplateType",
+ "documentation":"<p>The type of node.</p>"
}
}
},
@@ -867,31 +920,31 @@
"CreatePackageImportJobRequest":{
"type":"structure",
"required":[
- "JobType",
+ "ClientToken",
"InputConfig",
- "OutputConfig",
- "ClientToken"
+ "JobType",
+ "OutputConfig"
],
"members":{
- "JobType":{
- "shape":"PackageImportJobType",
- "documentation":"<p>A job type for the package import job.</p>"
+ "ClientToken":{
+ "shape":"ClientToken",
+ "documentation":"<p>A client token for the package import job.</p>"
},
"InputConfig":{
"shape":"PackageImportJobInputConfig",
"documentation":"<p>An input config for the package import job.</p>"
},
- "OutputConfig":{
- "shape":"PackageImportJobOutputConfig",
- "documentation":"<p>An output config for the package import job.</p>"
- },
- "ClientToken":{
- "shape":"ClientToken",
- "documentation":"<p>A client token for the package import job.</p>"
- },
"JobTags":{
"shape":"JobTagsList",
"documentation":"<p>Tags for the package import job.</p>"
+ },
+ "JobType":{
+ "shape":"PackageImportJobType",
+ "documentation":"<p>A job type for the package import job.</p>"
+ },
+ "OutputConfig":{
+ "shape":"PackageImportJobOutputConfig",
+ "documentation":"<p>An output config for the package import job.</p>"
}
}
},
@@ -923,14 +976,14 @@
"type":"structure",
"required":["StorageLocation"],
"members":{
- "PackageId":{
- "shape":"NodePackageId",
- "documentation":"<p>The package's ID.</p>"
- },
"Arn":{
"shape":"NodePackageArn",
"documentation":"<p>The package's ARN.</p>"
},
+ "PackageId":{
+ "shape":"NodePackageId",
+ "documentation":"<p>The package's ID.</p>"
+ },
"StorageLocation":{
"shape":"StorageLocation",
"documentation":"<p>The package's storage location.</p>"
@@ -980,17 +1033,17 @@
"type":"structure",
"required":["PackageId"],
"members":{
- "PackageId":{
- "shape":"NodePackageId",
- "documentation":"<p>The package's ID.</p>",
- "location":"uri",
- "locationName":"PackageId"
- },
"ForceDelete":{
"shape":"Boolean",
"documentation":"<p>Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.</p>",
"location":"querystring",
"locationName":"ForceDelete"
+ },
+ "PackageId":{
+ "shape":"NodePackageId",
+ "documentation":"<p>The package's ID.</p>",
+ "location":"uri",
+ "locationName":"PackageId"
}
}
},
@@ -1052,44 +1105,44 @@
"shape":"ApplicationInstanceId",
"documentation":"<p>The application instance's ID.</p>",
"location":"uri",
- "locationName":"applicationInstanceId"
+ "locationName":"ApplicationInstanceId"
}
}
},
"DescribeApplicationInstanceDetailsResponse":{
"type":"structure",
"members":{
- "Name":{
- "shape":"ApplicationInstanceName",
- "documentation":"<p>The application instance's name.</p>"
+ "ApplicationInstanceId":{
+ "shape":"ApplicationInstanceId",
+ "documentation":"<p>The application instance's ID.</p>"
},
- "Description":{
- "shape":"Description",
- "documentation":"<p>The application instance's description.</p>"
+ "ApplicationInstanceIdToReplace":{
+ "shape":"ApplicationInstanceId",
+ "documentation":"<p>The ID of the application instance that this instance replaced.</p>"
+ },
+ "CreatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the application instance was created.</p>"
},
"DefaultRuntimeContextDevice":{
"shape":"DefaultRuntimeContextDevice",
"documentation":"<p>The application instance's default runtime context device.</p>"
},
- "ManifestPayload":{
- "shape":"ManifestPayload",
- "documentation":"<p>The application instance's configuration manifest.</p>"
+ "Description":{
+ "shape":"Description",
+ "documentation":"<p>The application instance's description.</p>"
},
"ManifestOverridesPayload":{
"shape":"ManifestOverridesPayload",
"documentation":"<p>Parameter overrides for the configuration manifest.</p>"
},
- "ApplicationInstanceIdToReplace":{
- "shape":"ApplicationInstanceId",
- "documentation":"<p>The ID of the application instance that this instance replaced.</p>"
- },
- "CreatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the application instance was created.</p>"
+ "ManifestPayload":{
+ "shape":"ManifestPayload",
+ "documentation":"<p>The application instance's configuration manifest.</p>"
},
- "ApplicationInstanceId":{
- "shape":"ApplicationInstanceId",
- "documentation":"<p>The application instance's ID.</p>"
+ "Name":{
+ "shape":"ApplicationInstanceName",
+ "documentation":"<p>The application instance's name.</p>"
}
}
},
@@ -1101,20 +1154,28 @@
"shape":"ApplicationInstanceId",
"documentation":"<p>The application instance's ID.</p>",
"location":"uri",
- "locationName":"applicationInstanceId"
+ "locationName":"ApplicationInstanceId"
}
}
},
"DescribeApplicationInstanceResponse":{
"type":"structure",
"members":{
- "Name":{
- "shape":"ApplicationInstanceName",
- "documentation":"<p>The application instance's name.</p>"
+ "ApplicationInstanceId":{
+ "shape":"ApplicationInstanceId",
+ "documentation":"<p>The application instance's ID.</p>"
},
- "Description":{
- "shape":"Description",
- "documentation":"<p>The application instance's description.</p>"
+ "ApplicationInstanceIdToReplace":{
+ "shape":"ApplicationInstanceId",
+ "documentation":"<p>The ID of the application instance that this instance replaced.</p>"
+ },
+ "Arn":{
+ "shape":"ApplicationInstanceArn",
+ "documentation":"<p>The application instance's ARN.</p>"
+ },
+ "CreatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the application instance was created.</p>"
},
"DefaultRuntimeContextDevice":{
"shape":"DefaultRuntimeContextDevice",
@@ -1124,9 +1185,21 @@
"shape":"DeviceName",
"documentation":"<p>The device's bane.</p>"
},
- "ApplicationInstanceIdToReplace":{
- "shape":"ApplicationInstanceId",
- "documentation":"<p>The ID of the application instance that this instance replaced.</p>"
+ "Description":{
+ "shape":"Description",
+ "documentation":"<p>The application instance's description.</p>"
+ },
+ "HealthStatus":{
+ "shape":"ApplicationInstanceHealthStatus",
+ "documentation":"<p>The application instance's health status.</p>"
+ },
+ "LastUpdatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>The application instance was updated.</p>"
+ },
+ "Name":{
+ "shape":"ApplicationInstanceName",
+ "documentation":"<p>The application instance's name.</p>"
},
"RuntimeRoleArn":{
"shape":"RuntimeRoleArn",
@@ -1136,30 +1209,10 @@
"shape":"ApplicationInstanceStatus",
"documentation":"<p>The application instance's status.</p>"
},
- "HealthStatus":{
- "shape":"ApplicationInstanceHealthStatus",
- "documentation":"<p>The application instance's health status.</p>"
- },
"StatusDescription":{
"shape":"ApplicationInstanceStatusDescription",
"documentation":"<p>The application instance's status description.</p>"
},
- "CreatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the application instance was created.</p>"
- },
- "LastUpdatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>The application instance was updated.</p>"
- },
- "ApplicationInstanceId":{
- "shape":"ApplicationInstanceId",
- "documentation":"<p>The application instance's ID.</p>"
- },
- "Arn":{
- "shape":"ApplicationInstanceArn",
- "documentation":"<p>The application instance's ARN.</p>"
- },
"Tags":{
"shape":"TagMap",
"documentation":"<p>The application instance's tags.</p>"
@@ -1181,18 +1234,18 @@
"DescribeDeviceJobResponse":{
"type":"structure",
"members":{
- "JobId":{
- "shape":"JobId",
- "documentation":"<p>The job's ID.</p>"
- },
- "DeviceId":{
- "shape":"DeviceId",
- "documentation":"<p>The device's ID.</p>"
+ "CreatedTime":{
+ "shape":"UpdateCreatedTime",
+ "documentation":"<p>When the job was created.</p>"
},
"DeviceArn":{
"shape":"DeviceArn",
"documentation":"<p>The device's ARN.</p>"
},
+ "DeviceId":{
+ "shape":"DeviceId",
+ "documentation":"<p>The device's ID.</p>"
+ },
"DeviceName":{
"shape":"DeviceName",
"documentation":"<p>The device's name.</p>"
@@ -1205,13 +1258,13 @@
"shape":"ImageVersion",
"documentation":"<p>For an OTA job, the target version of the device software.</p>"
},
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The job's ID.</p>"
+ },
"Status":{
"shape":"UpdateProgress",
"documentation":"<p>The job's status.</p>"
- },
- "CreatedTime":{
- "shape":"UpdateCreatedTime",
- "documentation":"<p>When the job was created.</p>"
}
}
},
@@ -1230,45 +1283,61 @@
"DescribeDeviceResponse":{
"type":"structure",
"members":{
- "DeviceId":{
- "shape":"DeviceId",
- "documentation":"<p>The device's ID.</p>"
- },
- "Name":{
- "shape":"DeviceName",
- "documentation":"<p>The device's name.</p>"
+ "AlternateSoftwares":{
+ "shape":"AlternateSoftwares",
+ "documentation":"<p>Beta software releases available for the device.</p>"
},
"Arn":{
"shape":"DeviceArn",
"documentation":"<p>The device's ARN.</p>"
},
+ "CreatedTime":{
+ "shape":"CreatedTime",
+ "documentation":"<p>When the device was created.</p>"
+ },
+ "CurrentNetworkingStatus":{
+ "shape":"NetworkStatus",
+ "documentation":"<p>The device's networking status.</p>"
+ },
+ "CurrentSoftware":{
+ "shape":"CurrentSoftware",
+ "documentation":"<p>The device's current software version.</p>"
+ },
"Description":{
"shape":"Description",
"documentation":"<p>The device's description.</p>"
},
- "Type":{
- "shape":"DeviceType",
- "documentation":"<p>The device's type.</p>"
- },
"DeviceConnectionStatus":{
"shape":"DeviceConnectionStatus",
"documentation":"<p>The device's connection status.</p>"
},
- "CreatedTime":{
- "shape":"CreatedTime",
- "documentation":"<p>When the device was created.</p>"
+ "DeviceId":{
+ "shape":"DeviceId",
+ "documentation":"<p>The device's ID.</p>"
},
- "ProvisioningStatus":{
- "shape":"DeviceStatus",
- "documentation":"<p>The device's provisioning status.</p>"
+ "LatestAlternateSoftware":{
+ "shape":"LatestAlternateSoftware",
+ "documentation":"<p>The most recent beta software release.</p>"
},
"LatestSoftware":{
"shape":"LatestSoftware",
"documentation":"<p>The latest software version available for the device.</p>"
},
- "CurrentSoftware":{
- "shape":"CurrentSoftware",
- "documentation":"<p>The device's current software version.</p>"
+ "LeaseExpirationTime":{
+ "shape":"LeaseExpirationTime",
+ "documentation":"<p>The device's lease expiration time.</p>"
+ },
+ "Name":{
+ "shape":"DeviceName",
+ "documentation":"<p>The device's name.</p>"
+ },
+ "NetworkingConfiguration":{
+ "shape":"NetworkPayload",
+ "documentation":"<p>The device's networking configuration.</p>"
+ },
+ "ProvisioningStatus":{
+ "shape":"DeviceStatus",
+ "documentation":"<p>The device's provisioning status.</p>"
},
"SerialNumber":{
"shape":"DeviceSerialNumber",
@@ -1278,17 +1347,9 @@
"shape":"TagMap",
"documentation":"<p>The device's tags.</p>"
},
- "NetworkingConfiguration":{
- "shape":"NetworkPayload",
- "documentation":"<p>The device's networking configuration.</p>"
- },
- "CurrentNetworkingStatus":{
- "shape":"NetworkStatus",
- "documentation":"<p>The device's networking status.</p>"
- },
- "LeaseExpirationTime":{
- "shape":"LeaseExpirationTime",
- "documentation":"<p>The device's lease expiration time.</p>"
+ "Type":{
+ "shape":"DeviceType",
+ "documentation":"<p>The device's type.</p>"
}
}
},
@@ -1307,38 +1368,42 @@
"DescribeNodeFromTemplateJobResponse":{
"type":"structure",
"required":[
- "JobId",
- "Status",
- "StatusMessage",
"CreatedTime",
+ "JobId",
"LastUpdatedTime",
+ "NodeName",
"OutputPackageName",
"OutputPackageVersion",
- "NodeName",
- "TemplateType",
- "TemplateParameters"
+ "Status",
+ "StatusMessage",
+ "TemplateParameters",
+ "TemplateType"
],
"members":{
+ "CreatedTime":{
+ "shape":"CreatedTime",
+ "documentation":"<p>When the job was created.</p>"
+ },
"JobId":{
"shape":"JobId",
"documentation":"<p>The job's ID.</p>"
},
- "Status":{
- "shape":"NodeFromTemplateJobStatus",
- "documentation":"<p>The job's status.</p>"
- },
- "StatusMessage":{
- "shape":"NodeFromTemplateJobStatusMessage",
- "documentation":"<p>The job's status message.</p>"
- },
- "CreatedTime":{
- "shape":"CreatedTime",
- "documentation":"<p>When the job was created.</p>"
+ "JobTags":{
+ "shape":"JobTagsList",
+ "documentation":"<p>The job's tags.</p>"
},
"LastUpdatedTime":{
"shape":"LastUpdatedTime",
"documentation":"<p>When the job was updated.</p>"
},
+ "NodeDescription":{
+ "shape":"Description",
+ "documentation":"<p>The node's description.</p>"
+ },
+ "NodeName":{
+ "shape":"NodeName",
+ "documentation":"<p>The node's name.</p>"
+ },
"OutputPackageName":{
"shape":"NodePackageName",
"documentation":"<p>The job's output package name.</p>"
@@ -1347,25 +1412,21 @@
"shape":"NodePackageVersion",
"documentation":"<p>The job's output package version.</p>"
},
- "NodeName":{
- "shape":"NodeName",
- "documentation":"<p>The node's name.</p>"
- },
- "NodeDescription":{
- "shape":"Description",
- "documentation":"<p>The node's description.</p>"
+ "Status":{
+ "shape":"NodeFromTemplateJobStatus",
+ "documentation":"<p>The job's status.</p>"
},
- "TemplateType":{
- "shape":"TemplateType",
- "documentation":"<p>The job's template type.</p>"
+ "StatusMessage":{
+ "shape":"NodeFromTemplateJobStatusMessage",
+ "documentation":"<p>The job's status message.</p>"
},
"TemplateParameters":{
"shape":"TemplateParametersMap",
"documentation":"<p>The job's template parameters.</p>"
},
- "JobTags":{
- "shape":"JobTagsList",
- "documentation":"<p>The job's tags.</p>"
+ "TemplateType":{
+ "shape":"TemplateType",
+ "documentation":"<p>The job's template type.</p>"
}
}
},
@@ -1390,47 +1451,67 @@
"DescribeNodeResponse":{
"type":"structure",
"required":[
- "NodeId",
- "Name",
"Category",
+ "CreatedTime",
+ "Description",
+ "LastUpdatedTime",
+ "Name",
+ "NodeId",
+ "NodeInterface",
"OwnerAccount",
- "PackageName",
"PackageId",
+ "PackageName",
"PackageVersion",
- "PatchVersion",
- "NodeInterface",
- "Description",
- "CreatedTime",
- "LastUpdatedTime"
+ "PatchVersion"
],
"members":{
- "NodeId":{
- "shape":"NodeId",
- "documentation":"<p>The node's ID.</p>"
+ "AssetName":{
+ "shape":"NodeAssetName",
+ "documentation":"<p>The node's asset name.</p>"
+ },
+ "Category":{
+ "shape":"NodeCategory",
+ "documentation":"<p>The node's category.</p>"
+ },
+ "CreatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the node was created.</p>"
+ },
+ "Description":{
+ "shape":"Description",
+ "documentation":"<p>The node's description.</p>"
+ },
+ "LastUpdatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the node was updated.</p>"
},
"Name":{
"shape":"NodeName",
"documentation":"<p>The node's name.</p>"
},
- "Category":{
- "shape":"NodeCategory",
- "documentation":"<p>The node's category.</p>"
+ "NodeId":{
+ "shape":"NodeId",
+ "documentation":"<p>The node's ID.</p>"
+ },
+ "NodeInterface":{
+ "shape":"NodeInterface",
+ "documentation":"<p>The node's interface.</p>"
},
"OwnerAccount":{
"shape":"PackageOwnerAccount",
"documentation":"<p>The account ID of the node's owner.</p>"
},
- "PackageName":{
- "shape":"NodePackageName",
- "documentation":"<p>The node's package name.</p>"
+ "PackageArn":{
+ "shape":"NodePackageArn",
+ "documentation":"<p>The node's ARN.</p>"
},
"PackageId":{
"shape":"NodePackageId",
"documentation":"<p>The node's package ID.</p>"
},
- "PackageArn":{
- "shape":"NodePackageArn",
- "documentation":"<p>The node's ARN.</p>"
+ "PackageName":{
+ "shape":"NodePackageName",
+ "documentation":"<p>The node's package name.</p>"
},
"PackageVersion":{
"shape":"NodePackageVersion",
@@ -1439,26 +1520,6 @@
"PatchVersion":{
"shape":"NodePackagePatchVersion",
"documentation":"<p>The node's patch version.</p>"
- },
- "NodeInterface":{
- "shape":"NodeInterface",
- "documentation":"<p>The node's interface.</p>"
- },
- "AssetName":{
- "shape":"NodeAssetName",
- "documentation":"<p>The node's asset name.</p>"
- },
- "Description":{
- "shape":"Description",
- "documentation":"<p>The node's description.</p>"
- },
- "CreatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the node was created.</p>"
- },
- "LastUpdatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the node was updated.</p>"
}
}
},
@@ -1477,49 +1538,53 @@
"DescribePackageImportJobResponse":{
"type":"structure",
"required":[
+ "CreatedTime",
+ "InputConfig",
"JobId",
"JobType",
- "InputConfig",
- "OutputConfig",
- "Output",
- "CreatedTime",
"LastUpdatedTime",
+ "Output",
+ "OutputConfig",
"Status",
"StatusMessage"
],
"members":{
- "JobId":{
- "shape":"JobId",
- "documentation":"<p>The job's ID.</p>"
- },
"ClientToken":{
"shape":"ClientToken",
"documentation":"<p>The job's client token.</p>"
},
- "JobType":{
- "shape":"PackageImportJobType",
- "documentation":"<p>The job's type.</p>"
+ "CreatedTime":{
+ "shape":"CreatedTime",
+ "documentation":"<p>When the job was created.</p>"
},
"InputConfig":{
"shape":"PackageImportJobInputConfig",
"documentation":"<p>The job's input config.</p>"
},
- "OutputConfig":{
- "shape":"PackageImportJobOutputConfig",
- "documentation":"<p>The job's output config.</p>"
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The job's ID.</p>"
},
- "Output":{
- "shape":"PackageImportJobOutput",
- "documentation":"<p>The job's output.</p>"
+ "JobTags":{
+ "shape":"JobTagsList",
+ "documentation":"<p>The job's tags.</p>"
},
- "CreatedTime":{
- "shape":"CreatedTime",
- "documentation":"<p>When the job was created.</p>"
+ "JobType":{
+ "shape":"PackageImportJobType",
+ "documentation":"<p>The job's type.</p>"
},
"LastUpdatedTime":{
"shape":"LastUpdatedTime",
"documentation":"<p>When the job was updated.</p>"
},
+ "Output":{
+ "shape":"PackageImportJobOutput",
+ "documentation":"<p>The job's output.</p>"
+ },
+ "OutputConfig":{
+ "shape":"PackageImportJobOutputConfig",
+ "documentation":"<p>The job's output config.</p>"
+ },
"Status":{
"shape":"PackageImportJobStatus",
"documentation":"<p>The job's status.</p>"
@@ -1527,10 +1592,6 @@
"StatusMessage":{
"shape":"PackageImportJobStatusMessage",
"documentation":"<p>The job's status message.</p>"
- },
- "JobTags":{
- "shape":"JobTagsList",
- "documentation":"<p>The job's tags.</p>"
}
}
},
@@ -1549,14 +1610,22 @@
"DescribePackageResponse":{
"type":"structure",
"required":[
+ "Arn",
+ "CreatedTime",
"PackageId",
"PackageName",
- "Arn",
"StorageLocation",
- "CreatedTime",
"Tags"
],
"members":{
+ "Arn":{
+ "shape":"NodePackageArn",
+ "documentation":"<p>The package's ARN.</p>"
+ },
+ "CreatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the package was created.</p>"
+ },
"PackageId":{
"shape":"NodePackageId",
"documentation":"<p>The package's ID.</p>"
@@ -1565,29 +1634,21 @@
"shape":"NodePackageName",
"documentation":"<p>The package's name.</p>"
},
- "Arn":{
- "shape":"NodePackageArn",
- "documentation":"<p>The package's ARN.</p>"
+ "ReadAccessPrincipalArns":{
+ "shape":"PrincipalArnsList",
+ "documentation":"<p>ARNs of accounts that have read access to the package.</p>"
},
"StorageLocation":{
"shape":"StorageLocation",
"documentation":"<p>The package's storage location.</p>"
},
- "ReadAccessPrincipalArns":{
- "shape":"PrincipalArnsList",
- "documentation":"<p>ARNs of accounts that have read access to the package.</p>"
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>The package's tags.</p>"
},
"WriteAccessPrincipalArns":{
"shape":"PrincipalArnsList",
"documentation":"<p>ARNs of accounts that have write access to the package.</p>"
- },
- "CreatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the package was created.</p>"
- },
- "Tags":{
- "shape":"TagMap",
- "documentation":"<p>The package's tags.</p>"
}
}
},
@@ -1627,26 +1688,30 @@
"DescribePackageVersionResponse":{
"type":"structure",
"required":[
+ "IsLatestPatch",
"PackageId",
"PackageName",
"PackageVersion",
"PatchVersion",
- "IsLatestPatch",
"Status"
],
"members":{
+ "IsLatestPatch":{
+ "shape":"Boolean",
+ "documentation":"<p>Whether the version is the latest available.</p>"
+ },
"OwnerAccount":{
"shape":"PackageOwnerAccount",
"documentation":"<p>The account ID of the version's owner.</p>"
},
- "PackageId":{
- "shape":"NodePackageId",
- "documentation":"<p>The version's ID.</p>"
- },
"PackageArn":{
"shape":"NodePackageArn",
"documentation":"<p>The ARN of the package.</p>"
},
+ "PackageId":{
+ "shape":"NodePackageId",
+ "documentation":"<p>The version's ID.</p>"
+ },
"PackageName":{
"shape":"NodePackageName",
"documentation":"<p>The version's name.</p>"
@@ -1659,9 +1724,9 @@
"shape":"NodePackagePatchVersion",
"documentation":"<p>The version's patch version.</p>"
},
- "IsLatestPatch":{
- "shape":"Boolean",
- "documentation":"<p>Whether the version is the latest available.</p>"
+ "RegisteredTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>The version's registered time.</p>"
},
"Status":{
"shape":"PackageVersionStatus",
@@ -1670,10 +1735,6 @@
"StatusDescription":{
"shape":"PackageVersionStatusDescription",
"documentation":"<p>The version's status description.</p>"
- },
- "RegisteredTime":{
- "shape":"TimeStamp",
- "documentation":"<p>The version's registered time.</p>"
}
}
},
@@ -1686,21 +1747,13 @@
"Device":{
"type":"structure",
"members":{
- "DeviceId":{
- "shape":"DeviceId",
- "documentation":"<p>The device's ID.</p>"
- },
- "Name":{
- "shape":"DeviceName",
- "documentation":"<p>The device's name.</p>"
- },
"CreatedTime":{
"shape":"CreatedTime",
"documentation":"<p>When the device was created.</p>"
},
- "ProvisioningStatus":{
- "shape":"DeviceStatus",
- "documentation":"<p>The device's provisioning status.</p>"
+ "DeviceId":{
+ "shape":"DeviceId",
+ "documentation":"<p>The device's ID.</p>"
},
"LastUpdatedTime":{
"shape":"LastUpdatedTime",
@@ -1709,6 +1762,14 @@
"LeaseExpirationTime":{
"shape":"LeaseExpirationTime",
"documentation":"<p>The device's lease expiration time.</p>"
+ },
+ "Name":{
+ "shape":"DeviceName",
+ "documentation":"<p>The device's name.</p>"
+ },
+ "ProvisioningStatus":{
+ "shape":"DeviceStatus",
+ "documentation":"<p>The device's provisioning status.</p>"
}
},
"documentation":"<p>A device.</p>"
@@ -1743,21 +1804,21 @@
"DeviceJob":{
"type":"structure",
"members":{
- "DeviceName":{
- "shape":"DeviceName",
- "documentation":"<p>The name of the target device</p>"
+ "CreatedTime":{
+ "shape":"CreatedTime",
+ "documentation":"<p>When the job was created.</p>"
},
"DeviceId":{
"shape":"DeviceId",
"documentation":"<p>The ID of the target device.</p>"
},
+ "DeviceName":{
+ "shape":"DeviceName",
+ "documentation":"<p>The name of the target device</p>"
+ },
"JobId":{
"shape":"JobId",
"documentation":"<p>The job's ID.</p>"
- },
- "CreatedTime":{
- "shape":"CreatedTime",
- "documentation":"<p>When the job was created.</p>"
}
},
"documentation":"<p>A job that runs on a device.</p>"
@@ -1836,10 +1897,6 @@
"EthernetStatus":{
"type":"structure",
"members":{
- "IpAddress":{
- "shape":"IpAddress",
- "documentation":"<p>The device's IP address.</p>"
- },
"ConnectionStatus":{
"shape":"NetworkConnectionStatus",
"documentation":"<p>The device's connection status.</p>"
@@ -1847,6 +1904,10 @@
"HwAddress":{
"shape":"HwAddress",
"documentation":"<p>The device's physical address.</p>"
+ },
+ "IpAddress":{
+ "shape":"IpAddress",
+ "documentation":"<p>The device's IP address.</p>"
}
},
"documentation":"<p>A device's Ethernet status.</p>"
@@ -1894,16 +1955,22 @@
"min":1,
"pattern":"^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$"
},
+ "IpAddressOrServerName":{
+ "type":"string",
+ "max":255,
+ "min":1,
+ "pattern":"(^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,}$)|(^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$)"
+ },
"Job":{
"type":"structure",
"members":{
- "JobId":{
- "shape":"JobId",
- "documentation":"<p>The job's ID.</p>"
- },
"DeviceId":{
"shape":"DeviceId",
"documentation":"<p>The target device's ID.</p>"
+ },
+ "JobId":{
+ "shape":"JobId",
+ "documentation":"<p>The job's ID.</p>"
}
},
"documentation":"<p>A job for a device.</p>"
@@ -1949,6 +2016,11 @@
"enum":["OTA"]
},
"LastUpdatedTime":{"type":"timestamp"},
+ "LatestAlternateSoftware":{
+ "type":"string",
+ "max":255,
+ "min":1
+ },
"LatestSoftware":{
"type":"string",
"max":255,
@@ -1963,7 +2035,7 @@
"shape":"ApplicationInstanceId",
"documentation":"<p>The application instance's ID.</p>",
"location":"uri",
- "locationName":"applicationInstanceId"
+ "locationName":"ApplicationInstanceId"
},
"MaxResults":{
"shape":"MaxSize25",
@@ -1982,13 +2054,13 @@
"ListApplicationInstanceDependenciesResponse":{
"type":"structure",
"members":{
- "PackageObjects":{
- "shape":"PackageObjects",
- "documentation":"<p>A list of package objects.</p>"
- },
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that's included if more results are available.</p>"
+ },
+ "PackageObjects":{
+ "shape":"PackageObjects",
+ "documentation":"<p>A list of package objects.</p>"
}
}
},
@@ -2000,7 +2072,7 @@
"shape":"ApplicationInstanceId",
"documentation":"<p>The node instances' application instance ID.</p>",
"location":"uri",
- "locationName":"applicationInstanceId"
+ "locationName":"ApplicationInstanceId"
},
"MaxResults":{
"shape":"MaxSize25",
@@ -2019,13 +2091,13 @@
"ListApplicationInstanceNodeInstancesResponse":{
"type":"structure",
"members":{
- "NodeInstances":{
- "shape":"NodeInstances",
- "documentation":"<p>A list of node instances.</p>"
- },
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that's included if more results are available.</p>"
+ },
+ "NodeInstances":{
+ "shape":"NodeInstances",
+ "documentation":"<p>A list of node instances.</p>"
}
}
},
@@ -2038,12 +2110,6 @@
"location":"querystring",
"locationName":"deviceId"
},
- "StatusFilter":{
- "shape":"StatusFilter",
- "documentation":"<p>Only include instances with a specific status.</p>",
- "location":"querystring",
- "locationName":"statusFilter"
- },
"MaxResults":{
"shape":"MaxSize25",
"documentation":"<p>The maximum number of application instances to return in one page of results.</p>",
@@ -2055,6 +2121,12 @@
"documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
+ },
+ "StatusFilter":{
+ "shape":"StatusFilter",
+ "documentation":"<p>Only include instances with a specific status.</p>",
+ "location":"querystring",
+ "locationName":"statusFilter"
}
}
},
@@ -2080,17 +2152,17 @@
"location":"querystring",
"locationName":"DeviceId"
},
- "NextToken":{
- "shape":"NextToken",
- "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
- "location":"querystring",
- "locationName":"NextToken"
- },
"MaxResults":{
"shape":"MaxSize25",
"documentation":"<p>The maximum number of device jobs to return in one page of results.</p>",
"location":"querystring",
"locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"NextToken"
}
}
},
@@ -2110,17 +2182,17 @@
"ListDevicesRequest":{
"type":"structure",
"members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
- "location":"querystring",
- "locationName":"NextToken"
- },
"MaxResults":{
"shape":"MaxSize25",
"documentation":"<p>The maximum number of devices to return in one page of results.</p>",
"location":"querystring",
"locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"NextToken"
}
}
},
@@ -2141,17 +2213,17 @@
"ListNodeFromTemplateJobsRequest":{
"type":"structure",
"members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
- "location":"querystring",
- "locationName":"NextToken"
- },
"MaxResults":{
"shape":"MaxSize25",
"documentation":"<p>The maximum number of node from template jobs to return in one page of results.</p>",
"location":"querystring",
"locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"NextToken"
}
}
},
@@ -2159,13 +2231,13 @@
"type":"structure",
"required":["NodeFromTemplateJobs"],
"members":{
- "NodeFromTemplateJobs":{
- "shape":"NodeFromTemplateJobList",
- "documentation":"<p>A list of jobs.</p>"
- },
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that's included if more results are available.</p>"
+ },
+ "NodeFromTemplateJobs":{
+ "shape":"NodeFromTemplateJobList",
+ "documentation":"<p>A list of jobs.</p>"
}
}
},
@@ -2178,6 +2250,18 @@
"location":"querystring",
"locationName":"category"
},
+ "MaxResults":{
+ "shape":"MaxSize25",
+ "documentation":"<p>The maximum number of nodes to return in one page of results.</p>",
+ "location":"querystring",
+ "locationName":"maxResults"
+ },
+ "NextToken":{
+ "shape":"Token",
+ "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"nextToken"
+ },
"OwnerAccount":{
"shape":"PackageOwnerAccount",
"documentation":"<p>Search for nodes by the account ID of the nodes' owner.</p>",
@@ -2201,48 +2285,36 @@
"documentation":"<p>Search for nodes by patch version.</p>",
"location":"querystring",
"locationName":"patchVersion"
- },
- "NextToken":{
- "shape":"Token",
- "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
- "location":"querystring",
- "locationName":"nextToken"
- },
- "MaxResults":{
- "shape":"MaxSize25",
- "documentation":"<p>The maximum number of nodes to return in one page of results.</p>",
- "location":"querystring",
- "locationName":"maxResults"
}
}
},
"ListNodesResponse":{
"type":"structure",
"members":{
- "Nodes":{
- "shape":"NodesList",
- "documentation":"<p>A list of nodes.</p>"
- },
"NextToken":{
"shape":"Token",
"documentation":"<p>A pagination token that's included if more results are available.</p>"
+ },
+ "Nodes":{
+ "shape":"NodesList",
+ "documentation":"<p>A list of nodes.</p>"
}
}
},
"ListPackageImportJobsRequest":{
"type":"structure",
"members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
- "location":"querystring",
- "locationName":"NextToken"
- },
"MaxResults":{
"shape":"MaxSize25",
"documentation":"<p>The maximum number of package import jobs to return in one page of results.</p>",
"location":"querystring",
"locationName":"MaxResults"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"NextToken"
}
}
},
@@ -2250,13 +2322,13 @@
"type":"structure",
"required":["PackageImportJobs"],
"members":{
- "PackageImportJobs":{
- "shape":"PackageImportJobList",
- "documentation":"<p>A list of package import jobs.</p>"
- },
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that's included if more results are available.</p>"
+ },
+ "PackageImportJobs":{
+ "shape":"PackageImportJobList",
+ "documentation":"<p>A list of package import jobs.</p>"
}
}
},
@@ -2280,13 +2352,13 @@
"ListPackagesResponse":{
"type":"structure",
"members":{
- "Packages":{
- "shape":"PackageList",
- "documentation":"<p>A list of packages.</p>"
- },
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token that's included if more results are available.</p>"
+ },
+ "Packages":{
+ "shape":"PackageList",
+ "documentation":"<p>A list of packages.</p>"
}
}
},
@@ -2362,7 +2434,8 @@
"type":"string",
"enum":[
"CONNECTED",
- "NOT_CONNECTED"
+ "NOT_CONNECTED",
+ "CONNECTING"
]
},
"NetworkPayload":{
@@ -2375,6 +2448,10 @@
"Ethernet1":{
"shape":"EthernetPayload",
"documentation":"<p>Settings for Ethernet port 1.</p>"
+ },
+ "Ntp":{
+ "shape":"NtpPayload",
+ "documentation":"<p>Network time protocol (NTP) server settings.</p>"
}
},
"documentation":"<p>The network configuration for a device.</p>"
@@ -2389,6 +2466,14 @@
"Ethernet1Status":{
"shape":"EthernetStatus",
"documentation":"<p>The status of Ethernet port 1.</p>"
+ },
+ "LastUpdatedTime":{
+ "shape":"LastUpdatedTime",
+ "documentation":"<p>When the network status changed.</p>"
+ },
+ "NtpStatus":{
+ "shape":"NtpStatus",
+ "documentation":"<p>Details about a network time protocol (NTP) server connection.</p>"
}
},
"documentation":"<p>The network status of a device.</p>"
@@ -2402,43 +2487,51 @@
"Node":{
"type":"structure",
"required":[
- "NodeId",
- "Name",
"Category",
- "PackageName",
+ "CreatedTime",
+ "Name",
+ "NodeId",
"PackageId",
+ "PackageName",
"PackageVersion",
- "PatchVersion",
- "CreatedTime"
+ "PatchVersion"
],
"members":{
- "NodeId":{
- "shape":"NodeId",
- "documentation":"<p>The node's ID.</p>"
+ "Category":{
+ "shape":"NodeCategory",
+ "documentation":"<p>The node's category.</p>"
+ },
+ "CreatedTime":{
+ "shape":"TimeStamp",
+ "documentation":"<p>When the node was created.</p>"
+ },
+ "Description":{
+ "shape":"Description",
+ "documentation":"<p>The node's description.</p>"
},
"Name":{
"shape":"NodeName",
"documentation":"<p>The node's name.</p>"
},
- "Category":{
- "shape":"NodeCategory",
- "documentation":"<p>The node's category.</p>"
+ "NodeId":{
+ "shape":"NodeId",
+ "documentation":"<p>The node's ID.</p>"
},
"OwnerAccount":{
"shape":"PackageOwnerAccount",
"documentation":"<p>The account ID of the node's owner.</p>"
},
- "PackageName":{
- "shape":"NodePackageName",
- "documentation":"<p>The node's package name.</p>"
+ "PackageArn":{
+ "shape":"NodePackageArn",
+ "documentation":"<p>The node's ARN.</p>"
},
"PackageId":{
"shape":"NodePackageId",
"documentation":"<p>The node's package ID.</p>"
},
- "PackageArn":{
- "shape":"NodePackageArn",
- "documentation":"<p>The node's ARN.</p>"
+ "PackageName":{
+ "shape":"NodePackageName",
+ "documentation":"<p>The node's package name.</p>"
},
"PackageVersion":{
"shape":"NodePackageVersion",
@@ -2447,14 +2540,6 @@
"PatchVersion":{
"shape":"NodePackagePatchVersion",
"documentation":"<p>The node's patch version.</p>"
- },
- "Description":{
- "shape":"Description",
- "documentation":"<p>The node's description.</p>"
- },
- "CreatedTime":{
- "shape":"TimeStamp",
- "documentation":"<p>When the node was created.</p>"
}
},
"documentation":"<p>An application node that represents a camera stream, a model, code, or output.</p>"
@@ -2477,13 +2562,17 @@
"NodeFromTemplateJob":{
"type":"structure",
"members":{
+ "CreatedTime":{
+ "shape":"CreatedTime",
+ "documentation":"<p>When the job was created.</p>"
+ },
"JobId":{
"shape":"JobId",
"documentation":"<p>The job's ID.</p>"
},
- "TemplateType":{
- "shape":"TemplateType",
- "documentation":"<p>The job's template type.</p>"
+ "NodeName":{
+ "shape":"NodeName",
+ "documentation":"<p>The node's name.</p>"
},
"Status":{
"shape":"NodeFromTemplateJobStatus",
@@ -2493,13 +2582,9 @@
"shape":"NodeFromTemplateJobStatusMessage",
"documentation":"<p>The job's status message.</p>"
},
- "CreatedTime":{
- "shape":"CreatedTime",
- "documentation":"<p>When the job was created.</p>"
- },
- "NodeName":{
- "shape":"NodeName",
- "documentation":"<p>The node's name.</p>"
+ "TemplateType":{
+ "shape":"TemplateType",
+ "documentation":"<p>The job's template type.</p>"
}
},
"documentation":"<p>A job to create a camera stream node.</p>"
@@ -2526,25 +2611,25 @@
"NodeInputPort":{
"type":"structure",
"members":{
- "Name":{
- "shape":"PortName",
- "documentation":"<p>The input port's name.</p>"
+ "DefaultValue":{
+ "shape":"PortDefaultValue",
+ "documentation":"<p>The input port's default value.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The input port's description.</p>"
},
- "Type":{
- "shape":"PortType",
- "documentation":"<p>The input port's type.</p>"
- },
- "DefaultValue":{
- "shape":"PortDefaultValue",
- "documentation":"<p>The input port's default value.</p>"
- },
"MaxConnections":{
"shape":"MaxConnections",
"documentation":"<p>The input port's max connections.</p>"
+ },
+ "Name":{
+ "shape":"PortName",
+ "documentation":"<p>The input port's name.</p>"
+ },
+ "Type":{
+ "shape":"PortType",
+ "documentation":"<p>The input port's type.</p>"
}
},
"documentation":"<p>A node input port.</p>"
@@ -2552,37 +2637,37 @@
"NodeInstance":{
"type":"structure",
"required":[
- "NodeInstanceId",
- "CurrentStatus"
+ "CurrentStatus",
+ "NodeInstanceId"
],
"members":{
- "NodeInstanceId":{
- "shape":"NodeInstanceId",
- "documentation":"<p>The instance's ID.</p>"
+ "CurrentStatus":{
+ "shape":"NodeInstanceStatus",
+ "documentation":"<p>The instance's current status.</p>"
},
"NodeId":{
"shape":"NodeId",
"documentation":"<p>The node's ID.</p>"
},
+ "NodeInstanceId":{
+ "shape":"NodeInstanceId",
+ "documentation":"<p>The instance's ID.</p>"
+ },
+ "NodeName":{
+ "shape":"NodeName",
+ "documentation":"<p>The instance's name.</p>"
+ },
"PackageName":{
"shape":"NodePackageName",
"documentation":"<p>The instance's package name.</p>"
},
- "PackageVersion":{
- "shape":"NodePackageVersion",
- "documentation":"<p>The instance's package version.</p>"
- },
"PackagePatchVersion":{
"shape":"NodePackagePatchVersion",
"documentation":"<p>The instance's package patch version.</p>"
},
- "NodeName":{
- "shape":"NodeName",
- "documentation":"<p>The instance's name.</p>"
- },
- "CurrentStatus":{
- "shape":"NodeInstanceStatus",
- "documentation":"<p>The instance's current status.</p>"
+ "PackageVersion":{
+ "shape":"NodePackageVersion",
+ "documentation":"<p>The instance's package version.</p>"
}
},
"documentation":"<p>A node instance.</p>"
@@ -2632,14 +2717,14 @@
"NodeOutputPort":{
"type":"structure",
"members":{
- "Name":{
- "shape":"PortName",
- "documentation":"<p>The output port's name.</p>"
- },
"Description":{
"shape":"Description",
"documentation":"<p>The output port's description.</p>"
},
+ "Name":{
+ "shape":"PortName",
+ "documentation":"<p>The output port's name.</p>"
+ },
"Type":{
"shape":"PortType",
"documentation":"<p>The output port's type.</p>"
@@ -2680,6 +2765,46 @@
"type":"list",
"member":{"shape":"Node"}
},
+ "NtpPayload":{
+ "type":"structure",
+ "required":["NtpServers"],
+ "members":{
+ "NtpServers":{
+ "shape":"NtpServerList",
+ "documentation":"<p>NTP servers to use, in order of preference.</p>"
+ }
+ },
+ "documentation":"<p>Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of <code>pool.ntp.org</code>.</p>"
+ },
+ "NtpServerList":{
+ "type":"list",
+ "member":{"shape":"IpAddressOrServerName"},
+ "max":5,
+ "min":0
+ },
+ "NtpServerName":{
+ "type":"string",
+ "max":255,
+ "min":1
+ },
+ "NtpStatus":{
+ "type":"structure",
+ "members":{
+ "ConnectionStatus":{
+ "shape":"NetworkConnectionStatus",
+ "documentation":"<p>The connection's status.</p>"
+ },
+ "IpAddress":{
+ "shape":"IpAddress",
+ "documentation":"<p>The IP address of the server.</p>"
+ },
+ "NtpServerName":{
+ "shape":"NtpServerName",
+ "documentation":"<p>The domain name of the server.</p>"
+ }
+ },
+ "documentation":"<p>Details about an NTP server connection.</p>"
+ },
"OTAJobConfig":{
"type":"structure",
"required":["ImageVersion"],
@@ -2723,6 +2848,10 @@
"PackageImportJob":{
"type":"structure",
"members":{
+ "CreatedTime":{
+ "shape":"CreatedTime",
+ "documentation":"<p>When the job was created.</p>"
+ },
"JobId":{
"shape":"JobId",
"documentation":"<p>The job's ID.</p>"
@@ -2731,6 +2860,10 @@
"shape":"PackageImportJobType",
"documentation":"<p>The job's type.</p>"
},
+ "LastUpdatedTime":{
+ "shape":"LastUpdatedTime",
+ "documentation":"<p>When the job was updated.</p>"
+ },
"Status":{
"shape":"PackageImportJobStatus",
"documentation":"<p>The job's status.</p>"
@@ -2738,14 +2871,6 @@
"StatusMessage":{
"shape":"PackageImportJobStatusMessage",
"documentation":"<p>The job's status message.</p>"
- },
- "CreatedTime":{
- "shape":"CreatedTime",
- "documentation":"<p>When the job was created.</p>"
- },
- "LastUpdatedTime":{
- "shape":"LastUpdatedTime",
- "documentation":"<p>When the job was updated.</p>"
}
},
"documentation":"<p>A job to import a package version.</p>"
@@ -2767,12 +2892,16 @@
"PackageImportJobOutput":{
"type":"structure",
"required":[
+ "OutputS3Location",
"PackageId",
"PackageVersion",
- "PatchVersion",
- "OutputS3Location"
+ "PatchVersion"
],
"members":{
+ "OutputS3Location":{
+ "shape":"OutPutS3Location",
+ "documentation":"<p>The package's output location.</p>"
+ },
"PackageId":{
"shape":"NodePackageId",
"documentation":"<p>The package's ID.</p>"
@@ -2784,10 +2913,6 @@
"PatchVersion":{
"shape":"NodePackagePatchVersion",
"documentation":"<p>The package's patch version.</p>"
- },
- "OutputS3Location":{
- "shape":"OutPutS3Location",
- "documentation":"<p>The package's output location.</p>"
}
},
"documentation":"<p>Results of a package import job.</p>"
@@ -2813,7 +2938,10 @@
"PackageImportJobStatusMessage":{"type":"string"},
"PackageImportJobType":{
"type":"string",
- "enum":["NODE_PACKAGE_VERSION"]
+ "enum":[
+ "NODE_PACKAGE_VERSION",
+ "MARKETPLACE_NODE_PACKAGE_VERSION"
+ ]
},
"PackageList":{
"type":"list",
@@ -2822,14 +2950,6 @@
"PackageListItem":{
"type":"structure",
"members":{
- "PackageId":{
- "shape":"NodePackageId",
- "documentation":"<p>The package's ID.</p>"
- },
- "PackageName":{
- "shape":"NodePackageName",
- "documentation":"<p>The package's name.</p>"
- },
"Arn":{
"shape":"NodePackageArn",
"documentation":"<p>The package's ARN.</p>"
@@ -2838,6 +2958,14 @@
"shape":"TimeStamp",
"documentation":"<p>When the package was created.</p>"
},
+ "PackageId":{
+ "shape":"NodePackageId",
+ "documentation":"<p>The package's ID.</p>"
+ },
+ "PackageName":{
+ "shape":"NodePackageName",
+ "documentation":"<p>The package's name.</p>"
+ },
"Tags":{
"shape":"TagMap",
"documentation":"<p>The package's tags.</p>"
@@ -2896,6 +3024,10 @@
"PackageVersion"
],
"members":{
+ "MarkLatest":{
+ "shape":"MarkLatestPatch",
+ "documentation":"<p>Indicates that the version is recommended for all users.</p>"
+ },
"PackageName":{
"shape":"NodePackageName",
"documentation":"<p>The output's package name.</p>"
@@ -2903,10 +3035,6 @@
"PackageVersion":{
"shape":"NodePackageVersion",
"documentation":"<p>The output's package version.</p>"
- },
- "MarkLatest":{
- "shape":"MarkLatestPatch",
- "documentation":"<p>Indicates that the version is recommended for all users.</p>"
}
},
"documentation":"<p>A package version output configuration.</p>"
@@ -2960,21 +3088,21 @@
"type":"structure",
"required":["Name"],
"members":{
- "Name":{
- "shape":"DeviceName",
- "documentation":"<p>A name for the device.</p>"
- },
"Description":{
"shape":"Description",
"documentation":"<p>A description for the device.</p>"
},
- "Tags":{
- "shape":"TagMap",
- "documentation":"<p>Tags for the device.</p>"
+ "Name":{
+ "shape":"DeviceName",
+ "documentation":"<p>A name for the device.</p>"
},
"NetworkingConfiguration":{
"shape":"NetworkPayload",
"documentation":"<p>A networking configuration for the device.</p>"
+ },
+ "Tags":{
+ "shape":"TagMap",
+ "documentation":"<p>Tags for the device.</p>"
}
}
},
@@ -2985,25 +3113,25 @@
"Status"
],
"members":{
- "DeviceId":{
- "shape":"DeviceId",
- "documentation":"<p>The device's ID.</p>"
- },
"Arn":{
"shape":"DeviceArn",
"documentation":"<p>The device's ARN.</p>"
},
- "Status":{
- "shape":"DeviceStatus",
- "documentation":"<p>The device's status.</p>"
- },
"Certificates":{
"shape":"Certificates",
"documentation":"<p>The device's configuration bundle.</p>"
},
+ "DeviceId":{
+ "shape":"DeviceId",
+ "documentation":"<p>The device's ID.</p>"
+ },
"IotThingName":{
"shape":"IotThingName",
"documentation":"<p>The device's IoT thing name.</p>"
+ },
+ "Status":{
+ "shape":"DeviceStatus",
+ "documentation":"<p>The device's status.</p>"
}
}
},
@@ -3021,6 +3149,10 @@
"PatchVersion"
],
"members":{
+ "MarkLatest":{
+ "shape":"MarkLatestPatch",
+ "documentation":"<p>Whether to mark the new version as the latest version.</p>"
+ },
"OwnerAccount":{
"shape":"PackageOwnerAccount",
"documentation":"<p>An owner account.</p>"
@@ -3042,10 +3174,6 @@
"documentation":"<p>A patch version.</p>",
"location":"uri",
"locationName":"PatchVersion"
- },
- "MarkLatest":{
- "shape":"MarkLatestPatch",
- "documentation":"<p>Whether to mark the new version as the latest version.</p>"
}
}
},
@@ -3062,7 +3190,7 @@
"shape":"ApplicationInstanceId",
"documentation":"<p>An application instance ID.</p>",
"location":"uri",
- "locationName":"applicationInstanceId"
+ "locationName":"ApplicationInstanceId"
}
}
},
@@ -3096,7 +3224,10 @@
}
},
"documentation":"<p>The target resource was not found.</p>",
- "error":{"httpStatusCode":404},
+ "error":{
+ "httpStatusCode":404,
+ "senderFault":true
+ },
"exception":true
},
"RetryAfterSeconds":{"type":"integer"},
@@ -3113,10 +3244,6 @@
"ObjectKey"
],
"members":{
- "Region":{
- "shape":"Region",
- "documentation":"<p>The bucket's Region.</p>"
- },
"BucketName":{
"shape":"BucketName",
"documentation":"<p>A bucket name.</p>"
@@ -3124,6 +3251,10 @@
"ObjectKey":{
"shape":"ObjectKey",
"documentation":"<p>An object key.</p>"
+ },
+ "Region":{
+ "shape":"Region",
+ "documentation":"<p>The bucket's Region.</p>"
}
},
"documentation":"<p>A location in Amazon S3.</p>"
@@ -3137,6 +3268,10 @@
],
"members":{
"Message":{"shape":"String"},
+ "QuotaCode":{
+ "shape":"String",
+ "documentation":"<p>The name of the limit.</p>"
+ },
"ResourceId":{
"shape":"String",
"documentation":"<p>The target resource's ID.</p>"
@@ -3145,28 +3280,35 @@
"shape":"String",
"documentation":"<p>The target resource's type.</p>"
},
- "QuotaCode":{
- "shape":"String",
- "documentation":"<p>The name of the limit.</p>"
- },
"ServiceCode":{
"shape":"String",
"documentation":"<p>The name of the service.</p>"
}
},
"documentation":"<p>The request would cause a limit to be exceeded.</p>",
- "error":{"httpStatusCode":402},
+ "error":{
+ "httpStatusCode":402,
+ "senderFault":true
+ },
"exception":true
},
"StaticIpConnectionInfo":{
"type":"structure",
"required":[
- "IpAddress",
- "Mask",
+ "DefaultGateway",
"Dns",
- "DefaultGateway"
+ "IpAddress",
+ "Mask"
],
"members":{
+ "DefaultGateway":{
+ "shape":"DefaultGateway",
+ "documentation":"<p>The connection's default gateway.</p>"
+ },
+ "Dns":{
+ "shape":"DnsList",
+ "documentation":"<p>The connection's DNS address.</p>"
+ },
"IpAddress":{
"shape":"IpAddress",
"documentation":"<p>The connection's IP address.</p>"
@@ -3174,14 +3316,6 @@
"Mask":{
"shape":"Mask",
"documentation":"<p>The connection's DNS mask.</p>"
- },
- "Dns":{
- "shape":"DnsList",
- "documentation":"<p>The connection's DNS address.</p>"
- },
- "DefaultGateway":{
- "shape":"DefaultGateway",
- "documentation":"<p>The connection's default gateway.</p>"
}
},
"documentation":"<p>A static IP configuration.</p>"
@@ -3200,32 +3334,32 @@
"StorageLocation":{
"type":"structure",
"required":[
+ "BinaryPrefixLocation",
"Bucket",
- "RepoPrefixLocation",
"GeneratedPrefixLocation",
- "BinaryPrefixLocation",
- "ManifestPrefixLocation"
+ "ManifestPrefixLocation",
+ "RepoPrefixLocation"
],
"members":{
+ "BinaryPrefixLocation":{
+ "shape":"Object",
+ "documentation":"<p>The location's binary prefix.</p>"
+ },
"Bucket":{
"shape":"Bucket",
"documentation":"<p>The location's bucket.</p>"
},
- "RepoPrefixLocation":{
- "shape":"Object",
- "documentation":"<p>The location's repo prefix.</p>"
- },
"GeneratedPrefixLocation":{
"shape":"Object",
"documentation":"<p>The location's generated prefix.</p>"
},
- "BinaryPrefixLocation":{
- "shape":"Object",
- "documentation":"<p>The location's binary prefix.</p>"
- },
"ManifestPrefixLocation":{
"shape":"Object",
"documentation":"<p>The location's manifest prefix.</p>"
+ },
+ "RepoPrefixLocation":{
+ "shape":"Object",
+ "documentation":"<p>The location's repo prefix.</p>"
}
},
"documentation":"<p>A storage location.</p>"
@@ -3340,15 +3474,15 @@
"type":"structure",
"required":["DeviceId"],
"members":{
+ "Description":{
+ "shape":"Description",
+ "documentation":"<p>A description for the device.</p>"
+ },
"DeviceId":{
"shape":"DeviceId",
"documentation":"<p>The device's ID.</p>",
"location":"uri",
"locationName":"DeviceId"
- },
- "Description":{
- "shape":"Description",
- "documentation":"<p>A description for the device.</p>"
}
}
},
@@ -3377,26 +3511,29 @@
"type":"structure",
"required":["Message"],
"members":{
- "Message":{"shape":"String"},
- "Reason":{
- "shape":"ValidationExceptionReason",
- "documentation":"<p>The reason that validation failed.</p>"
+ "ErrorArguments":{
+ "shape":"ValidationExceptionErrorArgumentList",
+ "documentation":"<p>A list of attributes that led to the exception and their values.</p>"
},
"ErrorId":{
"shape":"String",
"documentation":"<p>A unique ID for the error.</p>"
},
- "ErrorArguments":{
- "shape":"ValidationExceptionErrorArgumentList",
- "documentation":"<p>A list of attributes that led to the exception and their values.</p>"
- },
"Fields":{
"shape":"ValidationExceptionFieldList",
"documentation":"<p>A list of request parameters that failed validation.</p>"
+ },
+ "Message":{"shape":"String"},
+ "Reason":{
+ "shape":"ValidationExceptionReason",
+ "documentation":"<p>The reason that validation failed.</p>"
}
},
"documentation":"<p>The request contains an invalid parameter value.</p>",
- "error":{"httpStatusCode":400},
+ "error":{
+ "httpStatusCode":400,
+ "senderFault":true
+ },
"exception":true
},
"ValidationExceptionErrorArgument":{
@@ -3424,17 +3561,17 @@
"ValidationExceptionField":{
"type":"structure",
"required":[
- "Name",
- "Message"
+ "Message",
+ "Name"
],
"members":{
- "Name":{
- "shape":"String",
- "documentation":"<p>The field's name.</p>"
- },
"Message":{
"shape":"String",
"documentation":"<p>The field's message.</p>"
+ },
+ "Name":{
+ "shape":"String",
+ "documentation":"<p>The field's name.</p>"
}
},
"documentation":"<p>A validation exception field.</p>"
@@ -3451,7 +3588,12 @@
"FIELD_VALIDATION_FAILED",
"OTHER"
]
+ },
+ "Version":{
+ "type":"string",
+ "max":255,
+ "min":1
}
},
- "documentation":"<fullname>AWS Panorama</fullname> <p> <b>Overview</b> </p> <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href=\"https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html\">What is AWS Panorama?</a> in the <i>AWS Panorama Developer Guide</i>.</p>"
+ "documentation":"<p><fullname>AWS Panorama</fullname> <p> <b>Overview</b> </p> <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href=\"https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html\">What is AWS Panorama?</a> in the <i>AWS Panorama Developer Guide</i>.</p></p>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json b/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json
index 5f205d75cd..b6e180aa1b 100644
--- a/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json
@@ -416,7 +416,8 @@
"sv-SE",
"tr-TR",
"en-NZ",
- "en-ZA"
+ "en-ZA",
+ "ca-ES"
]
},
"LanguageCodeList":{
@@ -910,7 +911,7 @@
},
"ContentType":{
"shape":"ContentType",
- "documentation":"<p> Specifies the type audio stream. This should reflect the <code>OutputFormat</code> parameter in your request. </p> <ul> <li> <p> If you request <code>mp3</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/mpeg. </p> </li> <li> <p> If you request <code>ogg_vorbis</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/ogg. </p> </li> <li> <p> If you request <code>pcm</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. </p> </li> <li> <p>If you request <code>json</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/json.</p> </li> </ul> <p> </p>",
+ "documentation":"<p> Specifies the type audio stream. This should reflect the <code>OutputFormat</code> parameter in your request. </p> <ul> <li> <p> If you request <code>mp3</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/mpeg. </p> </li> <li> <p> If you request <code>ogg_vorbis</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/ogg. </p> </li> <li> <p> If you request <code>pcm</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format. </p> </li> <li> <p>If you request <code>json</code> as the <code>OutputFormat</code>, the <code>ContentType</code> returned is application/x-json-stream.</p> </li> </ul> <p> </p>",
"location":"header",
"locationName":"Content-Type"
},
@@ -1073,7 +1074,8 @@
"Zeina",
"Zhiyu",
"Aria",
- "Ayanda"
+ "Ayanda",
+ "Arlet"
]
},
"VoiceList":{
diff --git a/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json b/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json
index 93aae43d7d..b3044779c0 100644
--- a/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json
@@ -188,7 +188,7 @@
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
- "documentation":"<p>Creates an Amazon QuickSight group.</p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i>&lt;relevant-aws-account-id&gt;</i>:group/default/<i>&lt;group-name&gt;</i> </code>.</p> <p>The response is a group object.</p>"
+ "documentation":"<p>Creates an Amazon QuickSight group.</p> <p>The permissions resource is <code>arn:aws:quicksight:&lt;your-region&gt;:<i>&lt;relevant-aws-account-id&gt;</i>:group/default/<i>&lt;group-name&gt;</i> </code>.</p> <p>The response is a group object.</p>"
},
"CreateGroupMembership":{
"name":"CreateGroupMembership",
@@ -911,6 +911,25 @@
],
"documentation":"<p>Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). </p>"
},
+ "DescribeGroupMembership":{
+ "name":"DescribeGroupMembership",
+ "http":{
+ "method":"GET",
+ "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}"
+ },
+ "input":{"shape":"DescribeGroupMembershipRequest"},
+ "output":{"shape":"DescribeGroupMembershipResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InvalidParameterValueException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"PreconditionNotMetException"},
+ {"shape":"InternalFailureException"},
+ {"shape":"ResourceUnavailableException"}
+ ],
+ "documentation":"<p>Use the <code>DescribeGroupMembership</code> operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated <code>GroupMember</code> object is returned.</p>"
+ },
"DescribeIAMPolicyAssignment":{
"name":"DescribeIAMPolicyAssignment",
"http":{
@@ -1694,6 +1713,26 @@
],
"documentation":"<p>Searches the subfolders in a folder.</p>"
},
+ "SearchGroups":{
+ "name":"SearchGroups",
+ "http":{
+ "method":"POST",
+ "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search"
+ },
+ "input":{"shape":"SearchGroupsRequest"},
+ "output":{"shape":"SearchGroupsResponse"},
+ "errors":[
+ {"shape":"AccessDeniedException"},
+ {"shape":"InvalidParameterValueException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"ThrottlingException"},
+ {"shape":"InvalidNextTokenException"},
+ {"shape":"PreconditionNotMetException"},
+ {"shape":"InternalFailureException"},
+ {"shape":"ResourceUnavailableException"}
+ ],
+ "documentation":"<p>Use the <code>SearchGroups</code> operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.</p>"
+ },
"TagResource":{
"name":"TagResource",
"http":{
@@ -3444,7 +3483,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace that you want the user to be a part of.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -3492,7 +3531,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace that you want the group to be a part of.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -5147,7 +5186,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace of the group that you want to remove a user from.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -5189,7 +5228,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace of the group that you want to delete.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -6163,6 +6202,56 @@
}
}
},
+ "DescribeGroupMembershipRequest":{
+ "type":"structure",
+ "required":[
+ "MemberName",
+ "GroupName",
+ "AwsAccountId",
+ "Namespace"
+ ],
+ "members":{
+ "MemberName":{
+ "shape":"GroupMemberName",
+ "documentation":"<p>The user name of the user that you want to search for.</p>",
+ "location":"uri",
+ "locationName":"MemberName"
+ },
+ "GroupName":{
+ "shape":"GroupName",
+ "documentation":"<p>The name of the group that you want to search.</p>",
+ "location":"uri",
+ "locationName":"GroupName"
+ },
+ "AwsAccountId":{
+ "shape":"AwsAccountId",
+ "documentation":"<p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p>",
+ "location":"uri",
+ "locationName":"AwsAccountId"
+ },
+ "Namespace":{
+ "shape":"Namespace",
+ "documentation":"<p>The namespace that includes the group you are searching within.</p>",
+ "location":"uri",
+ "locationName":"Namespace"
+ }
+ }
+ },
+ "DescribeGroupMembershipResponse":{
+ "type":"structure",
+ "members":{
+ "GroupMember":{"shape":"GroupMember"},
+ "RequestId":{
+ "shape":"String",
+ "documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
+ },
+ "Status":{
+ "shape":"StatusCode",
+ "documentation":"<p>The HTTP status of the request.</p>",
+ "location":"statusCode"
+ }
+ }
+ },
"DescribeGroupRequest":{
"type":"structure",
"required":[
@@ -6185,7 +6274,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace of the group that you want described.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -7322,6 +7411,14 @@
"max":512,
"min":1
},
+ "GroupFilterAttribute":{
+ "type":"string",
+ "enum":["GROUP_NAME"]
+ },
+ "GroupFilterOperator":{
+ "type":"string",
+ "enum":["StartsWith"]
+ },
"GroupList":{
"type":"list",
"member":{"shape":"Group"}
@@ -7355,6 +7452,35 @@
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
},
+ "GroupSearchFilter":{
+ "type":"structure",
+ "required":[
+ "Operator",
+ "Name",
+ "Value"
+ ],
+ "members":{
+ "Operator":{
+ "shape":"GroupFilterOperator",
+ "documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StartsWith\"</code>. Currently, the only supported operator is <code>StartsWith</code>.</p>"
+ },
+ "Name":{
+ "shape":"GroupFilterAttribute",
+ "documentation":"<p>The name of the value that you want to use as a filter, for example <code>\"Name\": \"GROUP_NAME\"</code>. Currently, the only supported name is <code>GROUP_NAME</code>.</p>"
+ },
+ "Value":{
+ "shape":"String",
+ "documentation":"<p>The value of the named item, in this case <code>GROUP_NAME</code>, that you want to use as a filter.</p>"
+ }
+ },
+ "documentation":"<p>A <code>GroupSearchFilter</code> object that you want to apply to your search.</p>"
+ },
+ "GroupSearchFilterList":{
+ "type":"list",
+ "member":{"shape":"GroupSearchFilter"},
+ "max":1,
+ "min":1
+ },
"GutterStyle":{
"type":"structure",
"members":{
@@ -8207,7 +8333,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace of the group that you want a list of users from.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -8263,7 +8389,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace that you want a list of groups from.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -9575,7 +9701,7 @@
},
"CustomPermissionsName":{
"shape":"RoleName",
- "documentation":"<p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>To add custom permissions to an existing user, use <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html\">UpdateUser</a> </code> instead.</p> <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a QuickSight user. </p> <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).</p> <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>"
+ "documentation":"<p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>To add custom permissions to an existing user, use <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html\">UpdateUser</a> </code> instead.</p> <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Amazon QuickSight user. </p> <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).</p> <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>"
},
"ExternalLoginFederationProviderType":{
"shape":"String",
@@ -10187,6 +10313,67 @@
}
}
},
+ "SearchGroupsRequest":{
+ "type":"structure",
+ "required":[
+ "AwsAccountId",
+ "Namespace",
+ "Filters"
+ ],
+ "members":{
+ "AwsAccountId":{
+ "shape":"AwsAccountId",
+ "documentation":"<p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p>",
+ "location":"uri",
+ "locationName":"AwsAccountId"
+ },
+ "NextToken":{
+ "shape":"String",
+ "documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
+ "location":"querystring",
+ "locationName":"next-token"
+ },
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of results to return from this request.</p>",
+ "box":true,
+ "location":"querystring",
+ "locationName":"max-results"
+ },
+ "Namespace":{
+ "shape":"Namespace",
+ "documentation":"<p>The namespace that you want to search.</p>",
+ "location":"uri",
+ "locationName":"Namespace"
+ },
+ "Filters":{
+ "shape":"GroupSearchFilterList",
+ "documentation":"<p>The structure for the search filters that you want to apply to your search.</p>"
+ }
+ }
+ },
+ "SearchGroupsResponse":{
+ "type":"structure",
+ "members":{
+ "GroupList":{
+ "shape":"GroupList",
+ "documentation":"<p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>"
+ },
+ "NextToken":{
+ "shape":"String",
+ "documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
+ },
+ "RequestId":{
+ "shape":"String",
+ "documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
+ },
+ "Status":{
+ "shape":"StatusCode",
+ "documentation":"<p>The HTTP status of the request.</p>",
+ "location":"statusCode"
+ }
+ }
+ },
"ServiceNowParameters":{
"type":"structure",
"required":["SiteBaseUrl"],
@@ -12028,7 +12215,7 @@
},
"Namespace":{
"shape":"Namespace",
- "documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
+ "documentation":"<p>The namespace of the group that you want to update.</p>",
"location":"uri",
"locationName":"Namespace"
}
@@ -12556,7 +12743,7 @@
},
"CustomPermissionsName":{
"shape":"RoleName",
- "documentation":"<p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a QuickSight user. </p> <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).</p> <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>"
+ "documentation":"<p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Amazon QuickSight user. </p> <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).</p> <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>"
},
"UnapplyCustomPermissions":{
"shape":"Boolean",
diff --git a/contrib/python/botocore/py3/botocore/data/ram/2018-01-04/service-2.json b/contrib/python/botocore/py3/botocore/data/ram/2018-01-04/service-2.json
index 85422ad85c..cd40ed9244 100644
--- a/contrib/python/botocore/py3/botocore/data/ram/2018-01-04/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ram/2018-01-04/service-2.json
@@ -399,7 +399,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
- "documentation":"<p>Lists the resources that you added to a resource shares or the resources that are shared with you.</p>"
+ "documentation":"<p>Lists the resources that you added to a resource share or the resources that are shared with you.</p>"
},
"PromoteResourceShareCreatedFromPolicy":{
"name":"PromoteResourceShareCreatedFromPolicy",
@@ -921,7 +921,7 @@
},
"resourceOwner":{
"shape":"ResourceOwner",
- "documentation":"<p>Specifies that you want to retrieve details of only those resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resources that you are sharing</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts share with you</p> </li> </ul>"
+ "documentation":"<p>Specifies that you want to retrieve details of only those resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resource shares that your account shares with other accounts</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resource shares that other accounts share with your account</p> </li> </ul>"
},
"name":{
"shape":"String",
@@ -1131,7 +1131,7 @@
"members":{
"resourceOwner":{
"shape":"ResourceOwner",
- "documentation":"<p>Specifies that you want to list information for only resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resources that you are sharing</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts share with you</p> </li> </ul>"
+ "documentation":"<p>Specifies that you want to list information for only resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – principals that your account is sharing resources with</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – principals that are sharing resources with your account</p> </li> </ul>"
},
"resourceArn":{
"shape":"String",
@@ -1239,7 +1239,7 @@
"members":{
"resourceOwner":{
"shape":"ResourceOwner",
- "documentation":"<p>Specifies that you want to list only the resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resources that you are sharing</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts share with you</p> </li> </ul>"
+ "documentation":"<p>Specifies that you want to list only the resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resources that your account shares with other accounts</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resources that other accounts share with your account</p> </li> </ul>"
},
"principal":{
"shape":"String",
diff --git a/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json b/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json
index c45b0bbb60..5ebf7323ca 100644
--- a/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json
@@ -110,7 +110,7 @@
{"shape":"AuthorizationAlreadyExistsFault"},
{"shape":"AuthorizationQuotaExceededFault"}
],
- "documentation":"<p>Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).</p> <note> <p>You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.</p> </note> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>. </p>"
+ "documentation":"<p>Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).</p> <note> <p>You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.</p> </note> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.</p>"
},
"BacktrackDBCluster":{
"name":"BacktrackDBCluster",
@@ -127,7 +127,7 @@
{"shape":"DBClusterNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"}
],
- "documentation":"<p>Backtracks a DB cluster to a specific time, without creating a new DB cluster.</p> <p>For more information on backtracking, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html\"> Backtracking an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora MySQL DB clusters.</p> </note>"
+ "documentation":"<p>Backtracks a DB cluster to a specific time, without creating a new DB cluster.</p> <p>For more information on backtracking, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html\"> Backtracking an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora MySQL DB clusters.</p> </note>"
},
"CancelExportTask":{
"name":"CancelExportTask",
@@ -144,7 +144,7 @@
{"shape":"ExportTaskNotFoundFault"},
{"shape":"InvalidExportTaskStateFault"}
],
- "documentation":"<p>Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed. </p>"
+ "documentation":"<p>Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.</p>"
},
"CopyDBClusterParameterGroup":{
"name":"CopyDBClusterParameterGroup",
@@ -183,7 +183,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
- "documentation":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p> <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the <code>CopyDBClusterSnapshot</code> action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p> </li> <li> <p> <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.</p> <p>The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.</p> </note> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL. </p> </li> </ul> <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in \"copying\" status.</p> <p>For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html\"> Copying a Snapshot</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p> <p>You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the <code>CopyDBClusterSnapshot</code> action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p> </li> <li> <p> <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.</p> <p>The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.</p> </note> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL.</p> </li> </ul> <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in \"copying\" status.</p> <p>For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html\"> Copying a Snapshot</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CopyDBParameterGroup":{
"name":"CopyDBParameterGroup",
@@ -222,7 +222,7 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"CustomAvailabilityZoneNotFoundFault"}
],
- "documentation":"<p>Copies the specified DB snapshot. The source DB snapshot must be in the <code>available</code> state.</p> <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the <code>CopyDBSnapshot</code> action is the destination Amazon Web Services Region for the DB snapshot copy. </p> <p>This command doesn't apply to RDS Custom.</p> <p>For more information about copying snapshots, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot\">Copying a DB Snapshot</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>Copies the specified DB snapshot. The source DB snapshot must be in the <code>available</code> state.</p> <p>You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the <code>CopyDBSnapshot</code> action is the destination Amazon Web Services Region for the DB snapshot copy.</p> <p>This command doesn't apply to RDS Custom.</p> <p>For more information about copying snapshots, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot\">Copying a DB Snapshot</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CopyOptionGroup":{
"name":"CopyOptionGroup",
@@ -276,7 +276,7 @@
{"shape":"CustomDBEngineVersionQuotaExceededFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
- "documentation":"<p>Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:</p> <ul> <li> <p> Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR</p> </li> <li> <p> Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR</p> </li> </ul> <p>Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.</p> <p>When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).</p> <p>Creation takes approximately two hours. If creation fails, RDS Custom issues <code>RDS-EVENT-0196</code> with the message <code>Creation failed for custom engine version</code>, and includes details about the failure. For example, the event prints missing files.</p> <p>After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.</p> <note> <p>The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the <code>CreateCustomDbEngineVersion</code> event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the <code>CreateCustomDbEngineVersion</code> event.</p> </note> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.create\"> Creating a CEV</a> in the <i>Amazon RDS User Guide</i>.</p>"
+ "documentation":"<p>Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:</p> <ul> <li> <p>Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR</p> </li> <li> <p>Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR</p> </li> </ul> <p>Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.</p> <p>When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).</p> <p>Creation takes approximately two hours. If creation fails, RDS Custom issues <code>RDS-EVENT-0196</code> with the message <code>Creation failed for custom engine version</code>, and includes details about the failure. For example, the event prints missing files.</p> <p>After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.</p> <note> <p>The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the <code>CreateCustomDbEngineVersion</code> event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the <code>CreateCustomDbEngineVersion</code> event.</p> </note> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.create\"> Creating a CEV</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CreateDBCluster":{
"name":"CreateDBCluster",
@@ -309,7 +309,7 @@
{"shape":"InvalidGlobalClusterStateFault"},
{"shape":"DomainNotFoundFault"}
],
- "documentation":"<p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by <code>ReplicationSourceIdentifier</code> is encrypted, also specify the <code>PreSignedUrl</code> parameter.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region replication where the DB cluster identified by <code>ReplicationSourceIdentifier</code> is encrypted, also specify the <code>PreSignedUrl</code> parameter.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CreateDBClusterEndpoint":{
"name":"CreateDBClusterEndpoint",
@@ -347,7 +347,7 @@
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
- "documentation":"<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p> A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBClusterParameterGroup</code>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <code>ModifyDBCluster</code>.</p> <p>When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. </p> <p>When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. </p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <code>DescribeDBClusterParameters</code> action to verify that your DB cluster parameter group has been created or modified.</p> </important> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p>A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBClusterParameterGroup</code>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <code>ModifyDBCluster</code>.</p> <p>When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p> <p>When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <code>DescribeDBClusterParameters</code> action to verify that your DB cluster parameter group has been created or modified.</p> </important> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CreateDBClusterSnapshot":{
"name":"CreateDBClusterSnapshot",
@@ -367,7 +367,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"}
],
- "documentation":"<p>Creates a snapshot of a DB cluster.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Creates a snapshot of a DB cluster.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CreateDBInstance":{
"name":"CreateDBInstance",
@@ -435,7 +435,7 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DomainNotFoundFault"}
],
- "documentation":"<p>Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html\">Working with Read Replicas</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Amazon Aurora doesn't support this action. Call the <code>CreateDBInstance</code> action to create a DB instance for an Aurora DB cluster.</p> <p>All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.</p> <important> <p>Your source DB instance must have backup retention enabled. </p> </important>"
+ "documentation":"<p>Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html\">Working with Read Replicas</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Amazon Aurora doesn't support this action. Call the <code>CreateDBInstance</code> action to create a DB instance for an Aurora DB cluster.</p> <p>All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.</p> <important> <p>Your source DB instance must have backup retention enabled.</p> </important>"
},
"CreateDBParameterGroup":{
"name":"CreateDBParameterGroup",
@@ -452,7 +452,7 @@
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
- "documentation":"<p>Creates a new DB parameter group.</p> <p> A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. </p> <p>This command doesn't apply to RDS Custom.</p> <important> <p>After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
+ "documentation":"<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.</p> <p>This command doesn't apply to RDS Custom.</p> <important> <p>After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
},
"CreateDBProxy":{
"name":"CreateDBProxy",
@@ -490,7 +490,7 @@
{"shape":"DBProxyEndpointQuotaExceededFault"},
{"shape":"InvalidDBProxyStateFault"}
],
- "documentation":"<p> Creates a <code>DBProxyEndpoint</code>. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC. </p>"
+ "documentation":"<p>Creates a <code>DBProxyEndpoint</code>. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.</p>"
},
"CreateDBSecurityGroup":{
"name":"CreateDBSecurityGroup",
@@ -588,7 +588,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBClusterNotFoundFault"}
],
- "documentation":"<p> Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. </p> <p> You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.</p> <p>You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"CreateOptionGroup":{
"name":"CreateOptionGroup",
@@ -659,7 +659,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"}
],
- "documentation":"<p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DeleteDBClusterEndpoint":{
"name":"DeleteDBClusterEndpoint",
@@ -690,7 +690,7 @@
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
- "documentation":"<p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DeleteDBClusterSnapshot":{
"name":"DeleteDBClusterSnapshot",
@@ -707,7 +707,7 @@
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"DBClusterSnapshotNotFoundFault"}
],
- "documentation":"<p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DeleteDBInstance":{
"name":"DeleteDBInstance",
@@ -728,7 +728,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBInstanceAutomatedBackupQuotaExceededFault"}
],
- "documentation":"<p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p> <p> If you request a final DB snapshot the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. </p> <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p> <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:</p> <ul> <li> <p>The DB cluster is a read replica of another Amazon Aurora DB cluster.</p> </li> <li> <p>The DB instance is the only instance in the DB cluster.</p> </li> </ul> <p>To delete a DB instance in this case, first call the <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster.</p>"
+ "documentation":"<p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p> <p>If you request a final DB snapshot the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.</p> <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p> <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:</p> <ul> <li> <p>The DB cluster is a read replica of another Amazon Aurora DB cluster.</p> </li> <li> <p>The DB instance is the only instance in the DB cluster.</p> </li> </ul> <p>To delete a DB instance in this case, first call the <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster.</p>"
},
"DeleteDBInstanceAutomatedBackup":{
"name":"DeleteDBInstanceAutomatedBackup",
@@ -870,7 +870,7 @@
{"shape":"GlobalClusterNotFoundFault"},
{"shape":"InvalidGlobalClusterStateFault"}
],
- "documentation":"<p> Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"DeleteInstallationMedia":{
"name":"DeleteInstallationMedia",
@@ -980,7 +980,7 @@
{"shape":"DBClusterNotFoundFault"},
{"shape":"DBClusterBacktrackNotFoundFault"}
],
- "documentation":"<p>Returns information about backtracks for a DB cluster.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora MySQL DB clusters.</p> </note>"
+ "documentation":"<p>Returns information about backtracks for a DB cluster.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora MySQL DB clusters.</p> </note>"
},
"DescribeDBClusterEndpoints":{
"name":"DescribeDBClusterEndpoints",
@@ -1012,7 +1012,7 @@
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
- "documentation":"<p> Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group. </p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DescribeDBClusterParameters":{
"name":"DescribeDBClusterParameters",
@@ -1028,7 +1028,7 @@
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
- "documentation":"<p>Returns the detailed parameter list for a particular DB cluster parameter group.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Returns the detailed parameter list for a particular DB cluster parameter group.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DescribeDBClusterSnapshotAttributes":{
"name":"DescribeDBClusterSnapshotAttributes",
@@ -1060,7 +1060,7 @@
"errors":[
{"shape":"DBClusterSnapshotNotFoundFault"}
],
- "documentation":"<p>Returns information about DB cluster snapshots. This API action supports pagination.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Returns information about DB cluster snapshots. This API action supports pagination.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DescribeDBClusters":{
"name":"DescribeDBClusters",
@@ -1076,7 +1076,7 @@
"errors":[
{"shape":"DBClusterNotFoundFault"}
],
- "documentation":"<p>Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note> <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p>"
+ "documentation":"<p>Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p>"
},
"DescribeDBEngineVersions":{
"name":"DescribeDBEngineVersions",
@@ -1153,7 +1153,7 @@
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
- "documentation":"<p> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </p>"
+ "documentation":"<p>Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group.</p>"
},
"DescribeDBParameters":{
"name":"DescribeDBParameters",
@@ -1255,7 +1255,7 @@
"errors":[
{"shape":"DBSecurityGroupNotFoundFault"}
],
- "documentation":"<p> Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group. </p>"
+ "documentation":"<p>Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group.</p>"
},
"DescribeDBSnapshotAttributes":{
"name":"DescribeDBSnapshotAttributes",
@@ -1303,7 +1303,7 @@
"errors":[
{"shape":"DBSubnetGroupNotFoundFault"}
],
- "documentation":"<p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.</p> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>. </p>"
+ "documentation":"<p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.</p> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>.</p>"
},
"DescribeEngineDefaultClusterParameters":{
"name":"DescribeEngineDefaultClusterParameters",
@@ -1316,7 +1316,7 @@
"shape":"DescribeEngineDefaultClusterParametersResult",
"resultWrapper":"DescribeEngineDefaultClusterParametersResult"
},
- "documentation":"<p>Returns the default engine and system parameter information for the cluster database engine.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p>"
+ "documentation":"<p>Returns the default engine and system parameter information for the cluster database engine.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"DescribeEngineDefaultParameters":{
"name":"DescribeEngineDefaultParameters",
@@ -1342,7 +1342,7 @@
"shape":"EventCategoriesMessage",
"resultWrapper":"DescribeEventCategoriesResult"
},
- "documentation":"<p>Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the \"Amazon RDS event categories and event messages\" section of the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html\"> <i>Amazon RDS User Guide</i> </a> or the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html\"> <i>Amazon Aurora User Guide</i> </a>. </p>"
+ "documentation":"<p>Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the \"Amazon RDS event categories and event messages\" section of the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html\"> <i>Amazon RDS User Guide</i> </a> or the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html\"> <i>Amazon Aurora User Guide</i> </a>.</p>"
},
"DescribeEventSubscriptions":{
"name":"DescribeEventSubscriptions",
@@ -1387,7 +1387,7 @@
"errors":[
{"shape":"ExportTaskNotFoundFault"}
],
- "documentation":"<p>Returns information about a snapshot export to Amazon S3. This API operation supports pagination. </p>"
+ "documentation":"<p>Returns information about a snapshot export to Amazon S3. This API operation supports pagination.</p>"
},
"DescribeGlobalClusters":{
"name":"DescribeGlobalClusters",
@@ -1403,7 +1403,7 @@
"errors":[
{"shape":"GlobalClusterNotFoundFault"}
],
- "documentation":"<p> Returns information about Aurora global database clusters. This API supports pagination. </p> <p> For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Returns information about Aurora global database clusters. This API supports pagination.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"DescribeInstallationMedia":{
"name":"DescribeInstallationMedia",
@@ -1539,7 +1539,7 @@
{"shape":"DBInstanceNotFoundFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
- "documentation":"<p>You can call <code>DescribeValidDBInstanceModifications</code> to learn what modifications you can make to your DB instance. You can use this information when you call <code>ModifyDBInstance</code>. </p> <p>This command doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>You can call <code>DescribeValidDBInstanceModifications</code> to learn what modifications you can make to your DB instance. You can use this information when you call <code>ModifyDBInstance</code>.</p> <p>This command doesn't apply to RDS Custom.</p>"
},
"DownloadDBLogFilePortion":{
"name":"DownloadDBLogFilePortion",
@@ -1574,7 +1574,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
- "documentation":"<p>Forces a failover for a DB cluster.</p> <p>For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).</p> <p>For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).</p> <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby DB instance when the primary DB instance fails.</p> <p>To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Forces a failover for a DB cluster.</p> <p>For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).</p> <p>For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).</p> <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby DB instance when the primary DB instance fails.</p> <p>To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"FailoverGlobalCluster":{
"name":"FailoverGlobalCluster",
@@ -1593,7 +1593,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBClusterNotFoundFault"}
],
- "documentation":"<p>Initiates the failover process for an Aurora global database (<a>GlobalCluster</a>).</p> <p>A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.</p> <p>For more information about failing over an Amazon Aurora global database, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover\">Managed planned failover for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action applies to <a>GlobalCluster</a> (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology. </p> </note>"
+ "documentation":"<p>Initiates the failover process for an Aurora global database (<a>GlobalCluster</a>).</p> <p>A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.</p> <p>For more information about failing over an Amazon Aurora global database, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover\">Managed planned failover for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action applies to <a>GlobalCluster</a> (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.</p> </note>"
},
"ImportInstallationMedia":{
"name":"ImportInstallationMedia",
@@ -1664,7 +1664,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBClusterCapacityFault"}
],
- "documentation":"<p>Set the capacity of an Aurora Serverless DB cluster to a specific value.</p> <p>Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call <code>ModifyCurrentDBClusterCapacity</code> to set the capacity explicitly.</p> <p>After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.</p> <p>For more information about Aurora Serverless, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p> <important> <p>If you call <code>ModifyCurrentDBClusterCapacity</code> with the default <code>TimeoutAction</code>, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling\"> Autoscaling for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p> </important> <note> <p>This action only applies to Aurora Serverless DB clusters.</p> </note>"
+ "documentation":"<p>Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.</p> <p>Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call <code>ModifyCurrentDBClusterCapacity</code> to set the capacity explicitly.</p> <p>After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.</p> <p>For more information about Aurora Serverless v1, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p> <important> <p>If you call <code>ModifyCurrentDBClusterCapacity</code> with the default <code>TimeoutAction</code>, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling\"> Autoscaling for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p> </important> <note> <p>This action only applies to Aurora Serverless v1 DB clusters.</p> </note>"
},
"ModifyCustomDBEngineVersion":{
"name":"ModifyCustomDBEngineVersion",
@@ -1708,7 +1708,7 @@
{"shape":"DBClusterAlreadyExistsFault"},
{"shape":"DomainNotFoundFault"}
],
- "documentation":"<p>Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"ModifyDBClusterEndpoint":{
"name":"ModifyDBClusterEndpoint",
@@ -1745,7 +1745,7 @@
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"InvalidDBParameterGroupStateFault"}
],
- "documentation":"<p> Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <code>DescribeDBClusterParameters</code> action to verify that your DB cluster parameter group has been created or modified.</p> <p>If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.</p> </important> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request.</p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <code>DescribeDBClusterParameters</code> action to verify that your DB cluster parameter group has been created or modified.</p> <p>If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.</p> </important> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"ModifyDBClusterSnapshotAttribute":{
"name":"ModifyDBClusterSnapshotAttribute",
@@ -1797,7 +1797,7 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"InvalidDBClusterStateFault"}
],
- "documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call <code>DescribeValidDBInstanceModifications</code> before you call <code>ModifyDBInstance</code>. </p>"
+ "documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call <code>DescribeValidDBInstanceModifications</code> before you call <code>ModifyDBInstance</code>.</p>"
},
"ModifyDBParameterGroup":{
"name":"ModifyDBParameterGroup",
@@ -1814,7 +1814,7 @@
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"InvalidDBParameterGroupStateFault"}
],
- "documentation":"<p> Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <important> <p>After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
+ "documentation":"<p>Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request.</p> <important> <p>After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
},
"ModifyDBProxy":{
"name":"ModifyDBProxy",
@@ -1885,7 +1885,7 @@
"errors":[
{"shape":"DBSnapshotNotFoundFault"}
],
- "documentation":"<p>Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. </p> <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom. </p>"
+ "documentation":"<p>Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. </p> <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.</p>"
},
"ModifyDBSnapshotAttribute":{
"name":"ModifyDBSnapshotAttribute",
@@ -1963,7 +1963,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
- "documentation":"<p> Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"ModifyOptionGroup":{
"name":"ModifyOptionGroup",
@@ -2050,7 +2050,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
- "documentation":"<p>You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect. </p> <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting. </p> <p>Use this operation only for a non-Aurora Multi-AZ DB cluster. The Multi-AZ DB clusters feature is in preview and is subject to change.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.</p> <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.</p> <p>Use this operation only for a non-Aurora Multi-AZ DB cluster.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"RebootDBInstance":{
"name":"RebootDBInstance",
@@ -2067,7 +2067,7 @@
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBInstanceNotFoundFault"}
],
- "documentation":"<p>You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. </p> <p>For more information about rebooting, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html\">Rebooting a DB Instance</a> in the <i>Amazon RDS User Guide.</i> </p> <p>This command doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.</p> <p>Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.</p> <p>For more information about rebooting, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html\">Rebooting a DB Instance</a> in the <i>Amazon RDS User Guide.</i> </p> <p>This command doesn't apply to RDS Custom.</p>"
},
"RegisterDBProxyTargets":{
"name":"RegisterDBProxyTargets",
@@ -2109,7 +2109,7 @@
{"shape":"InvalidGlobalClusterStateFault"},
{"shape":"DBClusterNotFoundFault"}
],
- "documentation":"<p> Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region. </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"RemoveRoleFromDBCluster":{
"name":"RemoveRoleFromDBCluster",
@@ -2123,7 +2123,7 @@
{"shape":"DBClusterRoleNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"}
],
- "documentation":"<p>Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"RemoveRoleFromDBInstance":{
"name":"RemoveRoleFromDBInstance",
@@ -2187,7 +2187,7 @@
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
- "documentation":"<p> Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. </p> <p> When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. You must call <code>RebootDBInstance</code> for every DB instance in your DB cluster that you want the updated static parameter to apply to.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters.</p> <p>When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. You must call <code>RebootDBInstance</code> for every DB instance in your DB cluster that you want the updated static parameter to apply to.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"ResetDBParameterGroup":{
"name":"ResetDBParameterGroup",
@@ -2204,7 +2204,7 @@
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
- "documentation":"<p>Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. </p>"
+ "documentation":"<p>Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request.</p>"
},
"RestoreDBClusterFromS3":{
"name":"RestoreDBClusterFromS3",
@@ -2233,7 +2233,7 @@
{"shape":"DomainNotFoundFault"},
{"shape":"InsufficientStorageClusterCapacityFault"}
],
- "documentation":"<p>Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3\"> Migrating Data from MySQL by Using an Amazon S3 Bucket</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterFromS3</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters. The source DB engine must be MySQL.</p> </note>"
+ "documentation":"<p>Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3\"> Migrating Data from MySQL by Using an Amazon S3 Bucket</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterFromS3</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters. The source DB engine must be MySQL.</p> </note>"
},
"RestoreDBClusterFromSnapshot":{
"name":"RestoreDBClusterFromSnapshot",
@@ -2267,7 +2267,7 @@
{"shape":"DomainNotFoundFault"},
{"shape":"DBClusterParameterGroupNotFoundFault"}
],
- "documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.</p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.</p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"RestoreDBClusterToPointInTime":{
"name":"RestoreDBClusterToPointInTime",
@@ -2300,7 +2300,7 @@
{"shape":"DomainNotFoundFault"},
{"shape":"DBClusterParameterGroupNotFoundFault"}
],
- "documentation":"<p>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. </p> <note> <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>"
+ "documentation":"<p>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.</p> <note> <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"RestoreDBInstanceFromDBSnapshot":{
"name":"RestoreDBInstanceFromDBSnapshot",
@@ -2461,7 +2461,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
- "documentation":"<p>Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html\"> Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html\"> Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"StartDBInstance":{
"name":"StartDBInstance",
@@ -2487,7 +2487,7 @@
{"shape":"AuthorizationNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
- "documentation":"<p> Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html\"> Starting an Amazon RDS DB instance That Was Previously Stopped</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p> This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use <code>StartDBCluster</code> instead. </p> </note>"
+ "documentation":"<p>Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html\"> Starting an Amazon RDS DB instance That Was Previously Stopped</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use <code>StartDBCluster</code> instead.</p> </note>"
},
"StartDBInstanceAutomatedBackupsReplication":{
"name":"StartDBInstanceAutomatedBackupsReplication",
@@ -2531,7 +2531,7 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"InvalidExportSourceStateFault"}
],
- "documentation":"<p>Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. </p> <p>This command doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.</p> <p>This command doesn't apply to RDS Custom.</p>"
},
"StopActivityStream":{
"name":"StopActivityStream",
@@ -2569,7 +2569,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
- "documentation":"<p> Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html\"> Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
+ "documentation":"<p>Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html\"> Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"StopDBInstance":{
"name":"StopDBInstance",
@@ -2589,7 +2589,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterStateFault"}
],
- "documentation":"<p> Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html\"> Stopping an Amazon RDS DB Instance Temporarily</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p> This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use <code>StopDBCluster</code> instead. </p> </note>"
+ "documentation":"<p>Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html\"> Stopping an Amazon RDS DB Instance Temporarily</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use <code>StopDBCluster</code> instead.</p> </note>"
},
"StopDBInstanceAutomatedBackupsReplication":{
"name":"StopDBInstanceAutomatedBackupsReplication",
@@ -2701,11 +2701,11 @@
},
"RoleArn":{
"shape":"String",
- "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example <code>arn:aws:iam::123456789012:role/AccessRole</code>. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example <code>arn:aws:iam::123456789012:role/AccessRole</code>.</p>"
},
"FeatureName":{
"shape":"String",
- "documentation":"<p>The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see <a>DBEngineVersion</a>. </p>"
+ "documentation":"<p>The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see <a>DBEngineVersion</a>.</p>"
}
}
},
@@ -2848,15 +2848,15 @@
},
"EC2SecurityGroupName":{
"shape":"String",
- "documentation":"<p> Name of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </p>"
+ "documentation":"<p>Name of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.</p>"
},
"EC2SecurityGroupId":{
"shape":"String",
- "documentation":"<p> Id of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </p>"
+ "documentation":"<p>Id of the EC2 security group to authorize. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.</p>"
},
"EC2SecurityGroupOwnerId":{
"shape":"String",
- "documentation":"<p> Amazon Web Services account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </p>"
+ "documentation":"<p>Amazon Web Services account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, <code>EC2SecurityGroupOwnerId</code> and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.</p>"
}
},
"documentation":"<p/>"
@@ -2882,7 +2882,7 @@
"documentation":"<p>The name of the Availability Zone.</p>"
}
},
- "documentation":"<p>Contains Availability Zone information.</p> <p> This data type is used as an element in the <code>OrderableDBInstanceOption</code> data type.</p>",
+ "documentation":"<p>Contains Availability Zone information.</p> <p>This data type is used as an element in the <code>OrderableDBInstanceOption</code> data type.</p>",
"wrapper":true
},
"AvailabilityZoneList":{
@@ -3042,7 +3042,7 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribeCertificates</code> 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>An optional pagination token provided by a previous <code>DescribeCertificates</code> 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>Data returned by the <b>DescribeCertificates</b> action.</p>"
@@ -3051,7 +3051,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> <code>CertificateIdentifier</code> doesn't refer to an existing certificate. </p>",
+ "documentation":"<p> <code>CertificateIdentifier</code> doesn't refer to an existing certificate.</p>",
"error":{
"code":"CertificateNotFound",
"httpStatusCode":404,
@@ -3071,7 +3071,7 @@
"documentation":"<p>The description of the character set.</p>"
}
},
- "documentation":"<p> This data type is used as a response element in the action <code>DescribeDBEngineVersions</code>. </p>"
+ "documentation":"<p>This data type is used as a response element in the action <code>DescribeDBEngineVersions</code>.</p>"
},
"CloudwatchLogsExportConfiguration":{
"type":"structure",
@@ -3119,7 +3119,7 @@
},
"MaxIdleConnectionsPercent":{
"shape":"IntegerOptional",
- "documentation":"<p> Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the <code>max_connections</code> setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. </p> <p>Default: 50</p> <p>Constraints: between 0 and <code>MaxConnectionsPercent</code> </p>"
+ "documentation":"<p>Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the <code>max_connections</code> setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.</p> <p>Default: 50</p> <p>Constraints: between 0 and <code>MaxConnectionsPercent</code> </p>"
},
"ConnectionBorrowTimeout":{
"shape":"IntegerOptional",
@@ -3131,7 +3131,7 @@
},
"InitQuery":{
"shape":"String",
- "documentation":"<p> One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>. </p> <p>Default: no initialization query</p>"
+ "documentation":"<p>One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>.</p> <p>Default: no initialization query</p>"
}
},
"documentation":"<p>Specifies the settings that control the size and behavior of the connection pool associated with a <code>DBProxyTargetGroup</code>.</p>"
@@ -3145,7 +3145,7 @@
},
"MaxIdleConnectionsPercent":{
"shape":"Integer",
- "documentation":"<p> Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the <code>max_connections</code> setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. </p>"
+ "documentation":"<p>Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the <code>max_connections</code> setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.</p>"
},
"ConnectionBorrowTimeout":{
"shape":"Integer",
@@ -3157,7 +3157,7 @@
},
"InitQuery":{
"shape":"String",
- "documentation":"<p> One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>. </p>"
+ "documentation":"<p>One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>.</p>"
}
},
"documentation":"<p>Displays the settings that control the size and behavior of the connection pool associated with a <code>DBProxyTarget</code>.</p>"
@@ -3172,7 +3172,7 @@
"members":{
"SourceDBClusterParameterGroupIdentifier":{
"shape":"String",
- "documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an ARN for Amazon RDS</a> in the <i>Amazon Aurora User Guide</i>. </p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB cluster parameter group.</p> </li> </ul>"
+ "documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an ARN for Amazon RDS</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB cluster parameter group.</p> </li> </ul>"
},
"TargetDBClusterParameterGroupIdentifier":{
"shape":"String",
@@ -3200,7 +3200,7 @@
"members":{
"SourceDBClusterSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p>The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.</p> <p>You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions\"> Copying Snapshots Across Amazon Web Services Regions</a> in the <i>Amazon Aurora User Guide.</i> </p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
+ "documentation":"<p>The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.</p> <p>You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions\"> Copying Snapshots Across Amazon Web Services Regions</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
},
"TargetDBClusterSnapshotIdentifier":{
"shape":"String",
@@ -3208,7 +3208,7 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.</p> <p>If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. </p> <p>If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set <code>KmsKeyId</code> to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
+ "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.</p> <p>If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.</p> <p>If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for <code>KmsKeyId</code>.</p> <p>To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set <code>KmsKeyId</code> to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
},
"PreSignedUrl":{
"shape":"String",
@@ -3238,7 +3238,7 @@
"members":{
"SourceDBParameterGroupIdentifier":{
"shape":"String",
- "documentation":"<p> The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an ARN for Amazon RDS</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB parameter group.</p> </li> </ul>"
+ "documentation":"<p>The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing\"> Constructing an ARN for Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB parameter group.</p> </li> </ul>"
},
"TargetDBParameterGroupIdentifier":{
"shape":"String",
@@ -3267,15 +3267,15 @@
"members":{
"SourceDBSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p>The identifier for the source DB snapshot.</p> <p>If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify <code>rds:mysql-instance1-snapshot-20130805</code>. </p> <p>If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code>. </p> <p>If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. </p> <p>If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region, and must match the <code>SourceDBSnapshotIdentifier</code> in the <code>PreSignedUrl</code> parameter. </p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> </ul> <p>Example: <code>rds:mydb-2012-04-02-00-01</code> </p> <p>Example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code> </p>"
+ "documentation":"<p>The identifier for the source DB snapshot.</p> <p>If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify <code>rds:mysql-instance1-snapshot-20130805</code>.</p> <p>If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code>.</p> <p>If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.</p> <p>If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region, and must match the <code>SourceDBSnapshotIdentifier</code> in the <code>PreSignedUrl</code> parameter.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> </ul> <p>Example: <code>rds:mydb-2012-04-02-00-01</code> </p> <p>Example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805</code> </p>"
},
"TargetDBSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p>The identifier for the copy of the snapshot. </p> <p>Constraints:</p> <ul> <li> <p>Can't be null, empty, or blank</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-db-snapshot</code> </p>"
+ "documentation":"<p>The identifier for the copy of the snapshot.</p> <p>Constraints:</p> <ul> <li> <p>Can't be null, empty, or blank</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-db-snapshot</code> </p>"
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. </p> <p>If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. </p> <p>If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter. </p> <p>If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. </p> <p>If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. </p>"
+ "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p> <p>If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.</p> <p>If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.</p> <p>If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.</p> <p>If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.</p>"
},
"Tags":{"shape":"TagList"},
"CopyTags":{
@@ -3284,11 +3284,11 @@
},
"PreSignedUrl":{
"shape":"String",
- "documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBSnapshot</code> API action in the source Amazon Web Services Region that contains the source DB snapshot to copy. </p> <p>You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify <code>PreSignedUrl</code> when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBSnapshot</code> API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: </p> <ul> <li> <p> <code>DestinationRegion</code> - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the <code>CopyDBSnapshot</code> action is called that contains this presigned URL. </p> <p>For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the <code>CopyDBSnapshot</code> action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the <code>CopyDBSnapshot</code> action in the us-west-2 Amazon Web Services Region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 Amazon Web Services Region. </p> </li> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBSnapshot</code> action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. </p> </li> <li> <p> <code>SourceDBSnapshotIdentifier</code> - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115</code>. </p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\">Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>. </p> <note> <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.</p> </note>"
+ "documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBSnapshot</code> API action in the source Amazon Web Services Region that contains the source DB snapshot to copy.</p> <p>You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify <code>PreSignedUrl</code> when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBSnapshot</code> API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>DestinationRegion</code> - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the <code>CopyDBSnapshot</code> action is called that contains this presigned URL.</p> <p>For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the <code>CopyDBSnapshot</code> action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the <code>CopyDBSnapshot</code> action in the us-west-2 Amazon Web Services Region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 Amazon Web Services Region.</p> </li> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the <code>CopyDBSnapshot</code> action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.</p> </li> <li> <p> <code>SourceDBSnapshotIdentifier</code> - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your <code>SourceDBSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\">Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.</p> </note>"
},
"OptionGroupName":{
"shape":"String",
- "documentation":"<p>The name of an option group to associate with the copy of the snapshot.</p> <p>Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options\">Option group considerations</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>The name of an option group to associate with the copy of the snapshot.</p> <p>Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options\">Option group considerations</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"TargetCustomAvailabilityZone":{
"shape":"String",
@@ -3313,7 +3313,7 @@
"members":{
"SourceOptionGroupIdentifier":{
"shape":"String",
- "documentation":"<p>The identifier for the source option group. </p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid option group.</p> </li> </ul>"
+ "documentation":"<p>The identifier for the source option group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid option group.</p> </li> </ul>"
},
"TargetOptionGroupIdentifier":{
"shape":"String",
@@ -3398,7 +3398,7 @@
},
"Manifest":{
"shape":"CustomDBEngineVersionManifest",
- "documentation":"<p>The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.</p> <p>The following JSON fields are valid:</p> <dl> <dt>MediaImportTemplateVersion</dt> <dd> <p>Version of the CEV manifest. The date is in the format <code>YYYY-MM-DD</code>.</p> </dd> <dt>databaseInstallationFileNames</dt> <dd> <p>Ordered list of installation files for the CEV.</p> </dd> <dt>opatchFileNames</dt> <dd> <p>Ordered list of OPatch installers used for the Oracle DB engine.</p> </dd> <dt>psuRuPatchFileNames</dt> <dd> <p>The PSU and RU patches for this CEV.</p> </dd> <dt>OtherPatchFileNames</dt> <dd> <p>The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. </p> </dd> </dl> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest\"> Creating the CEV manifest</a> in the <i>Amazon RDS User Guide</i>.</p>"
+ "documentation":"<p>The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.</p> <p>The following JSON fields are valid:</p> <dl> <dt>MediaImportTemplateVersion</dt> <dd> <p>Version of the CEV manifest. The date is in the format <code>YYYY-MM-DD</code>.</p> </dd> <dt>databaseInstallationFileNames</dt> <dd> <p>Ordered list of installation files for the CEV.</p> </dd> <dt>opatchFileNames</dt> <dd> <p>Ordered list of OPatch installers used for the Oracle DB engine.</p> </dd> <dt>psuRuPatchFileNames</dt> <dd> <p>The PSU and RU patches for this CEV.</p> </dd> <dt>OtherPatchFileNames</dt> <dd> <p>The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.</p> </dd> </dl> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest\"> Creating the CEV manifest</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"Tags":{"shape":"TagList"}
}
@@ -3446,7 +3446,7 @@
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
- "documentation":"<p>A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. </p> <p>For information on Amazon Web Services Regions and Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html\">Choosing the Regions and Availability Zones</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.</p> <p>For information on Amazon Web Services Regions and Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html\">Choosing the Regions and Availability Zones</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
@@ -3466,7 +3466,7 @@
},
"DBClusterParameterGroupName":{
"shape":"String",
- "documentation":"<p> The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DB cluster parameter group.</p> </li> </ul> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DB cluster parameter group.</p> </li> </ul> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
@@ -3482,11 +3482,11 @@
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p>The version number of the database engine to use.</p> <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html\">MySQL on Amazon RDS Versions</a> in the <i>Amazon Aurora User Guide.</i> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html\">Amazon Aurora PostgreSQL releases and engine versions</a> in the <i>Amazon Aurora User Guide.</i> </p> <p> <b>MySQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt\">MySQL on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>PostgreSQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts\">Amazon RDS for PostgreSQL versions and extensions</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The version number of the database engine to use.</p> <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html\">MySQL on Amazon RDS Versions</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html\">Amazon Aurora PostgreSQL releases and engine versions</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>MySQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt\">MySQL on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>PostgreSQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts\">Amazon RDS for PostgreSQL versions and extensions</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Port":{
"shape":"IntegerOptional",
- "documentation":"<p>The port number on which the instances in the DB cluster accept connections.</p> <p> <b>RDS for MySQL and Aurora MySQL</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p> <b>RDS for PostgreSQL and Aurora PostgreSQL</b> </p> <p> Default: <code>5432</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The port number on which the instances in the DB cluster accept connections.</p> <p> <b>RDS for MySQL and Aurora MySQL</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p> <b>RDS for PostgreSQL and Aurora PostgreSQL</b> </p> <p>Default: <code>5432</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"MasterUsername":{
"shape":"String",
@@ -3502,11 +3502,11 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow\"> Backup window</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow\"> Backup window</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
- "documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora\"> Adjusting the Preferred DB Cluster Maintenance Window</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora\"> Adjusting the Preferred DB Cluster Maintenance Window</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"ReplicationSourceIdentifier":{
"shape":"String",
@@ -3522,7 +3522,7 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB cluster.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p> <p>When a KMS key isn't specified in <code>KmsKeyId</code>:</p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is enabled and <code>ReplicationSourceIdentifier</code> isn't specified, then Amazon RDS will use your default KMS key.</p> </li> </ul> <p>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p> <p>If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set <code>KmsKeyId</code> to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB cluster.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p> <p>When a KMS key isn't specified in <code>KmsKeyId</code>:</p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.</p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is enabled and <code>ReplicationSourceIdentifier</code> isn't specified, then Amazon RDS will use your default KMS key.</p> </li> </ul> <p>There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p> <p>If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set <code>KmsKeyId</code> to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"PreSignedUrl":{
"shape":"String",
@@ -3530,19 +3530,19 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
- "documentation":"<p>The target backtrack window, in seconds. To disable backtracking, set this value to 0. </p> <p>Default: 0</p> <p>Constraints:</p> <ul> <li> <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p> </li> </ul> <p>Valid for: Aurora MySQL DB clusters only</p>"
+ "documentation":"<p>The target backtrack window, in seconds. To disable backtracking, set this value to 0.</p> <p>Default: 0</p> <p>Constraints:</p> <ul> <li> <p>If specified, this value must be set to a number from 0 to 259,200 (72 hours).</p> </li> </ul> <p>Valid for: Aurora MySQL DB clusters only</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
- "documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"EngineMode":{
"shape":"String",
- "documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p> <p>The <code>parallelquery</code> engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.</p> <p>The <code>global</code> engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and <code>global</code> engine mode isn't required for any 2.x versions.</p> <p>The <code>multimaster</code> engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.</p> <p>For Aurora PostgreSQL, the <code>global</code> engine mode isn't required, and both the <code>parallelquery</code> and the <code>multimaster</code> engine modes currently aren't supported.</p> <p>Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the <i>Amazon Aurora User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations\"> Limitations of Aurora Serverless</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations\"> Limitations of Parallel Query</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations\"> Limitations of Aurora Global Databases</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations\"> Limitations of Multi-Master Clusters</a> </p> </li> </ul> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p> <p>The <code>parallelquery</code> engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.</p> <p>The <code>global</code> engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and <code>global</code> engine mode isn't required for any 2.x versions.</p> <p>The <code>multimaster</code> engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.</p> <p>For Aurora PostgreSQL, the <code>global</code> engine mode isn't required, and both the <code>parallelquery</code> and the <code>multimaster</code> engine modes currently aren't supported.</p> <p>Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the <i>Amazon Aurora User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations\"> Limitations of Aurora Serverless v1</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations\"> Limitations of Parallel Query</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations\"> Limitations of Aurora Global Databases</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations\"> Limitations of Multi-Master Clusters</a> </p> </li> </ul> <p>Valid for: Aurora DB clusters only</p>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
@@ -3554,19 +3554,19 @@
},
"GlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"EnableHttpEndpoint":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Domain":{
"shape":"String",
- "documentation":"<p>The Active Directory directory ID to create the DB cluster in.</p> <p> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The Active Directory directory ID to create the DB cluster in.</p> <p>For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"DomainIAMRoleName":{
"shape":"String",
@@ -3574,11 +3574,11 @@
},
"EnableGlobalWriteForwarding":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (<a>GlobalCluster</a>). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.</p> <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then. </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (<a>GlobalCluster</a>). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.</p> <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"DBClusterInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p> <p>For the full list of DB instance classes and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB instance class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>This setting is required to create a Multi-AZ DB cluster.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p> <p>For the full list of DB instance classes and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB instance class</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting is required to create a Multi-AZ DB cluster.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
@@ -3586,11 +3586,11 @@
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB cluster.</p> <p>This setting is required to create a Multi-AZ DB cluster.</p> <p> Valid values: <code>io1</code> </p> <p> When specified, a value for the <code>Iops</code> parameter is required. </p> <p> Default: <code>io1</code> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB cluster.</p> <p>This setting is required to create a Multi-AZ DB cluster.</p> <p>Valid values: <code>io1</code> </p> <p>When specified, a value for the <code>Iops</code> parameter is required.</p> <p>Default: <code>io1</code> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid <code>Iops</code> values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>This setting is required to create a Multi-AZ DB cluster.</p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid <code>Iops</code> values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting is required to create a Multi-AZ DB cluster.</p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
@@ -3610,7 +3610,7 @@
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to turn on Performance Insights for the DB cluster. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\"> Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to turn on Performance Insights for the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\"> Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
@@ -3700,7 +3700,7 @@
"members":{
"DBName":{
"shape":"String",
- "documentation":"<p>The meaning of this parameter differs according to the database engine you use.</p> <p> <b>MySQL</b> </p> <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1 to 64 letters or numbers.</p> </li> <li> <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p> </li> <li> <p>Can't be a word reserved by the specified database engine</p> </li> </ul> <p> <b>MariaDB</b> </p> <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1 to 64 letters or numbers.</p> </li> <li> <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p> </li> <li> <p>Can't be a word reserved by the specified database engine</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named <code>postgres</code> is created in the DB instance.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1 to 63 letters, numbers, or underscores.</p> </li> <li> <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p> </li> <li> <p>Can't be a word reserved by the specified database engine</p> </li> </ul> <p> <b>Oracle</b> </p> <p>The Oracle System ID (SID) of the created DB instance. If you specify <code>null</code>, the default value <code>ORCL</code> is used. You can't specify the string NULL, or any other reserved word, for <code>DBName</code>. </p> <p>Default: <code>ORCL</code> </p> <p>Constraints:</p> <ul> <li> <p>Can't be longer than 8 characters</p> </li> </ul> <p> <b>Amazon RDS Custom for Oracle</b> </p> <p>The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is <code>ORCL</code>. </p> <p>Default: <code>ORCL</code> </p> <p>Constraints:</p> <ul> <li> <p>It must contain 1 to 8 alphanumeric characters.</p> </li> <li> <p>It must contain a letter.</p> </li> <li> <p>It can't be a word reserved by the database engine.</p> </li> </ul> <p> <b>Amazon RDS Custom for SQL Server</b> </p> <p>Not applicable. Must be null.</p> <p> <b>SQL Server</b> </p> <p>Not applicable. Must be null.</p> <p> <b>Amazon Aurora MySQL</b> </p> <p>The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>It must contain 1 to 64 alphanumeric characters.</p> </li> <li> <p>It can't be a word reserved by the database engine.</p> </li> </ul> <p> <b>Amazon Aurora PostgreSQL</b> </p> <p>The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named <code>postgres</code> is created in the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>It must contain 1 to 63 alphanumeric characters.</p> </li> <li> <p>It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).</p> </li> <li> <p>It can't be a word reserved by the database engine.</p> </li> </ul>"
+ "documentation":"<p>The meaning of this parameter differs according to the database engine you use.</p> <p> <b>MySQL</b> </p> <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1 to 64 letters or numbers.</p> </li> <li> <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p> </li> <li> <p>Can't be a word reserved by the specified database engine</p> </li> </ul> <p> <b>MariaDB</b> </p> <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1 to 64 letters or numbers.</p> </li> <li> <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p> </li> <li> <p>Can't be a word reserved by the specified database engine</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <p>The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named <code>postgres</code> is created in the DB instance.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1 to 63 letters, numbers, or underscores.</p> </li> <li> <p>Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).</p> </li> <li> <p>Can't be a word reserved by the specified database engine</p> </li> </ul> <p> <b>Oracle</b> </p> <p>The Oracle System ID (SID) of the created DB instance. If you specify <code>null</code>, the default value <code>ORCL</code> is used. You can't specify the string NULL, or any other reserved word, for <code>DBName</code>.</p> <p>Default: <code>ORCL</code> </p> <p>Constraints:</p> <ul> <li> <p>Can't be longer than 8 characters</p> </li> </ul> <p> <b>Amazon RDS Custom for Oracle</b> </p> <p>The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is <code>ORCL</code>.</p> <p>Default: <code>ORCL</code> </p> <p>Constraints:</p> <ul> <li> <p>It must contain 1 to 8 alphanumeric characters.</p> </li> <li> <p>It must contain a letter.</p> </li> <li> <p>It can't be a word reserved by the database engine.</p> </li> </ul> <p> <b>Amazon RDS Custom for SQL Server</b> </p> <p>Not applicable. Must be null.</p> <p> <b>SQL Server</b> </p> <p>Not applicable. Must be null.</p> <p> <b>Amazon Aurora MySQL</b> </p> <p>The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>It must contain 1 to 64 alphanumeric characters.</p> </li> <li> <p>It can't be a word reserved by the database engine.</p> </li> </ul> <p> <b>Amazon Aurora PostgreSQL</b> </p> <p>The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named <code>postgres</code> is created in the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>It must contain 1 to 63 alphanumeric characters.</p> </li> <li> <p>It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).</p> </li> <li> <p>It can't be a word reserved by the database engine.</p> </li> </ul>"
},
"DBInstanceIdentifier":{
"shape":"String",
@@ -3708,19 +3708,19 @@
},
"AllocatedStorage":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of storage in gibibytes (GiB) to allocate for the DB instance.</p> <p>Type: Integer</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.</p> <p> <b>Amazon RDS Custom</b> </p> <p>Constraints to the amount of storage for each storage type are the following: </p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.</p> </li> </ul> <p> <b>MySQL</b> </p> <p>Constraints to the amount of storage for each storage type are the following: </p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p> </li> </ul> <p> <b>MariaDB</b> </p> <p>Constraints to the amount of storage for each storage type are the following: </p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <p>Constraints to the amount of storage for each storage type are the following: </p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p> </li> </ul> <p> <b>Oracle</b> </p> <p>Constraints to the amount of storage for each storage type are the following: </p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 10 to 3072.</p> </li> </ul> <p> <b>SQL Server</b> </p> <p>Constraints to the amount of storage for each storage type are the following: </p> <ul> <li> <p>General Purpose (SSD) storage (gp2):</p> <ul> <li> <p>Enterprise and Standard editions: Must be an integer from 20 to 16384.</p> </li> <li> <p>Web and Express editions: Must be an integer from 20 to 16384.</p> </li> </ul> </li> <li> <p>Provisioned IOPS storage (io1):</p> <ul> <li> <p>Enterprise and Standard editions: Must be an integer from 100 to 16384.</p> </li> <li> <p>Web and Express editions: Must be an integer from 100 to 16384.</p> </li> </ul> </li> <li> <p>Magnetic storage (standard):</p> <ul> <li> <p>Enterprise and Standard editions: Must be an integer from 20 to 1024.</p> </li> <li> <p>Web and Express editions: Must be an integer from 20 to 1024.</p> </li> </ul> </li> </ul>"
+ "documentation":"<p>The amount of storage in gibibytes (GiB) to allocate for the DB instance.</p> <p>Type: Integer</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.</p> <p> <b>Amazon RDS Custom</b> </p> <p>Constraints to the amount of storage for each storage type are the following:</p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.</p> </li> </ul> <p> <b>MySQL</b> </p> <p>Constraints to the amount of storage for each storage type are the following:</p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p> </li> </ul> <p> <b>MariaDB</b> </p> <p>Constraints to the amount of storage for each storage type are the following:</p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <p>Constraints to the amount of storage for each storage type are the following:</p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p> </li> </ul> <p> <b>Oracle</b> </p> <p>Constraints to the amount of storage for each storage type are the following:</p> <ul> <li> <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p> </li> <li> <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p> </li> <li> <p>Magnetic storage (standard): Must be an integer from 10 to 3072.</p> </li> </ul> <p> <b>SQL Server</b> </p> <p>Constraints to the amount of storage for each storage type are the following:</p> <ul> <li> <p>General Purpose (SSD) storage (gp2):</p> <ul> <li> <p>Enterprise and Standard editions: Must be an integer from 20 to 16384.</p> </li> <li> <p>Web and Express editions: Must be an integer from 20 to 16384.</p> </li> </ul> </li> <li> <p>Provisioned IOPS storage (io1):</p> <ul> <li> <p>Enterprise and Standard editions: Must be an integer from 100 to 16384.</p> </li> <li> <p>Web and Express editions: Must be an integer from 100 to 16384.</p> </li> </ul> </li> <li> <p>Magnetic storage (standard):</p> <ul> <li> <p>Enterprise and Standard editions: Must be an integer from 20 to 1024.</p> </li> <li> <p>Web and Express editions: Must be an integer from 20 to 1024.</p> </li> </ul> </li> </ul>"
},
"DBInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"Engine":{
"shape":"String",
- "documentation":"<p>The name of the database engine to be used for this instance. </p> <p>Not every database engine is available for every Amazon Web Services Region. </p> <p>Valid Values: </p> <ul> <li> <p> <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p> </li> <li> <p> <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>custom-oracle-ee (for RDS Custom for Oracle instances)</code> </p> </li> <li> <p> <code>custom-sqlserver-ee (for RDS Custom for SQL Server instances)</code> </p> </li> <li> <p> <code>custom-sqlserver-se (for RDS Custom for SQL Server instances)</code> </p> </li> <li> <p> <code>custom-sqlserver-web (for RDS Custom for SQL Server instances)</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>The name of the database engine to be used for this instance.</p> <p>Not every database engine is available for every Amazon Web Services Region.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p> </li> <li> <p> <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>custom-oracle-ee (for RDS Custom for Oracle instances)</code> </p> </li> <li> <p> <code>custom-sqlserver-ee (for RDS Custom for SQL Server instances)</code> </p> </li> <li> <p> <code>custom-sqlserver-se (for RDS Custom for SQL Server instances)</code> </p> </li> <li> <p> <code>custom-sqlserver-web (for RDS Custom for SQL Server instances)</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"MasterUsername":{
"shape":"String",
- "documentation":"<p>The name for the master user.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The name for the master user is managed by the DB cluster. </p> <p> <b>Amazon RDS</b> </p> <p>Constraints:</p> <ul> <li> <p>Required.</p> </li> <li> <p>Must be 1 to 16 letters, numbers, or underscores.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't be a reserved word for the chosen database engine.</p> </li> </ul>"
+ "documentation":"<p>The name for the master user.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The name for the master user is managed by the DB cluster.</p> <p> <b>Amazon RDS</b> </p> <p>Constraints:</p> <ul> <li> <p>Required.</p> </li> <li> <p>Must be 1 to 16 letters, numbers, or underscores.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't be a reserved word for the chosen database engine.</p> </li> </ul>"
},
"MasterUserPassword":{
"shape":"String",
@@ -3736,7 +3736,7 @@
},
"AvailabilityZone":{
"shape":"String",
- "documentation":"<p> The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html\">Regions and Availability Zones</a>. </p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Availability Zones are managed by the DB cluster. </p> <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p> <p> Example: <code>us-east-1d</code> </p> <p> Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint. </p> <note> <p>If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.</p> <p>For more information about RDS on VMware, see the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html\"> RDS on VMware User Guide.</a> </p> </note>"
+ "documentation":"<p>The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html\">Regions and Availability Zones</a>.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Availability Zones are managed by the DB cluster.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p> <p>Example: <code>us-east-1d</code> </p> <p>Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.</p> <note> <p>If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.</p> <p>For more information about RDS on VMware, see the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html\"> RDS on VMware User Guide.</a> </p> </note>"
},
"DBSubnetGroupName":{
"shape":"String",
@@ -3744,7 +3744,7 @@
},
"PreferredMaintenanceWindow":{
"shape":"String",
- "documentation":"<p>The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance\">Amazon RDS Maintenance Window</a>. </p> <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. </p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p>"
+ "documentation":"<p>The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance\">Amazon RDS Maintenance Window</a>.</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.</p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p>"
},
"DBParameterGroupName":{
"shape":"String",
@@ -3756,11 +3756,11 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow\">Backup window</a> in the <i>Amazon RDS User Guide</i>. </p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The daily time range for creating automated backups is managed by the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
+ "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow\">Backup window</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The daily time range for creating automated backups is managed by the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"Port":{
"shape":"IntegerOptional",
- "documentation":"<p>The port number on which the database accepts connections.</p> <p> <b>MySQL</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>MariaDB</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>PostgreSQL</b> </p> <p> Default: <code>5432</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>Oracle</b> </p> <p> Default: <code>1521</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p> <b>SQL Server</b> </p> <p> Default: <code>1433</code> </p> <p> Valid values: <code>1150-65535</code> except <code>1234</code>, <code>1434</code>, <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, and <code>49152-49156</code>.</p> <p> <b>Amazon Aurora</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p>"
+ "documentation":"<p>The port number on which the database accepts connections.</p> <p> <b>MySQL</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>MariaDB</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>PostgreSQL</b> </p> <p>Default: <code>5432</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>Oracle</b> </p> <p>Default: <code>1521</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p> <b>SQL Server</b> </p> <p>Default: <code>1433</code> </p> <p>Valid values: <code>1150-65535</code> except <code>1234</code>, <code>1434</code>, <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, and <code>49152-49156</code>.</p> <p> <b>Amazon Aurora</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p>"
},
"MultiAZ":{
"shape":"BooleanOptional",
@@ -3768,7 +3768,7 @@
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p>The version number of the database engine to use.</p> <p>For a list of valid engine versions, use the <code>DescribeDBEngineVersions</code> action.</p> <p>The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.</p> <p> <b>Amazon RDS Custom for Oracle</b> </p> <p>A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: <code>19.<i>customized_string</i> </code>. An example identifier is <code>19.my_cev1</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create\"> Creating an RDS Custom for Oracle DB instance</a> in the <i>Amazon RDS User Guide.</i>.</p> <p> <b>Amazon RDS Custom for SQL Server</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.reqsMS\">RDS Custom for SQL Server general requirements</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>MariaDB</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt\">MariaDB on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>Microsoft SQL Server</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport\">Microsoft SQL Server Versions on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>MySQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt\">MySQL on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>Oracle</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html\">Oracle Database Engine Release Notes</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>PostgreSQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts\">Amazon RDS for PostgreSQL versions and extensions</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>The version number of the database engine to use.</p> <p>For a list of valid engine versions, use the <code>DescribeDBEngineVersions</code> action.</p> <p>The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.</p> <p> <b>Amazon RDS Custom for Oracle</b> </p> <p>A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: <code>19.<i>customized_string</i> </code>. An example identifier is <code>19.my_cev1</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create\"> Creating an RDS Custom for Oracle DB instance</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>Amazon RDS Custom for SQL Server</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.reqsMS\">RDS Custom for SQL Server general requirements</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>MariaDB</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt\">MariaDB on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>Microsoft SQL Server</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport\">Microsoft SQL Server Versions on Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>MySQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt\">MySQL on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>Oracle</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html\">Oracle Database Engine Release Notes</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>PostgreSQL</b> </p> <p>For information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts\">Amazon RDS for PostgreSQL versions and extensions</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@@ -3776,11 +3776,11 @@
},
"LicenseModel":{
"shape":"String",
- "documentation":"<p>License model information for this DB instance.</p> <p> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>License model information for this DB instance.</p> <p>Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid <code>Iops</code> values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance. </p>"
+ "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid <code>Iops</code> values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.</p>"
},
"OptionGroupName":{
"shape":"String",
@@ -3808,7 +3808,7 @@
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p> Valid values: <code>standard | gp2 | io1</code> </p> <p> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </p> <p> Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p>Valid values: <code>standard | gp2 | io1</code> </p> <p>If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter.</p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
},
"TdeCredentialArn":{
"shape":"String",
@@ -3848,19 +3848,19 @@
},
"PromotionTier":{
"shape":"IntegerOptional",
- "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>. </p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: 1</p> <p>Valid Values: 0 - 15</p>"
+ "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: 1</p> <p>Valid Values: 0 - 15</p>"
},
"Timezone":{
"shape":"String",
- "documentation":"<p>The time zone of the DB instance. The time zone parameter is currently supported only by <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone\">Microsoft SQL Server</a>. </p>"
+ "documentation":"<p>The time zone of the DB instance. The time zone parameter is currently supported only by <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone\">Microsoft SQL Server</a>.</p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable Performance Insights for the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon Relational Database Service User Guide</i>. </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether to enable Performance Insights for the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
@@ -3872,7 +3872,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
- "documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Relational Database Service User Guide</i>.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. CloudWatch Logs exports are managed by the DB cluster. </p> <p> <b>RDS Custom</b> </p> <p>Not applicable. </p> <p> <b>MariaDB</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>. </p> <p> <b>Microsoft SQL Server</b> </p> <p>Possible values are <code>agent</code> and <code>error</code>. </p> <p> <b>MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>. </p> <p> <b>Oracle</b> </p> <p>Possible values are <code>alert</code>, <code>audit</code>, <code>listener</code>, <code>trace</code>, and <code>oemagent</code>. </p> <p> <b>PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>. </p>"
+ "documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\"> Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. CloudWatch Logs exports are managed by the DB cluster.</p> <p> <b>RDS Custom</b> </p> <p>Not applicable.</p> <p> <b>MariaDB</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Microsoft SQL Server</b> </p> <p>Possible values are <code>agent</code> and <code>error</code>.</p> <p> <b>MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Oracle</b> </p> <p>Possible values are <code>alert</code>, <code>audit</code>, <code>listener</code>, <code>trace</code>, and <code>oemagent</code>.</p> <p> <b>PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@@ -3880,7 +3880,7 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see <code>CreateDBCluster</code>. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see <code>CreateDBCluster</code>. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.</p>"
},
"MaxAllocatedStorage":{
"shape":"IntegerOptional",
@@ -3892,7 +3892,7 @@
},
"CustomIamInstanceProfile":{
"shape":"String",
- "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon Relational Database Service User Guide</i>.</p> <p>This setting is required for RDS Custom.</p>"
+ "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting is required for RDS Custom.</p>"
},
"BackupTarget":{
"shape":"String",
@@ -3918,11 +3918,11 @@
},
"DBInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Default: Inherits from the source DB instance.</p>"
+ "documentation":"<p>The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Default: Inherits from the source DB instance.</p>"
},
"AvailabilityZone":{
"shape":"String",
- "documentation":"<p>The Availability Zone (AZ) where the read replica will be created.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p> <p> Example: <code>us-east-1d</code> </p>"
+ "documentation":"<p>The Availability Zone (AZ) where the read replica will be created.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p> <p>Example: <code>us-east-1d</code> </p>"
},
"Port":{
"shape":"IntegerOptional",
@@ -3930,7 +3930,7 @@
},
"MultiAZ":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the read replica is in a Multi-AZ deployment. </p> <p>You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.</p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether the read replica is in a Multi-AZ deployment.</p> <p>You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@@ -3959,11 +3959,11 @@
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
- "documentation":"<p> A list of Amazon EC2 VPC security groups to associate with the read replica. </p> <p>This setting doesn't apply to RDS Custom.</p> <p> Default: The default EC2 VPC security group for the DB subnet group's VPC. </p>"
+ "documentation":"<p>A list of Amazon EC2 VPC security groups to associate with the read replica.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: The default EC2 VPC security group for the DB subnet group's VPC.</p>"
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the read replica.</p> <p> Valid values: <code>standard | gp2 | io1</code> </p> <p> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </p> <p> Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
+ "documentation":"<p>Specifies the storage type to be associated with the read replica.</p> <p>Valid values: <code>standard | gp2 | io1</code> </p> <p>If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter.</p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
@@ -3983,15 +3983,15 @@
},
"PreSignedUrl":{
"shape":"String",
- "documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CreateDBInstanceReadReplica</code> API action in the source Amazon Web Services Region that contains the source DB instance. </p> <p>You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify <code>PreSignedUrl</code> when you are creating an encrypted read replica in the same Amazon Web Services Region.</p> <p>The presigned URL must be a valid request for the <code>CreateDBInstanceReadReplica</code> API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: </p> <ul> <li> <p> <code>DestinationRegion</code> - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the <code>CreateDBInstanceReadReplica</code> action is called that contains this presigned URL.</p> <p>For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the <code>CreateDBInstanceReadReplica</code> action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the <code>CreateDBInstanceReadReplica</code> action in the us-west-2 Amazon Web Services Region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 Amazon Web Services Region. </p> </li> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the <code>CreateDBInstanceReadReplica</code> action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. </p> </li> <li> <p> <code>SourceDBInstanceIdentifier</code> - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your <code>SourceDBInstanceIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115</code>. </p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\">Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>. </p> <note> <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.</p> <p> <code>SourceRegion</code> isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-Region read replicas.</p> </note> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CreateDBInstanceReadReplica</code> API action in the source Amazon Web Services Region that contains the source DB instance.</p> <p>You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify <code>PreSignedUrl</code> when you are creating an encrypted read replica in the same Amazon Web Services Region.</p> <p>The presigned URL must be a valid request for the <code>CreateDBInstanceReadReplica</code> API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>DestinationRegion</code> - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the <code>CreateDBInstanceReadReplica</code> action is called that contains this presigned URL.</p> <p>For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the <code>CreateDBInstanceReadReplica</code> action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the <code>CreateDBInstanceReadReplica</code> action in the us-west-2 Amazon Web Services Region. For this example, the <code>DestinationRegion</code> in the presigned URL must be set to the us-east-1 Amazon Web Services Region.</p> </li> <li> <p> <code>KmsKeyId</code> - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the <code>CreateDBInstanceReadReplica</code> action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.</p> </li> <li> <p> <code>SourceDBInstanceIdentifier</code> - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your <code>SourceDBInstanceIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\">Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.</p> <p> <code>SourceRegion</code> isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-Region read replicas.</p> </note> <p>This setting doesn't apply to RDS Custom.</p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable Performance Insights for the read replica.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>. </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether to enable Performance Insights for the read replica.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
@@ -3999,7 +3999,7 @@
},
"PerformanceInsightsRetentionPeriod":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@@ -4015,7 +4015,7 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p>"
},
"Domain":{
"shape":"String",
@@ -4035,7 +4035,7 @@
},
"CustomIamInstanceProfile":{
"shape":"String",
- "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon Relational Database Service User Guide</i>.</p> <p>This setting is required for RDS Custom.</p>"
+ "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting is required for RDS Custom.</p>"
}
}
},
@@ -4292,7 +4292,7 @@
},
"EventCategories":{
"shape":"EventCategoriesList",
- "documentation":"<p> A list of event categories for a particular source type (<code>SourceType</code>) that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html\"> <i>Amazon RDS User Guide</i> </a> or the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html\"> <i>Amazon Aurora User Guide</i> </a>. You can also see this list by using the <code>DescribeEventCategories</code> operation. </p>"
+ "documentation":"<p>A list of event categories for a particular source type (<code>SourceType</code>) that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html\"> <i>Amazon RDS User Guide</i> </a> or the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html\"> <i>Amazon Aurora User Guide</i> </a>. You can also see this list by using the <code>DescribeEventCategories</code> operation.</p>"
},
"SourceIds":{
"shape":"SourceIdsList",
@@ -4300,7 +4300,7 @@
},
"Enabled":{
"shape":"BooleanOptional",
- "documentation":"<p> A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. </p>"
+ "documentation":"<p>A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.</p>"
},
"Tags":{"shape":"TagList"}
},
@@ -4321,7 +4321,7 @@
},
"SourceDBClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.</p>"
},
"Engine":{
"shape":"String",
@@ -4333,15 +4333,15 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p> The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. </p>"
+ "documentation":"<p>The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.</p>"
},
"DatabaseName":{
"shape":"String",
- "documentation":"<p> The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating. </p>"
+ "documentation":"<p>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.</p>"
},
"StorageEncrypted":{
"shape":"BooleanOptional",
- "documentation":"<p> The storage encryption setting for the new global database cluster. </p>"
+ "documentation":"<p>The storage encryption setting for the new global database cluster.</p>"
}
}
},
@@ -4366,7 +4366,7 @@
},
"EngineName":{
"shape":"String",
- "documentation":"<p>Specifies the name of the engine that this option group should be associated with.</p> <p>Valid Values: </p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>Specifies the name of the engine that this option group should be associated with.</p> <p>Valid Values:</p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"MajorEngineVersion":{
"shape":"String",
@@ -4587,7 +4587,7 @@
},
"ReaderEndpoint":{
"shape":"String",
- "documentation":"<p>The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. </p> <p>If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.</p>"
+ "documentation":"<p>The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.</p> <p>If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.</p>"
},
"CustomEndpoints":{
"shape":"StringList",
@@ -4623,7 +4623,7 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p>Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>. </p>"
+ "documentation":"<p>Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
@@ -4699,7 +4699,7 @@
},
"Capacity":{
"shape":"IntegerOptional",
- "documentation":"<p>The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.</p> <p>For more information about Aurora Serverless, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>"
+ "documentation":"<p>The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.</p> <p>For more information about Aurora Serverless v1, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"EngineMode":{
"shape":"String",
@@ -4708,15 +4708,15 @@
"ScalingConfigurationInfo":{"shape":"ScalingConfigurationInfo"},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. </p>"
+ "documentation":"<p>Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.</p>"
},
"HttpEndpointEnabled":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>"
+ "documentation":"<p>A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"ActivityStreamMode":{
"shape":"ActivityStreamMode",
- "documentation":"<p>The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. </p>"
+ "documentation":"<p>The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.</p>"
},
"ActivityStreamStatus":{
"shape":"ActivityStreamStatus",
@@ -4796,7 +4796,7 @@
"documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p> <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>"
}
},
- "documentation":"<p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. </p> <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>, <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>, <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p> <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>, <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> </note>",
+ "documentation":"<p>Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.</p> <p>For an Amazon Aurora DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>PromoteReadReplicaDBCluster</code>, <code>RestoreDBClusterFromS3</code>, <code>RestoreDBClusterFromSnapshot</code>, <code>RestoreDBClusterToPointInTime</code>, <code>StartDBCluster</code>, and <code>StopDBCluster</code>.</p> <p>For a Multi-AZ DB cluster, this data type is used as a response element in the operations <code>CreateDBCluster</code>, <code>DeleteDBCluster</code>, <code>DescribeDBClusters</code>, <code>FailoverDBCluster</code>, <code>ModifyDBCluster</code>, <code>RebootDBCluster</code>, <code>RestoreDBClusterFromSnapshot</code>, and <code>RestoreDBClusterToPointInTime</code>.</p> <p>For more information on Amazon Aurora DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>",
"wrapper":true
},
"DBClusterAlreadyExistsFault":{
@@ -4866,7 +4866,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> <code>BacktrackIdentifier</code> doesn't refer to an existing backtrack. </p>",
+ "documentation":"<p> <code>BacktrackIdentifier</code> doesn't refer to an existing backtrack.</p>",
"error":{
"code":"DBClusterBacktrackNotFoundFault",
"httpStatusCode":404,
@@ -4879,7 +4879,7 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
- "documentation":"<p>A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. </p>"
+ "documentation":"<p>A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.</p>"
},
"PendingCapacity":{
"shape":"IntegerOptional",
@@ -4969,7 +4969,7 @@
"members":{
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBClusterEndpoints":{
"shape":"DBClusterEndpointList",
@@ -5031,7 +5031,7 @@
},
"PromotionTier":{
"shape":"IntegerOptional",
- "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>. </p>"
+ "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information about an instance that is part of a DB cluster.</p>",
@@ -5062,7 +5062,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster. </p>",
+ "documentation":"<p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>",
"error":{
"code":"DBClusterNotFoundFault",
"httpStatusCode":404,
@@ -5111,7 +5111,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster parameter group.</p>"
}
},
- "documentation":"<p>Contains the details of an Amazon RDS DB cluster parameter group. </p> <p>This data type is used as a response element in the <code>DescribeDBClusterParameterGroups</code> action. </p>",
+ "documentation":"<p>Contains the details of an Amazon RDS DB cluster parameter group.</p> <p>This data type is used as a response element in the <code>DescribeDBClusterParameterGroups</code> action.</p>",
"wrapper":true
},
"DBClusterParameterGroupDetails":{
@@ -5123,7 +5123,7 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous DescribeDBClusterParameters 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>An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> 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>Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.</p>"
@@ -5149,7 +5149,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB cluster parameter group. </p>",
+ "documentation":"<p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB cluster parameter group.</p>",
"error":{
"code":"DBClusterParameterGroupNotFound",
"httpStatusCode":404,
@@ -5162,7 +5162,7 @@
"members":{
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBClusterParameterGroups":{
"shape":"DBClusterParameterGroupList",
@@ -5196,7 +5196,7 @@
},
"FeatureName":{
"shape":"String",
- "documentation":"<p>The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see <a>DBEngineVersion</a>. </p>"
+ "documentation":"<p>The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see <a>DBEngineVersion</a>.</p>"
}
},
"documentation":"<p>Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.</p>"
@@ -5333,7 +5333,7 @@
},
"TagList":{"shape":"TagList"}
},
- "documentation":"<p>Contains the details for an Amazon RDS DB cluster snapshot </p> <p>This data type is used as a response element in the <code>DescribeDBClusterSnapshots</code> action. </p>",
+ "documentation":"<p>Contains the details for an Amazon RDS DB cluster snapshot</p> <p>This data type is used as a response element in the <code>DescribeDBClusterSnapshots</code> action.</p>",
"wrapper":true
},
"DBClusterSnapshotAlreadyExistsFault":{
@@ -5396,20 +5396,20 @@
"members":{
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBClusterSnapshots":{
"shape":"DBClusterSnapshotList",
"documentation":"<p>Provides a list of DB cluster snapshots for the user.</p>"
}
},
- "documentation":"<p> Provides a list of DB cluster snapshots for the user as the result of a call to the <code>DescribeDBClusterSnapshots</code> action. </p>"
+ "documentation":"<p>Provides a list of DB cluster snapshots for the user as the result of a call to the <code>DescribeDBClusterSnapshots</code> action.</p>"
},
"DBClusterSnapshotNotFoundFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot. </p>",
+ "documentation":"<p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>",
"error":{
"code":"DBClusterSnapshotNotFoundFault",
"httpStatusCode":404,
@@ -5442,15 +5442,15 @@
},
"DefaultCharacterSet":{
"shape":"CharacterSet",
- "documentation":"<p> The default character set for new instances of this engine version, if the <code>CharacterSetName</code> parameter of the CreateDBInstance API isn't specified. </p>"
+ "documentation":"<p>The default character set for new instances of this engine version, if the <code>CharacterSetName</code> parameter of the CreateDBInstance API isn't specified.</p>"
},
"SupportedCharacterSets":{
"shape":"SupportedCharacterSetsList",
- "documentation":"<p>A list of the character sets supported by this engine for the <code>CharacterSetName</code> parameter of the <code>CreateDBInstance</code> operation. </p>"
+ "documentation":"<p>A list of the character sets supported by this engine for the <code>CharacterSetName</code> parameter of the <code>CreateDBInstance</code> operation.</p>"
},
"SupportedNcharCharacterSets":{
"shape":"SupportedCharacterSetsList",
- "documentation":"<p>A list of the character sets supported by the Oracle DB engine for the <code>NcharCharacterSetName</code> parameter of the <code>CreateDBInstance</code> operation. </p>"
+ "documentation":"<p>A list of the character sets supported by the Oracle DB engine for the <code>NcharCharacterSetName</code> parameter of the <code>CreateDBInstance</code> operation.</p>"
},
"ValidUpgradeTarget":{
"shape":"ValidUpgradeTargetList",
@@ -5458,7 +5458,7 @@
},
"SupportedTimezones":{
"shape":"SupportedTimezonesList",
- "documentation":"<p>A list of the time zones supported by this engine for the <code>Timezone</code> parameter of the <code>CreateDBInstance</code> action. </p>"
+ "documentation":"<p>A list of the time zones supported by this engine for the <code>Timezone</code> parameter of the <code>CreateDBInstance</code> action.</p>"
},
"ExportableLogTypes":{
"shape":"LogTypeList",
@@ -5478,7 +5478,7 @@
},
"SupportedFeatureNames":{
"shape":"FeatureNameList",
- "documentation":"<p> A list of features supported by the DB engine. </p> <p>The supported features vary by DB engine and DB engine version.</p> <p>To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine &lt;engine_name&gt; --engine-version &lt;engine_version&gt;</code> </p> <p>For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --engine-version 13.3</code> </p> <p>The supported features are listed under <code>SupportedFeatureNames</code> in the output.</p>"
+ "documentation":"<p>A list of features supported by the DB engine.</p> <p>The supported features vary by DB engine and DB engine version.</p> <p>To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine &lt;engine_name&gt; --engine-version &lt;engine_version&gt;</code> </p> <p>For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --engine-version 13.3</code> </p> <p>The supported features are listed under <code>SupportedFeatureNames</code> in the output.</p>"
},
"Status":{
"shape":"String",
@@ -5516,9 +5516,13 @@
"shape":"TStamp",
"documentation":"<p>The creation time of the DB engine version.</p>"
},
- "TagList":{"shape":"TagList"}
+ "TagList":{"shape":"TagList"},
+ "SupportsBabelfish":{
+ "shape":"Boolean",
+ "documentation":"<p>A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.</p>"
+ }
},
- "documentation":"<p> This data type is used as a response element in the action <code>DescribeDBEngineVersions</code>. </p>"
+ "documentation":"<p>This data type is used as a response element in the action <code>DescribeDBEngineVersions</code>.</p>"
},
"DBEngineVersionList":{
"type":"list",
@@ -5532,14 +5536,14 @@
"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>"
+ "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>"
},
"DBEngineVersions":{
"shape":"DBEngineVersionList",
- "documentation":"<p> A list of <code>DBEngineVersion</code> elements. </p>"
+ "documentation":"<p>A list of <code>DBEngineVersion</code> elements.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBEngineVersions</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBEngineVersions</code> action.</p>"
},
"DBInstance":{
"type":"structure",
@@ -5586,7 +5590,7 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p> Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>. </p>"
+ "documentation":"<p>Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.</p>"
},
"BackupRetentionPeriod":{
"shape":"Integer",
@@ -5594,7 +5598,7 @@
},
"DBSecurityGroups":{
"shape":"DBSecurityGroupMembershipList",
- "documentation":"<p> A list of DB security group elements containing <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements. </p>"
+ "documentation":"<p>A list of DB security group elements containing <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.</p>"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
@@ -5670,7 +5674,7 @@
},
"NcharCharacterSetName":{
"shape":"String",
- "documentation":"<p>The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. </p>"
+ "documentation":"<p>The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.</p>"
},
"SecondaryAvailabilityZone":{
"shape":"String",
@@ -5706,7 +5710,7 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p> If <code>StorageEncrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB instance. </p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"
+ "documentation":"<p>If <code>StorageEncrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"
},
"DbiResourceId":{
"shape":"String",
@@ -5738,7 +5742,7 @@
},
"PromotionTier":{
"shape":"IntegerOptional",
- "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>. </p>"
+ "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"DBInstanceArn":{
"shape":"String",
@@ -5746,7 +5750,7 @@
},
"Timezone":{
"shape":"String",
- "documentation":"<p>The time zone of the DB instance. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. </p>"
+ "documentation":"<p>The time zone of the DB instance. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.</p>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
@@ -5762,7 +5766,7 @@
},
"PerformanceInsightsRetentionPeriod":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). </p>"
+ "documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
@@ -5774,11 +5778,11 @@
},
"DeletionProtection":{
"shape":"Boolean",
- "documentation":"<p>Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
+ "documentation":"<p>Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p>"
},
"AssociatedRoles":{
"shape":"DBInstanceRoles",
- "documentation":"<p> The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. </p>"
+ "documentation":"<p>The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.</p>"
},
"ListenerEndpoint":{
"shape":"Endpoint",
@@ -5827,18 +5831,18 @@
},
"ResumeFullAutomationModeTime":{
"shape":"TStamp",
- "documentation":"<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. </p>"
+ "documentation":"<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.</p>"
},
"CustomIamInstanceProfile":{
"shape":"String",
- "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
+ "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"BackupTarget":{
"shape":"String",
"documentation":"<p>Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>"
}
},
- "documentation":"<p>Contains the details of an Amazon RDS DB instance. </p> <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>, <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>, <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>, <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>, <code>StartDBInstance</code>, and <code>StopDBInstance</code>. </p>",
+ "documentation":"<p>Contains the details of an Amazon RDS DB instance.</p> <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>, <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>, <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>, <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>, <code>StartDBInstance</code>, and <code>StopDBInstance</code>.</p>",
"wrapper":true
},
"DBInstanceAlreadyExistsFault":{
@@ -5870,7 +5874,7 @@
},
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p>The customer id of the instance that is/was associated with the automated backup. </p>"
+ "documentation":"<p>The customer id of the instance that is/was associated with the automated backup.</p>"
},
"RestoreWindow":{
"shape":"RestoreWindow",
@@ -5898,7 +5902,7 @@
},
"InstanceCreateTime":{
"shape":"TStamp",
- "documentation":"<p>Provides the date and time that the DB instance was created. </p>"
+ "documentation":"<p>Provides the date and time that the DB instance was created.</p>"
},
"MasterUsername":{
"shape":"String",
@@ -5918,7 +5922,7 @@
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The IOPS (I/O operations per second) value for the automated backup. </p>"
+ "documentation":"<p>The IOPS (I/O operations per second) value for the automated backup.</p>"
},
"OptionGroupName":{
"shape":"String",
@@ -5980,14 +5984,14 @@
"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>"
+ "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>"
},
"DBInstanceAutomatedBackups":{
"shape":"DBInstanceAutomatedBackupList",
- "documentation":"<p> A list of <code>DBInstanceAutomatedBackup</code> instances. </p>"
+ "documentation":"<p>A list of <code>DBInstanceAutomatedBackup</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBInstanceAutomatedBackups</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBInstanceAutomatedBackups</code> action.</p>"
},
"DBInstanceAutomatedBackupNotFoundFault":{
"type":"structure",
@@ -6042,20 +6046,20 @@
"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>"
+ "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>"
},
"DBInstances":{
"shape":"DBInstanceList",
- "documentation":"<p> A list of <code>DBInstance</code> instances. </p>"
+ "documentation":"<p>A list of <code>DBInstance</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBInstances</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBInstances</code> action.</p>"
},
"DBInstanceNotFoundFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance. </p>",
+ "documentation":"<p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>",
"error":{
"code":"DBInstanceNotFound",
"httpStatusCode":404,
@@ -6072,7 +6076,7 @@
},
"FeatureName":{
"shape":"String",
- "documentation":"<p>The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see <code>DBEngineVersion</code>. </p>"
+ "documentation":"<p>The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see <code>DBEngineVersion</code>.</p>"
},
"Status":{
"shape":"String",
@@ -6185,7 +6189,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) for the DB parameter group.</p>"
}
},
- "documentation":"<p>Contains the details of an Amazon RDS DB parameter group. </p> <p>This data type is used as a response element in the <code>DescribeDBParameterGroups</code> action. </p>",
+ "documentation":"<p>Contains the details of an Amazon RDS DB parameter group.</p> <p>This data type is used as a response element in the <code>DescribeDBParameterGroups</code> action.</p>",
"wrapper":true
},
"DBParameterGroupAlreadyExistsFault":{
@@ -6205,14 +6209,14 @@
"members":{
"Parameters":{
"shape":"ParametersList",
- "documentation":"<p> A list of <code>Parameter</code> values. </p>"
+ "documentation":"<p>A list of <code>Parameter</code> values.</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>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> Contains the result of a successful invocation of the <code>DescribeDBParameters</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBParameters</code> action.</p>"
},
"DBParameterGroupList":{
"type":"list",
@@ -6229,13 +6233,13 @@
"documentation":"<p>The name of the DB parameter group.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>ModifyDBParameterGroup</code> or <code>ResetDBParameterGroup</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>ModifyDBParameterGroup</code> or <code>ResetDBParameterGroup</code> action.</p>"
},
"DBParameterGroupNotFoundFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group. </p>",
+ "documentation":"<p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>",
"error":{
"code":"DBParameterGroupNotFound",
"httpStatusCode":404,
@@ -6281,14 +6285,14 @@
"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>"
+ "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>"
},
"DBParameterGroups":{
"shape":"DBParameterGroupList",
- "documentation":"<p> A list of <code>DBParameterGroup</code> instances. </p>"
+ "documentation":"<p>A list of <code>DBParameterGroup</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBParameterGroups</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBParameterGroups</code> action.</p>"
},
"DBProxy":{
"type":"structure",
@@ -6663,25 +6667,25 @@
},
"EC2SecurityGroups":{
"shape":"EC2SecurityGroupList",
- "documentation":"<p> Contains a list of <code>EC2SecurityGroup</code> elements. </p>"
+ "documentation":"<p>Contains a list of <code>EC2SecurityGroup</code> elements.</p>"
},
"IPRanges":{
"shape":"IPRangeList",
- "documentation":"<p> Contains a list of <code>IPRange</code> elements. </p>"
+ "documentation":"<p>Contains a list of <code>IPRange</code> elements.</p>"
},
"DBSecurityGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB security group.</p>"
}
},
- "documentation":"<p>Contains the details for an Amazon RDS DB security group. </p> <p>This data type is used as a response element in the <code>DescribeDBSecurityGroups</code> action. </p>",
+ "documentation":"<p>Contains the details for an Amazon RDS DB security group.</p> <p>This data type is used as a response element in the <code>DescribeDBSecurityGroups</code> action.</p>",
"wrapper":true
},
"DBSecurityGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> A DB security group with the name specified in <code>DBSecurityGroupName</code> already exists. </p>",
+ "documentation":"<p>A DB security group with the name specified in <code>DBSecurityGroupName</code> already exists.</p>",
"error":{
"code":"DBSecurityGroupAlreadyExists",
"httpStatusCode":400,
@@ -6715,14 +6719,14 @@
"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>"
+ "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>"
},
"DBSecurityGroups":{
"shape":"DBSecurityGroups",
- "documentation":"<p> A list of <code>DBSecurityGroup</code> instances. </p>"
+ "documentation":"<p>A list of <code>DBSecurityGroup</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action.</p>"
},
"DBSecurityGroupNameList":{
"type":"list",
@@ -6735,7 +6739,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group. </p>",
+ "documentation":"<p> <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>",
"error":{
"code":"DBSecurityGroupNotFound",
"httpStatusCode":404,
@@ -6867,7 +6871,7 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p> If <code>Encrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. </p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"
+ "documentation":"<p>If <code>Encrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"
},
"DBSnapshotArn":{
"shape":"String",
@@ -6875,7 +6879,7 @@
},
"Timezone":{
"shape":"String",
- "documentation":"<p>The time zone of the DB snapshot. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. </p>"
+ "documentation":"<p>The time zone of the DB snapshot. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.</p>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
@@ -6899,14 +6903,14 @@
"documentation":"<p>Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>"
}
},
- "documentation":"<p>Contains the details of an Amazon RDS DB snapshot. </p> <p>This data type is used as a response element in the <code>DescribeDBSnapshots</code> action. </p>",
+ "documentation":"<p>Contains the details of an Amazon RDS DB snapshot.</p> <p>This data type is used as a response element in the <code>DescribeDBSnapshots</code> action.</p>",
"wrapper":true
},
"DBSnapshotAlreadyExistsFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBSnapshotIdentifier</code> is already used by an existing snapshot. </p>",
+ "documentation":"<p> <code>DBSnapshotIdentifier</code> is already used by an existing snapshot.</p>",
"error":{
"code":"DBSnapshotAlreadyExists",
"httpStatusCode":400,
@@ -6963,20 +6967,20 @@
"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>"
+ "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>"
},
"DBSnapshots":{
"shape":"DBSnapshotList",
- "documentation":"<p> A list of <code>DBSnapshot</code> instances. </p>"
+ "documentation":"<p>A list of <code>DBSnapshot</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBSnapshots</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBSnapshots</code> action.</p>"
},
"DBSnapshotNotFoundFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot. </p>",
+ "documentation":"<p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>",
"error":{
"code":"DBSnapshotNotFound",
"httpStatusCode":404,
@@ -7005,21 +7009,21 @@
},
"Subnets":{
"shape":"SubnetList",
- "documentation":"<p> Contains a list of <code>Subnet</code> elements. </p>"
+ "documentation":"<p>Contains a list of <code>Subnet</code> elements.</p>"
},
"DBSubnetGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB subnet group.</p>"
}
},
- "documentation":"<p>Contains the details of an Amazon RDS DB subnet group. </p> <p>This data type is used as a response element in the <code>DescribeDBSubnetGroups</code> action. </p>",
+ "documentation":"<p>Contains the details of an Amazon RDS DB subnet group.</p> <p>This data type is used as a response element in the <code>DescribeDBSubnetGroups</code> action.</p>",
"wrapper":true
},
"DBSubnetGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBSubnetGroupName</code> is already used by an existing DB subnet group. </p>",
+ "documentation":"<p> <code>DBSubnetGroupName</code> is already used by an existing DB subnet group.</p>",
"error":{
"code":"DBSubnetGroupAlreadyExists",
"httpStatusCode":400,
@@ -7044,14 +7048,14 @@
"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>"
+ "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>"
},
"DBSubnetGroups":{
"shape":"DBSubnetGroups",
- "documentation":"<p> A list of <code>DBSubnetGroup</code> instances. </p>"
+ "documentation":"<p>A list of <code>DBSubnetGroup</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeDBSubnetGroups</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeDBSubnetGroups</code> action.</p>"
},
"DBSubnetGroupNotAllowedFault":{
"type":"structure",
@@ -7069,7 +7073,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group. </p>",
+ "documentation":"<p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>",
"error":{
"code":"DBSubnetGroupNotFoundFault",
"httpStatusCode":404,
@@ -7177,7 +7181,7 @@
},
"FinalDBSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p> The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is disabled. </p> <note> <p> Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the <code>SkipFinalShapshot</code> parameter results in an error.</p> </note> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
+ "documentation":"<p>The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is disabled.</p> <note> <p>Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the <code>SkipFinalShapshot</code> parameter results in an error.</p> </note> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
}
},
"documentation":"<p/>"
@@ -7250,7 +7254,7 @@
},
"FinalDBSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p> The <code>DBSnapshotIdentifier</code> of the new <code>DBSnapshot</code> created when the <code>SkipFinalSnapshot</code> parameter is disabled. </p> <note> <p>If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.</p> </note> <p>This setting doesn't apply to RDS Custom.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters or numbers.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> <li> <p>Can't be specified when deleting a read replica.</p> </li> </ul>"
+ "documentation":"<p>The <code>DBSnapshotIdentifier</code> of the new <code>DBSnapshot</code> created when the <code>SkipFinalSnapshot</code> parameter is disabled.</p> <note> <p>If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.</p> </note> <p>This setting doesn't apply to RDS Custom.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters or numbers.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> <li> <p>Can't be specified when deleting a read replica.</p> </li> </ul>"
},
"DeleteAutomatedBackups":{
"shape":"BooleanOptional",
@@ -7376,7 +7380,7 @@
"members":{
"GlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The cluster identifier of the global database cluster being deleted. </p>"
+ "documentation":"<p>The cluster identifier of the global database cluster being deleted.</p>"
}
}
},
@@ -7453,11 +7457,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeCertificates</code> 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>An optional pagination token provided by a previous <code>DescribeCertificates</code> 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/>"
@@ -7501,11 +7505,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBClusterBacktracks</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterBacktracks</code> 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/>"
@@ -7523,15 +7527,15 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>. <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>. <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>. <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>. <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>. </p>"
+ "documentation":"<p>A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>. <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>. <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>. <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>. <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.</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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBClusterEndpoints</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
@@ -7548,11 +7552,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBClusterParameterGroups</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> 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/>"
@@ -7567,7 +7571,7 @@
},
"Source":{
"shape":"String",
- "documentation":"<p> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>. </p>"
+ "documentation":"<p>A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>.</p>"
},
"Filters":{
"shape":"FilterList",
@@ -7575,11 +7579,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBClusterParameters</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> 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/>"
@@ -7606,11 +7610,11 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
- "documentation":"<p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter isn't case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBCluster.</p> </li> </ul>"
+ "documentation":"<p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBCluster.</p> </li> </ul>"
},
"DBClusterSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
+ "documentation":"<p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
},
"SnapshotType":{
"shape":"String",
@@ -7622,11 +7626,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBClusterSnapshots</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"IncludeShared":{
"shape":"Boolean",
@@ -7648,15 +7652,15 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>clone-group-id</code> - Accepts clone group identifiers. The results list will only include information about the DB clusters associated with these clone groups.</p> </li> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>domain</code> - Accepts Active Directory directory IDs. The results list will only include information about the DB clusters associated with these domains.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list will only include information about the DB clusters for these engines.</p> </li> </ul>"
+ "documentation":"<p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>clone-group-id</code> - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.</p> </li> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list only includes information about the DB clusters for these engines.</p> </li> </ul>"
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBClusters</code> 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>An optional pagination token provided by a previous <code>DescribeDBClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"IncludeShared":{
"shape":"Boolean",
@@ -7670,7 +7674,7 @@
"members":{
"Engine":{
"shape":"String",
- "documentation":"<p>The database engine to return.</p> <p>Valid Values: </p> <ul> <li> <p> <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p> </li> <li> <p> <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>The database engine to return.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p> </li> <li> <p> <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"EngineVersion":{
"shape":"String",
@@ -7682,15 +7686,15 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>This parameter isn't currently supported.</p>"
+ "documentation":"<p>A filter that specifies one or more DB engine versions to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-parameter-group-family</code> - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list only includes information about the DB engine versions for these engines.</p> </li> <li> <p> <code>engine-mode</code> - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:</p> <ul> <li> <p> <code>global</code> </p> </li> <li> <p> <code>multimaster</code> </p> </li> <li> <p> <code>parallelquery</code> </p> </li> <li> <p> <code>provisioned</code> </p> </li> <li> <p> <code>serverless</code> </p> </li> </ul> </li> <li> <p> <code>engine-version</code> - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.</p> </li> <li> <p> <code>status</code> - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>deprecated</code> </p> </li> </ul> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
- "documentation":"<p> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "documentation":"<p>The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.</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>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>"
},
"DefaultOnly":{
"shape":"Boolean",
@@ -7698,11 +7702,11 @@
},
"ListSupportedCharacterSets":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to list the supported character sets for each engine version.</p> <p>If this parameter is enabled and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version.</p> <p>For RDS Custom, the default is not to list supported character sets. If you set <code>ListSupportedCharacterSets</code> to <code>true</code>, RDS Custom returns no results. </p>"
+ "documentation":"<p>A value that indicates whether to list the supported character sets for each engine version.</p> <p>If this parameter is enabled and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version.</p> <p>For RDS Custom, the default is not to list supported character sets. If you set <code>ListSupportedCharacterSets</code> to <code>true</code>, RDS Custom returns no results.</p>"
},
"ListSupportedTimezones":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to list the supported time zones for each engine version.</p> <p>If this parameter is enabled and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version. </p> <p>For RDS Custom, the default is not to list supported time zones. If you set <code>ListSupportedTimezones</code> to <code>true</code>, RDS Custom returns no results. </p>"
+ "documentation":"<p>A value that indicates whether to list the supported time zones for each engine version.</p> <p>If this parameter is enabled and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version.</p> <p>For RDS Custom, the default is not to list supported time zones. If you set <code>ListSupportedTimezones</code> to <code>true</code>, RDS Custom returns no results.</p>"
},
"IncludeAll":{
"shape":"BooleanOptional",
@@ -7715,11 +7719,11 @@
"members":{
"DbiResourceId":{
"shape":"String",
- "documentation":"<p>The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive. </p>"
+ "documentation":"<p>The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.</p>"
},
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p>(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive. </p>"
+ "documentation":"<p>(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.</p>"
},
"Filters":{
"shape":"FilterList",
@@ -7738,7 +7742,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) of the replicated automated backups, for example, <code>arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE</code>.</p> <p>This setting doesn't apply to RDS Custom.</p>"
}
},
- "documentation":"<p>Parameter input for DescribeDBInstanceAutomatedBackups. </p>"
+ "documentation":"<p>Parameter input for DescribeDBInstanceAutomatedBackups.</p>"
},
"DescribeDBInstancesMessage":{
"type":"structure",
@@ -7749,15 +7753,15 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.</p> </li> <li> <p> <code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.</p> </li> <li> <p> <code>domain</code> - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list will only include information about the DB instances for these engines.</p> </li> </ul>"
+ "documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.</p> </li> <li> <p> <code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.</p> </li> <li> <p> <code>domain</code> - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list only includes information about the DB instances for these engines.</p> </li> </ul>"
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBInstances</code> 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>An optional pagination token provided by a previous <code>DescribeDBInstances</code> 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/>"
@@ -7831,10 +7835,10 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p>A pagination token that can be used in a later DescribeDBLogFiles request.</p>"
+ "documentation":"<p>A pagination token that can be used in a later <code>DescribeDBLogFiles</code> request.</p>"
}
},
- "documentation":"<p> The response from a call to <code>DescribeDBLogFiles</code>. </p>"
+ "documentation":"<p>The response from a call to <code>DescribeDBLogFiles</code>.</p>"
},
"DescribeDBParameterGroupsMessage":{
"type":"structure",
@@ -7849,11 +7853,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBParameterGroups</code> 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>An optional pagination token provided by a previous <code>DescribeDBParameterGroups</code> 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/>"
@@ -7876,11 +7880,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBParameters</code> 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>An optional pagination token provided by a previous <code>DescribeDBParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
@@ -7897,11 +7901,11 @@
},
"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>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>"
},
"MaxRecords":{
"shape":"MaxRecords",
- "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>"
+ "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>"
}
}
},
@@ -7914,7 +7918,7 @@
},
"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>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>"
}
}
},
@@ -7935,11 +7939,11 @@
},
"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>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>"
},
"MaxRecords":{
"shape":"MaxRecords",
- "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>"
+ "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>"
}
}
},
@@ -7952,7 +7956,7 @@
},
"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>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>"
}
}
},
@@ -7974,11 +7978,11 @@
},
"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>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>"
},
"MaxRecords":{
"shape":"MaxRecords",
- "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>"
+ "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>"
}
}
},
@@ -7991,7 +7995,7 @@
},
"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>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>"
}
}
},
@@ -8013,11 +8017,11 @@
},
"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>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>"
},
"MaxRecords":{
"shape":"MaxRecords",
- "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>"
+ "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>"
}
}
},
@@ -8030,7 +8034,7 @@
},
"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>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>"
}
}
},
@@ -8047,11 +8051,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBSecurityGroups</code> 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>An optional pagination token provided by a previous <code>DescribeDBSecurityGroups</code> 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/>"
@@ -8078,11 +8082,11 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p>The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with <code>DBSnapshotIdentifier</code>. This parameter isn't case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBInstance.</p> </li> </ul>"
+ "documentation":"<p>The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with <code>DBSnapshotIdentifier</code>. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBInstance.</p> </li> </ul>"
},
"DBSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p> A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with <code>DBInstanceIdentifier</code>. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBSnapshot.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
+ "documentation":"<p>A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with <code>DBInstanceIdentifier</code>. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBSnapshot.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
},
"SnapshotType":{
"shape":"String",
@@ -8094,11 +8098,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeDBSnapshots</code> 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>An optional pagination token provided by a previous <code>DescribeDBSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"IncludeShared":{
"shape":"Boolean",
@@ -8128,11 +8132,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 DescribeDBSubnetGroups 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>An optional pagination token provided by a previous DescribeDBSubnetGroups 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/>"
@@ -8151,11 +8155,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeEngineDefaultClusterParameters</code> 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>An optional pagination token provided by a previous <code>DescribeEngineDefaultClusterParameters</code> 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/>"
@@ -8180,11 +8184,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeEngineDefaultParameters</code> 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>An optional pagination token provided by a previous <code>DescribeEngineDefaultParameters</code> 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/>"
@@ -8222,11 +8226,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 DescribeOrderableDBInstanceOptions 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>An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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/>"
@@ -8244,11 +8248,11 @@
},
"StartTime":{
"shape":"TStamp",
- "documentation":"<p> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <p>Example: 2009-07-08T18:00Z</p>"
+ "documentation":"<p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <p>Example: 2009-07-08T18:00Z</p>"
},
"EndTime":{
"shape":"TStamp",
- "documentation":"<p> The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <p>Example: 2009-07-08T18:00Z</p>"
+ "documentation":"<p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <p>Example: 2009-07-08T18:00Z</p>"
},
"Duration":{
"shape":"IntegerOptional",
@@ -8264,11 +8268,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 DescribeEvents 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>An optional pagination token provided by a previous DescribeEvents 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/>"
@@ -8286,15 +8290,15 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.</p> <p>Supported filters include the following: </p> <ul> <li> <p> <code>export-task-identifier</code> - An identifier for the snapshot export task.</p> </li> <li> <p> <code>s3-bucket</code> - The Amazon S3 bucket the snapshot is exported to.</p> </li> <li> <p> <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3</p> </li> <li> <p> <code>status</code> - The status of the export task. Must be lowercase. Valid statuses are the following:</p> <ul> <li> <p> <code>canceled</code> </p> </li> <li> <p> <code>canceling</code> </p> </li> <li> <p> <code>complete</code> </p> </li> <li> <p> <code>failed</code> </p> </li> <li> <p> <code>in_progress</code> </p> </li> <li> <p> <code>starting</code> </p> </li> </ul> </li> </ul>"
+ "documentation":"<p>Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.</p> <p>Supported filters include the following:</p> <ul> <li> <p> <code>export-task-identifier</code> - An identifier for the snapshot export task.</p> </li> <li> <p> <code>s3-bucket</code> - The Amazon S3 bucket the snapshot is exported to.</p> </li> <li> <p> <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3</p> </li> <li> <p> <code>status</code> - The status of the export task. Must be lowercase. Valid statuses are the following:</p> <ul> <li> <p> <code>canceled</code> </p> </li> <li> <p> <code>canceling</code> </p> </li> <li> <p> <code>complete</code> </p> </li> <li> <p> <code>failed</code> </p> </li> <li> <p> <code>in_progress</code> </p> </li> <li> <p> <code>starting</code> </p> </li> </ul> </li> </ul>"
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribeExportTasks</code> request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. </p>"
+ "documentation":"<p>An optional pagination token provided by a previous <code>DescribeExportTasks</code> request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter.</p>"
},
"MaxRecords":{
"shape":"MaxRecords",
- "documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later <code>DescribeExportTasks</code> request to retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "documentation":"<p>The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later <code>DescribeExportTasks</code> request to retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
}
}
},
@@ -8303,7 +8307,7 @@
"members":{
"GlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DBClusterIdentifier.</p> </li> </ul>"
+ "documentation":"<p>The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DBClusterIdentifier.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
@@ -8311,11 +8315,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 <code>DescribeGlobalClusters</code> 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>An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
@@ -8346,7 +8350,7 @@
"members":{
"EngineName":{
"shape":"String",
- "documentation":"<p>A required parameter. Options available for the given engine name are described.</p> <p>Valid Values: </p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>A required parameter. Options available for the given engine name are described.</p> <p>Valid Values:</p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"MajorEngineVersion":{
"shape":"String",
@@ -8358,7 +8362,7 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
@@ -8380,15 +8384,15 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous DescribeOptionGroups 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>An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"EngineName":{
"shape":"String",
- "documentation":"<p>Filters the list of option groups to only include groups associated with a specific database engine.</p> <p>Valid Values: </p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>Filters the list of option groups to only include groups associated with a specific database engine.</p> <p>Valid Values:</p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"MajorEngineVersion":{
"shape":"String",
@@ -8403,7 +8407,7 @@
"members":{
"Engine":{
"shape":"String",
- "documentation":"<p>The name of the engine to retrieve DB instance options for.</p> <p>Valid Values: </p> <ul> <li> <p> <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p> </li> <li> <p> <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>The name of the engine to retrieve DB instance options for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora</code> (for MySQL 5.6-compatible Aurora)</p> </li> <li> <p> <code>aurora-mysql</code> (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)</p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"EngineVersion":{
"shape":"String",
@@ -8419,7 +8423,7 @@
},
"AvailabilityZoneGroup":{
"shape":"String",
- "documentation":"<p>The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.</p> <p>Omit this parameter to show the available offerings in the specified Amazon Web Services Region.</p> <p> This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.</p> <p>Omit this parameter to show the available offerings in the specified Amazon Web Services Region.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"Vpc":{
"shape":"BooleanOptional",
@@ -8431,11 +8435,11 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</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 DescribeOrderableDBInstanceOptions 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>An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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/>"
@@ -8449,15 +8453,15 @@
},
"Filters":{
"shape":"FilterList",
- "documentation":"<p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>"
+ "documentation":"<p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>"
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. </p>"
+ "documentation":"<p>An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>.</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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
}
},
"documentation":"<p/>"
@@ -8503,11 +8507,11 @@
},
"MaxRecords":{
"shape":"IntegerOptional",
- "documentation":"<p> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "documentation":"<p>The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.</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>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/>"
@@ -8545,11 +8549,11 @@
},
"MaxRecords":{
"shape":"IntegerOptional",
- "documentation":"<p> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "documentation":"<p>The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.</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>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/>"
@@ -8563,7 +8567,7 @@
},
"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 you can retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
+ "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 you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
@@ -8582,7 +8586,7 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p>The customer identifier or the ARN of your DB instance. </p>"
+ "documentation":"<p>The customer identifier or the ARN of your DB instance.</p>"
}
},
"documentation":"<p/>"
@@ -8626,14 +8630,13 @@
"member":{
"shape":"DomainMembership",
"locationName":"DomainMembership"
- },
- "documentation":"<p>List of Active Directory Domain membership records associated with a DB instance or cluster.</p>"
+ }
},
"DomainNotFoundFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>Domain</code> doesn't refer to an existing Active Directory domain. </p>",
+ "documentation":"<p> <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>",
"error":{
"code":"DomainNotFoundFault",
"httpStatusCode":404,
@@ -8673,7 +8676,7 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p>A pagination token that can be used in a later DownloadDBLogFilePortion request.</p>"
+ "documentation":"<p>A pagination token that can be used in a later <code>DownloadDBLogFilePortion</code> request.</p>"
},
"AdditionalDataPending":{
"shape":"Boolean",
@@ -8725,7 +8728,7 @@
},
"EC2SecurityGroupOwnerId":{
"shape":"String",
- "documentation":"<p> Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> field. </p>"
+ "documentation":"<p>Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> field.</p>"
}
},
"documentation":"<p>This data type is used as a response element in the following actions:</p> <ul> <li> <p> <code>AuthorizeDBSecurityGroupIngress</code> </p> </li> <li> <p> <code>DescribeDBSecurityGroups</code> </p> </li> <li> <p> <code>RevokeDBSecurityGroupIngress</code> </p> </li> </ul>"
@@ -8764,14 +8767,14 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous EngineDefaults 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>An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> .</p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>Contains a list of engine default parameters.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeEngineDefaultParameters</code> action. </p>",
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeEngineDefaultParameters</code> action.</p>",
"wrapper":true
},
"EngineFamily":{
@@ -8813,7 +8816,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) for the event.</p>"
}
},
- "documentation":"<p> This data type is used as a response element in the <code>DescribeEvents</code> action. </p>"
+ "documentation":"<p>This data type is used as a response element in the <code>DescribeEvents</code> action.</p>"
},
"EventCategoriesList":{
"type":"list",
@@ -8849,7 +8852,7 @@
"members":{
"EventCategoriesMapList":{
"shape":"EventCategoriesMapList",
- "documentation":"<p>A list of EventCategoriesMap data types.</p>"
+ "documentation":"<p>A list of <code>EventCategoriesMap</code> data types.</p>"
}
},
"documentation":"<p>Data returned from the <code>DescribeEventCategories</code> operation.</p>"
@@ -8932,7 +8935,7 @@
"members":{
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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>An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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",
@@ -8946,21 +8949,21 @@
"members":{
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous Events 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>An optional pagination token provided by a previous Events 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> A list of <code>Event</code> instances. </p>"
+ "documentation":"<p>A list of <code>Event</code> instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeEvents</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeEvents</code> action.</p>"
},
"ExportTask":{
"type":"structure",
"members":{
"ExportTaskIdentifier":{
"shape":"String",
- "documentation":"<p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to. </p>"
+ "documentation":"<p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.</p>"
},
"SourceArn":{
"shape":"String",
@@ -8992,11 +8995,11 @@
},
"IamRoleArn":{
"shape":"String",
- "documentation":"<p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot. </p>"
+ "documentation":"<p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.</p>"
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key. </p>"
+ "documentation":"<p>The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.</p>"
},
"Status":{
"shape":"String",
@@ -9019,7 +9022,7 @@
"documentation":"<p>A warning about the snapshot export task.</p>"
}
},
- "documentation":"<p>Contains the details of a snapshot export to Amazon S3. </p> <p>This data type is used as a response element in the <code>DescribeExportTasks</code> action. </p>"
+ "documentation":"<p>Contains the details of a snapshot export to Amazon S3.</p> <p>This data type is used as a response element in the <code>DescribeExportTasks</code> action.</p>"
},
"ExportTaskAlreadyExistsFault":{
"type":"structure",
@@ -9095,11 +9098,11 @@
"members":{
"GlobalClusterIdentifier":{
"shape":"GlobalClusterIdentifier",
- "documentation":"<p>Identifier of the Aurora global database (<a>GlobalCluster</a>) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over. </p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <a>GlobalCluster</a> (Aurora global database).</p> </li> </ul>"
+ "documentation":"<p>Identifier of the Aurora global database (<a>GlobalCluster</a>) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <a>GlobalCluster</a> (Aurora global database).</p> </li> </ul>"
},
"TargetDbClusterIdentifier":{
"shape":"DBClusterIdentifier",
- "documentation":"<p>Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (<a>GlobalCluster</a>.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region. </p>"
+ "documentation":"<p>Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (<a>GlobalCluster</a>.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.</p>"
}
}
},
@@ -9114,18 +9117,18 @@
"members":{
"Status":{
"shape":"FailoverStatus",
- "documentation":"<p>The current status of the Aurora global database (<a>GlobalCluster</a>). Possible values are as follows: </p> <ul> <li> <p>pending &#x96; A request to fail over the Aurora global database (<a>GlobalCluster</a>) has been received by the service. The <code>GlobalCluster</code>'s primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.</p> </li> <li> <p>failing-over &#x96; This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas. </p> </li> <li> <p>cancelling &#x96; The request to fail over the Aurora global database (<a>GlobalCluster</a>) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. </p> </li> </ul>"
+ "documentation":"<p>The current status of the Aurora global database (<a>GlobalCluster</a>). Possible values are as follows:</p> <ul> <li> <p>pending &#x96; A request to fail over the Aurora global database (<a>GlobalCluster</a>) has been received by the service. The <code>GlobalCluster</code>'s primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.</p> </li> <li> <p>failing-over &#x96; This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.</p> </li> <li> <p>cancelling &#x96; The request to fail over the Aurora global database (<a>GlobalCluster</a>) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.</p> </li> </ul>"
},
"FromDbClusterArn":{
"shape":"String",
- "documentation":"<p>The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.</p>"
},
"ToDbClusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.</p>"
}
},
- "documentation":"<p>Contains the state of scheduled or in-process failover operations on an Aurora global database (<a>GlobalCluster</a>). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database. </p>",
+ "documentation":"<p>Contains the state of scheduled or in-process failover operations on an Aurora global database (<a>GlobalCluster</a>). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.</p>",
"wrapper":true
},
"FailoverStatus":{
@@ -9177,11 +9180,11 @@
"members":{
"GlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. </p>"
+ "documentation":"<p>Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.</p>"
},
"GlobalClusterResourceId":{
"shape":"String",
- "documentation":"<p> The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed. </p>"
+ "documentation":"<p>The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.</p>"
},
"GlobalClusterArn":{
"shape":"String",
@@ -9193,7 +9196,7 @@
},
"Engine":{
"shape":"String",
- "documentation":"<p> The Aurora database engine used by the global database cluster. </p>"
+ "documentation":"<p>The Aurora database engine used by the global database cluster.</p>"
},
"EngineVersion":{
"shape":"String",
@@ -9201,23 +9204,23 @@
},
"DatabaseName":{
"shape":"String",
- "documentation":"<p> The default database name within the new global database cluster. </p>"
+ "documentation":"<p>The default database name within the new global database cluster.</p>"
},
"StorageEncrypted":{
"shape":"BooleanOptional",
- "documentation":"<p> The storage encryption setting for the global database cluster. </p>"
+ "documentation":"<p>The storage encryption setting for the global database cluster.</p>"
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p> The deletion protection setting for the new global database cluster. </p>"
+ "documentation":"<p>The deletion protection setting for the new global database cluster.</p>"
},
"GlobalClusterMembers":{
"shape":"GlobalClusterMemberList",
- "documentation":"<p> The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item. </p>"
+ "documentation":"<p>The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.</p>"
},
"FailoverState":{
"shape":"FailoverState",
- "documentation":"<p>A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the <a>FailoverGlobalCluster</a> API operation has been called on this Aurora global database (<a>GlobalCluster</a>). </p>"
+ "documentation":"<p>A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the <a>FailoverGlobalCluster</a> API operation has been called on this Aurora global database (<a>GlobalCluster</a>).</p>"
}
},
"documentation":"<p>A data type representing an Aurora global database.</p>",
@@ -9253,22 +9256,22 @@
"members":{
"DBClusterArn":{
"shape":"String",
- "documentation":"<p> The Amazon Resource Name (ARN) for each Aurora cluster. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) for each Aurora cluster.</p>"
},
"Readers":{
"shape":"ReadersArnList",
- "documentation":"<p> The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.</p>"
},
"IsWriter":{
"shape":"Boolean",
- "documentation":"<p> Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated. </p>"
+ "documentation":"<p>Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.</p>"
},
"GlobalWriteForwardingStatus":{
"shape":"WriteForwardingStatus",
"documentation":"<p>Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.</p>"
}
},
- "documentation":"<p> A data structure with information about any primary and secondary clusters associated with an Aurora global database. </p>",
+ "documentation":"<p>A data structure with information about any primary and secondary clusters associated with an Aurora global database.</p>",
"wrapper":true
},
"GlobalClusterMemberList":{
@@ -9282,7 +9285,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster. </p>",
+ "documentation":"<p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>",
"error":{
"code":"GlobalClusterNotFoundFault",
"httpStatusCode":404,
@@ -9307,11 +9310,11 @@
"members":{
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> 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>An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"GlobalClusters":{
"shape":"GlobalClusterList",
- "documentation":"<p> The list of global clusters returned by this request. </p>"
+ "documentation":"<p>The list of global clusters returned by this request.</p>"
}
}
},
@@ -9334,7 +9337,7 @@
"documentation":"<p>Specifies the IP range.</p>"
}
},
- "documentation":"<p> This data type is used as a response element in the <code>DescribeDBSecurityGroups</code> action. </p>"
+ "documentation":"<p>This data type is used as a response element in the <code>DescribeDBSecurityGroups</code> action.</p>"
},
"IPRangeList":{
"type":"list",
@@ -9383,11 +9386,11 @@
},
"Engine":{
"shape":"String",
- "documentation":"<p>The name of the database engine to be used for this instance. </p> <p>The list only includes supported DB engines that require an on-premises customer provided license. </p> <p>Valid Values: </p> <ul> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
+ "documentation":"<p>The name of the database engine to be used for this instance.</p> <p>The list only includes supported DB engines that require an on-premises customer provided license.</p> <p>Valid Values:</p> <ul> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>"
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p>The version number of the database engine to use.</p> <p>For a list of valid engine versions, call <a>DescribeDBEngineVersions</a>.</p> <p>The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.</p> <p> <b>Microsoft SQL Server</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport\"> Microsoft SQL Server Versions on Amazon RDS</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>The version number of the database engine to use.</p> <p>For a list of valid engine versions, call <a>DescribeDBEngineVersions</a>.</p> <p>The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.</p> <p> <b>Microsoft SQL Server</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport\"> Microsoft SQL Server Versions on Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"EngineInstallationMediaPath":{
"shape":"String",
@@ -9617,7 +9620,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>The automated backup is in an invalid state. For example, this automated backup is associated with an active instance. </p>",
+ "documentation":"<p>The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.</p>",
"error":{
"code":"InvalidDBInstanceAutomatedBackupState",
"httpStatusCode":400,
@@ -9725,7 +9728,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> The DB subnet isn't in the <i>available</i> state. </p>",
+ "documentation":"<p>The DB subnet isn't in the <i>available</i> state.</p>",
"error":{
"code":"InvalidDBSubnetStateFault",
"httpStatusCode":400,
@@ -9785,7 +9788,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>The global cluster is in an invalid state and can't perform the requested operation. </p>",
+ "documentation":"<p>The global cluster is in an invalid state and can't perform the requested operation.</p>",
"error":{
"code":"InvalidGlobalClusterStateFault",
"httpStatusCode":400,
@@ -9797,7 +9800,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p> The option group isn't in the <i>available</i> state. </p>",
+ "documentation":"<p>The option group isn't in the <i>available</i> state.</p>",
"error":{
"code":"InvalidOptionGroupStateFault",
"httpStatusCode":400,
@@ -9951,11 +9954,11 @@
},
"Capacity":{
"shape":"IntegerOptional",
- "documentation":"<p>The DB cluster capacity.</p> <p>When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.</p> <p>Constraints:</p> <ul> <li> <p>For Aurora MySQL, valid capacity values are <code>1</code>, <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>128</code>, and <code>256</code>.</p> </li> <li> <p>For Aurora PostgreSQL, valid capacity values are <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>192</code>, and <code>384</code>.</p> </li> </ul>"
+ "documentation":"<p>The DB cluster capacity.</p> <p>When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.</p> <p>Constraints:</p> <ul> <li> <p>For Aurora MySQL, valid capacity values are <code>1</code>, <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>128</code>, and <code>256</code>.</p> </li> <li> <p>For Aurora PostgreSQL, valid capacity values are <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>192</code>, and <code>384</code>.</p> </li> </ul>"
},
"SecondsBeforeTimeout":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.</p> <p>Specify a value between 10 and 600 seconds.</p>"
+ "documentation":"<p>The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.</p> <p>Specify a value between 10 and 600 seconds.</p>"
},
"TimeoutAction":{
"shape":"String",
@@ -9984,7 +9987,7 @@
},
"Status":{
"shape":"CustomEngineVersionStatus",
- "documentation":"<p>The availability status to be assigned to the CEV. Valid values are as follows:</p> <dl> <dt>available</dt> <dd> <p>You can use this CEV to create a new RDS Custom DB instance.</p> </dd> <dt>inactive</dt> <dd> <p>You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.</p> </dd> </dl> <p>You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from <code>available</code> to <code>inactive</code>, and from <code>inactive</code> back to <code>available</code>. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup. </p>"
+ "documentation":"<p>The availability status to be assigned to the CEV. Valid values are as follows:</p> <dl> <dt>available</dt> <dd> <p>You can use this CEV to create a new RDS Custom DB instance.</p> </dd> <dt>inactive</dt> <dd> <p>You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.</p> </dd> </dl> <p>You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from <code>available</code> to <code>inactive</code>, and from <code>inactive</code> back to <code>available</code>. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.</p>"
}
}
},
@@ -10052,15 +10055,15 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow\"> Backup window</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow\"> Backup window</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
- "documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora\"> Adjusting the Preferred DB Cluster Maintenance Window</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora\"> Adjusting the Preferred DB Cluster Maintenance Window</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@@ -10068,7 +10071,7 @@
},
"CloudwatchLogsExportConfiguration":{
"shape":"CloudwatchLogsExportConfiguration",
- "documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\"> Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"EngineVersion":{
"shape":"String",
@@ -10080,11 +10083,11 @@
},
"DBInstanceParameterGroupName":{
"shape":"String",
- "documentation":"<p>The name of the DB parameter group to apply to all instances of the DB cluster. </p> <note> <p>When you apply a parameter group using the <code>DBInstanceParameterGroupName</code> parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.</p> </note> <p>Default: The existing name setting</p> <p>Constraints:</p> <ul> <li> <p>The DB parameter group must be in the same DB parameter group family as this DB cluster.</p> </li> <li> <p>The <code>DBInstanceParameterGroupName</code> parameter is only valid in combination with the <code>AllowMajorVersionUpgrade</code> parameter.</p> </li> </ul> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The name of the DB parameter group to apply to all instances of the DB cluster.</p> <note> <p>When you apply a parameter group using the <code>DBInstanceParameterGroupName</code> parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.</p> </note> <p>Default: The existing name setting</p> <p>Constraints:</p> <ul> <li> <p>The DB parameter group must be in the same DB parameter group family as this DB cluster.</p> </li> <li> <p>The <code>DBInstanceParameterGroupName</code> parameter is valid in combination with the <code>AllowMajorVersionUpgrade</code> parameter for a major version upgrade only.</p> </li> </ul> <p>Valid for: Aurora DB clusters only</p>"
},
"Domain":{
"shape":"String",
- "documentation":"<p>The Active Directory directory ID to move the DB cluster to. Specify <code>none</code> to remove the cluster from its current domain. The domain must be created prior to this operation. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos Authentication</a> in the <i>Amazon Aurora User Guide</i>. </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The Active Directory directory ID to move the DB cluster to. Specify <code>none</code> to remove the cluster from its current domain. The domain must be created prior to this operation.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"DomainIAMRoleName":{
"shape":"String",
@@ -10100,19 +10103,19 @@
},
"EnableHttpEndpoint":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"EnableGlobalWriteForwarding":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (<a>GlobalCluster</a>). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.</p> <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then. </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (<a>GlobalCluster</a>). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.</p> <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"DBClusterInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p> <p>For the full list of DB instance classes and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p> <p>For the full list of DB instance classes and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\"> DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
@@ -10120,11 +10123,11 @@
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB cluster.</p> <p> Valid values: <code>io1</code> </p> <p> When specified, a value for the <code>Iops</code> parameter is required. </p> <p> Default: <code>io1</code> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB cluster.</p> <p>Valid values: <code>io1</code> </p> <p>When specified, a value for the <code>Iops</code> parameter is required.</p> <p>Default: <code>io1</code> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid Iops values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid Iops values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@@ -10140,7 +10143,7 @@
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to turn on Performance Insights for the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\"> Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to turn on Performance Insights for the DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\"> Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
@@ -10219,15 +10222,15 @@
},
"AllocatedStorage":{
"shape":"IntegerOptional",
- "documentation":"<p>The new amount of storage in gibibytes (GiB) to allocate for the DB instance. </p> <p>For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. </p> <p>For the valid values for allocated storage for each engine, see <code>CreateDBInstance</code>. </p>"
+ "documentation":"<p>The new amount of storage in gibibytes (GiB) to allocate for the DB instance.</p> <p>For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</p> <p>For the valid values for allocated storage for each engine, see <code>CreateDBInstance</code>.</p>"
},
"DBInstanceClass":{
"shape":"String",
- "documentation":"<p>The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide</i>. </p> <p>If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless <code>ApplyImmediately</code> is enabled for this request. </p> <p>This setting doesn't apply to RDS Custom for Oracle.</p> <p>Default: Uses existing setting</p>"
+ "documentation":"<p>The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.</p> <p>If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless <code>ApplyImmediately</code> is enabled for this request.</p> <p>This setting doesn't apply to RDS Custom for Oracle.</p> <p>Default: Uses existing setting</p>"
},
"DBSubnetGroupName":{
"shape":"String",
- "documentation":"<p>The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC\">Working with a DB instance in a VPC</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable <code>ApplyImmediately</code>.</p> <p> This parameter doesn't apply to RDS Custom.</p> <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p> <p>Example: <code>mydbsubnetgroup</code> </p>"
+ "documentation":"<p>The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC\">Working with a DB instance in a VPC</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable <code>ApplyImmediately</code>.</p> <p>This parameter doesn't apply to RDS Custom.</p> <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p> <p>Example: <code>mydbsubnetgroup</code> </p>"
},
"DBSecurityGroups":{
"shape":"DBSecurityGroupNameList",
@@ -10239,11 +10242,11 @@
},
"ApplyImmediately":{
"shape":"Boolean",
- "documentation":"<p>A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is disabled.</p> <p> If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html\">Modifying a DB Instance</a> in the <i>Amazon RDS User Guide</i> to see the impact of enabling or disabling <code>ApplyImmediately</code> for each modified parameter and to determine when the changes are applied. </p>"
+ "documentation":"<p>A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. By default, this parameter is disabled.</p> <p>If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to <a>RebootDBInstance</a>, or the next failure reboot. Review the table of parameters in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html\">Modifying a DB Instance</a> in the <i>Amazon RDS User Guide</i> to see the impact of enabling or disabling <code>ApplyImmediately</code> for each modified parameter and to determine when the changes are applied.</p>"
},
"MasterUserPassword":{
"shape":"String",
- "documentation":"<p>The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p> Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. </p> <p>This setting doesn't apply to RDS Custom.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The password for the master user is managed by the DB cluster. For more information, see <code>ModifyDBCluster</code>. </p> <p>Default: Uses existing setting</p> <p> <b>MariaDB</b> </p> <p>Constraints: Must contain from 8 to 41 characters.</p> <p> <b>Microsoft SQL Server</b> </p> <p>Constraints: Must contain from 8 to 128 characters.</p> <p> <b>MySQL</b> </p> <p>Constraints: Must contain from 8 to 41 characters.</p> <p> <b>Oracle</b> </p> <p>Constraints: Must contain from 8 to 30 characters.</p> <p> <b>PostgreSQL</b> </p> <p>Constraints: Must contain from 8 to 128 characters.</p> <note> <p>Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked. </p> </note>"
+ "documentation":"<p>The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p>Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response.</p> <p>This setting doesn't apply to RDS Custom.</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The password for the master user is managed by the DB cluster. For more information, see <code>ModifyDBCluster</code>.</p> <p>Default: Uses existing setting</p> <p> <b>MariaDB</b> </p> <p>Constraints: Must contain from 8 to 41 characters.</p> <p> <b>Microsoft SQL Server</b> </p> <p>Constraints: Must contain from 8 to 128 characters.</p> <p> <b>MySQL</b> </p> <p>Constraints: Must contain from 8 to 41 characters.</p> <p> <b>Oracle</b> </p> <p>Constraints: Must contain from 8 to 30 characters.</p> <p> <b>PostgreSQL</b> </p> <p>Constraints: Must contain from 8 to 128 characters.</p> <note> <p>Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.</p> </note>"
},
"DBParameterGroupName":{
"shape":"String",
@@ -10255,7 +10258,7 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p> The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code> parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow\">Backup window</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <code>ModifyDBCluster</code>.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format hh24:mi-hh24:mi</p> </li> <li> <p>Must be in Universal Time Coordinated (UTC)</p> </li> <li> <p>Must not conflict with the preferred maintenance window</p> </li> <li> <p>Must be at least 30 minutes</p> </li> </ul>"
+ "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code> parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow\">Backup window</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <code>ModifyDBCluster</code>.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format hh24:mi-hh24:mi</p> </li> <li> <p>Must be in Universal Time Coordinated (UTC)</p> </li> <li> <p>Must not conflict with the preferred maintenance window</p> </li> <li> <p>Must be at least 30 minutes</p> </li> </ul>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
@@ -10263,11 +10266,11 @@
},
"MultiAZ":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled for this request. </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled for this request.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p> The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled for this request. </p> <p>For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.</p> <p>If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see <code>CreateDBInstance</code>, or call <code>DescribeDBEngineVersions</code>.</p> <p>In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the <code>PATCH_DB_FAILURE</code> lifecycle. </p>"
+ "documentation":"<p>The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled for this request.</p> <p>For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.</p> <p>If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see <code>CreateDBInstance</code>, or call <code>DescribeDBEngineVersions</code>.</p> <p>In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the <code>PATCH_DB_FAILURE</code> lifecycle.</p>"
},
"AllowMajorVersionUpgrade":{
"shape":"Boolean",
@@ -10283,7 +10286,7 @@
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The new Provisioned IOPS (I/O operations per second) value for the RDS instance. </p> <p>Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. </p> <p>If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance. </p> <p>Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. </p> <p>Default: Uses existing setting</p>"
+ "documentation":"<p>The new Provisioned IOPS (I/O operations per second) value for the RDS instance.</p> <p>Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.</p> <p>If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.</p> <p>Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.</p> <p>Default: Uses existing setting</p>"
},
"OptionGroupName":{
"shape":"String",
@@ -10291,11 +10294,11 @@
},
"NewDBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p>The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable <code>ApplyImmediately</code>, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string. </p> <p>This setting doesn't apply to RDS Custom.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
+ "documentation":"<p>The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable <code>ApplyImmediately</code>, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB instance. </p> <p>If you specify Provisioned IOPS (<code>io1</code>), you must also include a value for the <code>Iops</code> parameter. </p> <p>If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance. </p> <p> Valid values: <code>standard | gp2 | io1</code> </p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p>If you specify Provisioned IOPS (<code>io1</code>), you must also include a value for the <code>Iops</code> parameter.</p> <p>If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.</p> <p>Valid values: <code>standard | gp2 | io1</code> </p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
},
"TdeCredentialArn":{
"shape":"String",
@@ -10323,11 +10326,11 @@
},
"DBPortNumber":{
"shape":"IntegerOptional",
- "documentation":"<p>The port number on which the database accepts connections.</p> <p>The value of the <code>DBPortNumber</code> parameter must not match any of the port values specified for options in the option group for the DB instance.</p> <p>If you change the <code>DBPortNumber</code> value, your database restarts regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>This setting doesn't apply to RDS Custom.</p> <p> <b>MySQL</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p> <b>MariaDB</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p> <b>PostgreSQL</b> </p> <p> Default: <code>5432</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>Oracle</b> </p> <p> Default: <code>1521</code> </p> <p> Valid values: <code>1150-65535</code> </p> <p> <b>SQL Server</b> </p> <p> Default: <code>1433</code> </p> <p> Valid values: <code>1150-65535</code> except <code>1234</code>, <code>1434</code>, <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, and <code>49152-49156</code>.</p> <p> <b>Amazon Aurora</b> </p> <p> Default: <code>3306</code> </p> <p> Valid values: <code>1150-65535</code> </p>"
+ "documentation":"<p>The port number on which the database accepts connections.</p> <p>The value of the <code>DBPortNumber</code> parameter must not match any of the port values specified for options in the option group for the DB instance.</p> <p>If you change the <code>DBPortNumber</code> value, your database restarts regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>This setting doesn't apply to RDS Custom.</p> <p> <b>MySQL</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p> <b>MariaDB</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p> <b>PostgreSQL</b> </p> <p>Default: <code>5432</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p>Type: Integer</p> <p> <b>Oracle</b> </p> <p>Default: <code>1521</code> </p> <p>Valid values: <code>1150-65535</code> </p> <p> <b>SQL Server</b> </p> <p>Default: <code>1433</code> </p> <p>Valid values: <code>1150-65535</code> except <code>1234</code>, <code>1434</code>, <code>3260</code>, <code>3343</code>, <code>3389</code>, <code>47001</code>, and <code>49152-49156</code>.</p> <p> <b>Amazon Aurora</b> </p> <p>Default: <code>3306</code> </p> <p>Valid values: <code>1150-65535</code> </p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance is publicly accessible. </p> <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p> <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p> <p> <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a public subnet and <code>PubliclyAccessible</code> must be enabled for it to be publicly accessible. </p> <p>Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless of the value of the <code>ApplyImmediately</code> parameter.</p>"
+ "documentation":"<p>A value that indicates whether the DB instance is publicly accessible.</p> <p>When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.</p> <p>When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.</p> <p> <code>PubliclyAccessible</code> only applies to DB instances in a VPC. The DB instance must be part of a public subnet and <code>PubliclyAccessible</code> must be enabled for it to be publicly accessible.</p> <p>Changes to the <code>PubliclyAccessible</code> parameter are applied immediately regardless of the value of the <code>ApplyImmediately</code> parameter.</p>"
},
"MonitoringRoleArn":{
"shape":"String",
@@ -10339,7 +10342,7 @@
},
"PromotionTier":{
"shape":"IntegerOptional",
- "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>This setting doesn't apply to RDS Custom. </p> <p>Default: 1</p> <p>Valid Values: 0 - 15</p>"
+ "documentation":"<p>A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance\"> Fault Tolerance for an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: 1</p> <p>Valid Values: 0 - 15</p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
@@ -10347,7 +10350,7 @@
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable Performance Insights for the DB instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon Relational Database Service User Guide</i>. </p> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether to enable Performance Insights for the DB instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide.</i>.</p> <p>This setting doesn't apply to RDS Custom.</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
@@ -10371,7 +10374,7 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p>"
},
"MaxAllocatedStorage":{
"shape":"IntegerOptional",
@@ -10379,7 +10382,7 @@
},
"CertificateRotationRestart":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.</p> <p>By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.</p> <important> <p>Set this parameter only if you are <i>not</i> using SSL/TLS to connect to the DB instance.</p> </important> <p>If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:</p> <ul> <li> <p>For more information about rotating your SSL/TLS certificate for RDS DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate.</a> in the <i>Amazon RDS User Guide.</i> </p> </li> <li> <p>For more information about rotating your SSL/TLS certificate for Aurora DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate</a> in the <i>Amazon Aurora User Guide.</i> </p> </li> </ul> <p>This setting doesn't apply to RDS Custom.</p>"
+ "documentation":"<p>A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.</p> <p>By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.</p> <important> <p>Set this parameter only if you are <i>not</i> using SSL/TLS to connect to the DB instance.</p> </important> <p>If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:</p> <ul> <li> <p>For more information about rotating your SSL/TLS certificate for RDS DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate.</a> in the <i>Amazon RDS User Guide.</i> </p> </li> <li> <p>For more information about rotating your SSL/TLS certificate for Aurora DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> </ul> <p>This setting doesn't apply to RDS Custom.</p>"
},
"ReplicaMode":{
"shape":"ReplicaMode",
@@ -10399,7 +10402,7 @@
},
"ResumeFullAutomationModeMinutes":{
"shape":"IntegerOptional",
- "documentation":"<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is <code>60</code> (default). The maximum value is <code>1,440</code>. </p>"
+ "documentation":"<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is <code>60</code> (default). The maximum value is <code>1,440</code>.</p>"
}
},
"documentation":"<p/>"
@@ -10578,11 +10581,11 @@
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p>The engine version to upgrade the DB snapshot to. </p> <p>The following are the database engines and engine versions that are available when you upgrade a DB snapshot. </p> <p> <b>MySQL</b> </p> <ul> <li> <p> <code>5.5.46</code> (supported for 5.1 DB snapshots)</p> </li> </ul> <p> <b>Oracle</b> </p> <ul> <li> <p> <code>12.1.0.2.v8</code> (supported for 12.1.0.1 DB snapshots)</p> </li> <li> <p> <code>11.2.0.4.v12</code> (supported for 11.2.0.2 DB snapshots)</p> </li> <li> <p> <code>11.2.0.4.v11</code> (supported for 11.2.0.3 DB snapshots)</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <p>For the list of engine versions that are available for upgrading a DB snapshot, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html#USER_UpgradeDBInstance.PostgreSQL.MajorVersion\"> Upgrading the PostgreSQL DB Engine for Amazon RDS</a>. </p>"
+ "documentation":"<p>The engine version to upgrade the DB snapshot to.</p> <p>The following are the database engines and engine versions that are available when you upgrade a DB snapshot.</p> <p> <b>MySQL</b> </p> <ul> <li> <p> <code>5.5.46</code> (supported for 5.1 DB snapshots)</p> </li> </ul> <p> <b>Oracle</b> </p> <ul> <li> <p> <code>12.1.0.2.v8</code> (supported for 12.1.0.1 DB snapshots)</p> </li> <li> <p> <code>11.2.0.4.v12</code> (supported for 11.2.0.2 DB snapshots)</p> </li> <li> <p> <code>11.2.0.4.v11</code> (supported for 11.2.0.3 DB snapshots)</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <p>For the list of engine versions that are available for upgrading a DB snapshot, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.PostgreSQL.html#USER_UpgradeDBInstance.PostgreSQL.MajorVersion\"> Upgrading the PostgreSQL DB Engine for Amazon RDS</a>.</p>"
},
"OptionGroupName":{
"shape":"String",
- "documentation":"<p>The option group to identify with the upgraded DB snapshot. </p> <p>You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG\">Option group considerations</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>The option group to identify with the upgraded DB snapshot.</p> <p>You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG\">Option group considerations</a> in the <i>Amazon RDS User Guide.</i> </p>"
}
}
},
@@ -10601,7 +10604,7 @@
"members":{
"DBSubnetGroupName":{
"shape":"String",
- "documentation":"<p>The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. </p> <p>Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.</p> <p>Example: <code>mydbsubnetgroup</code> </p>"
+ "documentation":"<p>The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.</p> <p>Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.</p> <p>Example: <code>mydbsubnetgroup</code> </p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
@@ -10638,11 +10641,11 @@
},
"EventCategories":{
"shape":"EventCategoriesList",
- "documentation":"<p> A list of event categories for a source type (<code>SourceType</code>) that you want to subscribe to. You can see a list of the categories for a given source type in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> in the <i>Amazon RDS User Guide</i> or by using the <code>DescribeEventCategories</code> operation. </p>"
+ "documentation":"<p>A list of event categories for a source type (<code>SourceType</code>) that you want to subscribe to. You can see a list of the categories for a given source type in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> in the <i>Amazon RDS User Guide</i> or by using the <code>DescribeEventCategories</code> operation.</p>"
},
"Enabled":{
"shape":"BooleanOptional",
- "documentation":"<p> A value that indicates whether to activate the subscription. </p>"
+ "documentation":"<p>A value that indicates whether to activate the subscription.</p>"
}
},
"documentation":"<p/>"
@@ -10658,15 +10661,15 @@
"members":{
"GlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing global database cluster.</p> </li> </ul>"
+ "documentation":"<p>The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing global database cluster.</p> </li> </ul>"
},
"NewGlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens</p> </li> <li> <p>The first character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>"
+ "documentation":"<p>The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens</p> </li> <li> <p>The first character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>"
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p> Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled. </p>"
+ "documentation":"<p>Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.</p>"
},
"EngineVersion":{
"shape":"String",
@@ -10818,11 +10821,11 @@
},
"AllowsVpcAndNonVpcInstanceMemberships":{
"shape":"Boolean",
- "documentation":"<p>Indicates whether this option group can be applied to both VPC and non-VPC instances. The value <code>true</code> indicates the option group can be applied to both VPC and non-VPC instances. </p>"
+ "documentation":"<p>Indicates whether this option group can be applied to both VPC and non-VPC instances. The value <code>true</code> indicates the option group can be applied to both VPC and non-VPC instances.</p>"
},
"VpcId":{
"shape":"String",
- "documentation":"<p>If <b>AllowsVpcAndNonVpcInstanceMemberships</b> is <code>false</code>, this field is blank. If <b>AllowsVpcAndNonVpcInstanceMemberships</b> is <code>true</code> and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. </p>"
+ "documentation":"<p>If <b>AllowsVpcAndNonVpcInstanceMemberships</b> is <code>false</code>, this field is blank. If <b>AllowsVpcAndNonVpcInstanceMemberships</b> is <code>true</code> and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.</p>"
},
"OptionGroupArn":{
"shape":"String",
@@ -10853,7 +10856,7 @@
},
"Status":{
"shape":"String",
- "documentation":"<p>The status of the DB instance's option group membership. Valid values are: <code>in-sync</code>, <code>pending-apply</code>, <code>pending-removal</code>, <code>pending-maintenance-apply</code>, <code>pending-maintenance-removal</code>, <code>applying</code>, <code>removing</code>, and <code>failed</code>. </p>"
+ "documentation":"<p>The status of the DB instance's option group membership. Valid values are: <code>in-sync</code>, <code>pending-apply</code>, <code>pending-removal</code>, <code>pending-maintenance-apply</code>, <code>pending-maintenance-removal</code>, <code>applying</code>, <code>removing</code>, and <code>failed</code>.</p>"
}
},
"documentation":"<p>Provides information on the option groups the DB instance is a member of.</p>"
@@ -10926,15 +10929,15 @@
},
"RequiresAutoMinorEngineVersionUpgrade":{
"shape":"Boolean",
- "documentation":"<p>If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later. </p>"
+ "documentation":"<p>If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.</p>"
},
"VpcOnly":{
"shape":"Boolean",
- "documentation":"<p>If true, you can only use this option with a DB instance that is in a VPC. </p>"
+ "documentation":"<p>If true, you can only use this option with a DB instance that is in a VPC.</p>"
},
"SupportsOptionVersionDowngrade":{
"shape":"BooleanOptional",
- "documentation":"<p>If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available. </p>"
+ "documentation":"<p>If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.</p>"
},
"OptionGroupOptionSettings":{
"shape":"OptionGroupOptionSettingsList",
@@ -11039,7 +11042,7 @@
},
"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>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>List of option groups.</p>"
@@ -11263,10 +11266,10 @@
},
"SupportsClusters":{
"shape":"Boolean",
- "documentation":"<p>Whether DB instances can be configured as a Multi-AZ DB cluster.</p> <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
+ "documentation":"<p>Whether DB instances can be configured as a Multi-AZ DB cluster.</p> <p>For more information on Multi-AZ DB clusters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html\"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"
}
},
- "documentation":"<p>Contains a list of available options for a DB instance.</p> <p> This data type is used as a response element in the <code>DescribeOrderableDBInstanceOptions</code> action. </p>",
+ "documentation":"<p>Contains a list of available options for a DB instance.</p> <p>This data type is used as a response element in the <code>DescribeOrderableDBInstanceOptions</code> action.</p>",
"wrapper":true
},
"OrderableDBInstanceOptionsList":{
@@ -11285,10 +11288,10 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous OrderableDBInstanceOptions 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>An optional pagination token provided by a previous OrderableDBInstanceOptions 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> Contains the result of a successful invocation of the <code>DescribeOrderableDBInstanceOptions</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeOrderableDBInstanceOptions</code> action.</p>"
},
"Outpost":{
"type":"structure",
@@ -11333,7 +11336,7 @@
},
"IsModifiable":{
"shape":"Boolean",
- "documentation":"<p> Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </p>"
+ "documentation":"<p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>"
},
"MinimumEngineVersion":{
"shape":"String",
@@ -11348,7 +11351,7 @@
"documentation":"<p>The valid DB engine modes.</p>"
}
},
- "documentation":"<p> This data type is used as a request parameter in the <code>ModifyDBParameterGroup</code> and <code>ResetDBParameterGroup</code> actions. </p> <p>This data type is used as a response element in the <code>DescribeEngineDefaultParameters</code> and <code>DescribeDBParameters</code> actions.</p>"
+ "documentation":"<p>This data type is used as a request parameter in the <code>ModifyDBParameterGroup</code> and <code>ResetDBParameterGroup</code> actions.</p> <p>This data type is used as a response element in the <code>DescribeEngineDefaultParameters</code> and <code>DescribeDBParameters</code> actions.</p>"
},
"ParametersList":{
"type":"list",
@@ -11424,7 +11427,7 @@
},
"Marker":{
"shape":"String",
- "documentation":"<p> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. </p>"
+ "documentation":"<p>An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Data returned from the <b>DescribePendingMaintenanceActions</b> action.</p>"
@@ -11499,16 +11502,16 @@
},
"ResumeFullAutomationModeTime":{
"shape":"TStamp",
- "documentation":"<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. </p>"
+ "documentation":"<p>The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.</p>"
}
},
- "documentation":"<p> This data type is used as a response element in the <code>ModifyDBInstance</code> operation and contains changes that will be applied during the next maintenance window. </p>"
+ "documentation":"<p>This data type is used as a response element in the <code>ModifyDBInstance</code> operation and contains changes that will be applied during the next maintenance window.</p>"
},
"PointInTimeRestoreNotEnabledFault":{
"type":"structure",
"members":{
},
- "documentation":"<p> <code>SourceDBInstanceIdentifier</code> refers to a DB instance with <code>BackupRetentionPeriod</code> equal to 0. </p>",
+ "documentation":"<p> <code>SourceDBInstanceIdentifier</code> refers to a DB instance with <code>BackupRetentionPeriod</code> equal to 0.</p>",
"error":{
"code":"PointInTimeRestoreNotEnabled",
"httpStatusCode":400,
@@ -11543,7 +11546,7 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
- "documentation":"<p>The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing DB cluster read replica.</p> </li> </ul> <p>Example: <code>my-cluster-replica1</code> </p>"
+ "documentation":"<p>The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing DB cluster read replica.</p> </li> </ul> <p>Example: <code>my-cluster-replica1</code> </p>"
}
},
"documentation":"<p/>"
@@ -11568,7 +11571,7 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p> The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. </p> <p> The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html\"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
+ "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html\"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
}
},
"documentation":"<p/>"
@@ -11630,7 +11633,7 @@
},
"Step":{
"shape":"IntegerOptional",
- "documentation":"<p>The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000... </p>"
+ "documentation":"<p>The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...</p>"
}
},
"documentation":"<p>A range of integer values.</p>"
@@ -11693,7 +11696,7 @@
},
"ForceFailover":{
"shape":"BooleanOptional",
- "documentation":"<p> A value that indicates whether the reboot is conducted through a Multi-AZ failover. </p> <p>Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.</p>"
+ "documentation":"<p>A value that indicates whether the reboot is conducted through a Multi-AZ failover.</p> <p>Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.</p>"
}
},
"documentation":"<p/>"
@@ -11716,7 +11719,7 @@
"documentation":"<p>The frequency of the recurring charge.</p>"
}
},
- "documentation":"<p> This data type is used as a response element in the <code>DescribeReservedDBInstances</code> and <code>DescribeReservedDBInstancesOfferings</code> actions. </p>",
+ "documentation":"<p>This data type is used as a response element in the <code>DescribeReservedDBInstances</code> and <code>DescribeReservedDBInstancesOfferings</code> actions.</p>",
"wrapper":true
},
"RecurringChargeList":{
@@ -11762,11 +11765,11 @@
"members":{
"GlobalClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The cluster identifier to detach from the Aurora global database cluster. </p>"
+ "documentation":"<p>The cluster identifier to detach from the Aurora global database cluster.</p>"
},
"DbClusterIdentifier":{
"shape":"String",
- "documentation":"<p> The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.</p>"
}
}
},
@@ -11815,7 +11818,7 @@
},
"FeatureName":{
"shape":"String",
- "documentation":"<p>The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see <code>DBEngineVersion</code>. </p>"
+ "documentation":"<p>The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see <code>DBEngineVersion</code>.</p>"
}
}
},
@@ -11832,7 +11835,7 @@
},
"SourceIdentifier":{
"shape":"String",
- "documentation":"<p> The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> for a DB instance or the name of a security group. </p>"
+ "documentation":"<p>The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> for a DB instance or the name of a security group.</p>"
}
},
"documentation":"<p/>"
@@ -11936,7 +11939,7 @@
"documentation":"<p>The unique identifier for the lease associated with the reserved DB instance.</p> <note> <p>Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.</p> </note>"
}
},
- "documentation":"<p> This data type is used as a response element in the <code>DescribeReservedDBInstances</code> and <code>PurchaseReservedDBInstancesOffering</code> actions. </p>",
+ "documentation":"<p>This data type is used as a response element in the <code>DescribeReservedDBInstances</code> and <code>PurchaseReservedDBInstancesOffering</code> actions.</p>",
"wrapper":true
},
"ReservedDBInstanceAlreadyExistsFault":{
@@ -11963,14 +11966,14 @@
"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>"
+ "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>"
},
"ReservedDBInstances":{
"shape":"ReservedDBInstanceList",
"documentation":"<p>A list of reserved DB instances.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeReservedDBInstances</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeReservedDBInstances</code> action.</p>"
},
"ReservedDBInstanceNotFoundFault":{
"type":"structure",
@@ -12040,7 +12043,7 @@
"documentation":"<p>The recurring price charged to run this reserved DB instance.</p>"
}
},
- "documentation":"<p> This data type is used as a response element in the <code>DescribeReservedDBInstancesOfferings</code> action. </p>",
+ "documentation":"<p>This data type is used as a response element in the <code>DescribeReservedDBInstancesOfferings</code> action.</p>",
"wrapper":true
},
"ReservedDBInstancesOfferingList":{
@@ -12055,14 +12058,14 @@
"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>"
+ "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>"
},
"ReservedDBInstancesOfferings":{
"shape":"ReservedDBInstancesOfferingList",
"documentation":"<p>A list of reserved DB instance offerings.</p>"
}
},
- "documentation":"<p> Contains the result of a successful invocation of the <code>DescribeReservedDBInstancesOfferings</code> action. </p>"
+ "documentation":"<p>Contains the result of a successful invocation of the <code>DescribeReservedDBInstancesOfferings</code> action.</p>"
},
"ReservedDBInstancesOfferingNotFoundFault":{
"type":"structure",
@@ -12105,7 +12108,7 @@
},
"ResetAllParameters":{
"shape":"Boolean",
- "documentation":"<p> A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values. </p>"
+ "documentation":"<p>A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.</p>"
},
"Parameters":{
"shape":"ParametersList",
@@ -12176,7 +12179,7 @@
},
"DBClusterParameterGroupName":{
"shape":"String",
- "documentation":"<p>The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, <code>default.aurora5.6</code> is used. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>"
+ "documentation":"<p>The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, <code>default.aurora5.6</code> is used.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
@@ -12196,7 +12199,7 @@
},
"Port":{
"shape":"IntegerOptional",
- "documentation":"<p>The port number on which the instances in the restored DB cluster accept connections.</p> <p> Default: <code>3306</code> </p>"
+ "documentation":"<p>The port number on which the instances in the restored DB cluster accept connections.</p> <p>Default: <code>3306</code> </p>"
},
"MasterUsername":{
"shape":"String",
@@ -12212,11 +12215,11 @@
},
"PreferredBackupWindow":{
"shape":"String",
- "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow\"> Backup window</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
+ "documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow\"> Backup window</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
- "documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora\"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p>"
+ "documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora\"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p>"
},
"Tags":{"shape":"TagList"},
"StorageEncrypted":{
@@ -12229,15 +12232,15 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"SourceEngine":{
"shape":"String",
- "documentation":"<p>The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. </p> <p>Valid values: <code>mysql</code> </p>"
+ "documentation":"<p>The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.</p> <p>Valid values: <code>mysql</code> </p>"
},
"SourceEngineVersion":{
"shape":"String",
- "documentation":"<p>The version of the database that the backup files were created from.</p> <p>MySQL versions 5.5, 5.6, and 5.7 are supported. </p> <p>Example: <code>5.6.40</code>, <code>5.7.28</code> </p>"
+ "documentation":"<p>The version of the database that the backup files were created from.</p> <p>MySQL versions 5.5, 5.6, and 5.7 are supported.</p> <p>Example: <code>5.6.40</code>, <code>5.7.28</code> </p>"
},
"S3BucketName":{
"shape":"String",
@@ -12257,11 +12260,11 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
- "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>"
+ "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. </p>"
+ "documentation":"<p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
@@ -12269,7 +12272,7 @@
},
"Domain":{
"shape":"String",
- "documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. </p> <p> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos Authentication</a> in the <i>Amazon Aurora User Guide</i>. </p>"
+ "documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.</p> <p>For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"DomainIAMRoleName":{
"shape":"String",
@@ -12309,7 +12312,7 @@
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p>The version of the database engine to use for the new DB cluster.</p> <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html\">MySQL on Amazon RDS Versions</a> in the <i>Amazon Aurora User Guide.</i> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html\">Amazon Aurora PostgreSQL releases and engine versions</a> in the <i>Amazon Aurora User Guide.</i> </p> <p> <b>MySQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt\">MySQL on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>PostgreSQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts\">Amazon RDS for PostgreSQL versions and extensions</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The version of the database engine to use for the new DB cluster.</p> <p>To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for Aurora PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for MySQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for RDS for PostgreSQL, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html\">MySQL on Amazon RDS Versions</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html\">Amazon Aurora PostgreSQL releases and engine versions</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>MySQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt\">MySQL on Amazon RDS Versions</a> in the <i>Amazon RDS User Guide.</i> </p> <p> <b>PostgreSQL</b> </p> <p>See <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts\">Amazon RDS for PostgreSQL versions and extensions</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Port":{
"shape":"IntegerOptional",
@@ -12341,7 +12344,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@@ -12349,7 +12352,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
- "documentation":"<p>The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide.</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"EngineMode":{
"shape":"String",
@@ -12369,7 +12372,7 @@
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Domain":{
"shape":"String",
@@ -12381,15 +12384,15 @@
},
"DBClusterInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p> <p>For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.</p> <p>For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p> <p> Valid values: <code>io1</code> </p> <p> When specified, a value for the <code>Iops</code> parameter is required. </p> <p> Default: <code>io1</code> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p> <p>Valid values: <code>io1</code> </p> <p>When specified, a value for the <code>Iops</code> parameter is required.</p> <p>Default: <code>io1</code> </p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid Iops values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid Iops values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
@@ -12429,11 +12432,11 @@
},
"UseLatestRestorableTime":{
"shape":"Boolean",
- "documentation":"<p>A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time. </p> <p>Constraints: Can't be specified if <code>RestoreToTime</code> parameter is provided.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.</p> <p>Constraints: Can't be specified if <code>RestoreToTime</code> parameter is provided.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Port":{
"shape":"IntegerOptional",
- "documentation":"<p>The port number on which the new DB cluster accepts connections.</p> <p>Constraints: A value from <code>1150-65535</code>. </p> <p>Default: The default port for the engine.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
+ "documentation":"<p>The port number on which the new DB cluster accepts connections.</p> <p>Constraints: A value from <code>1150-65535</code>.</p> <p>Default: The default port for the engine.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"DBSubnetGroupName":{
"shape":"String",
@@ -12454,7 +12457,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@@ -12462,7 +12465,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
- "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide.</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"DBClusterParameterGroupName":{
"shape":"String",
@@ -12474,11 +12477,11 @@
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>"
},
"Domain":{
"shape":"String",
- "documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. </p> <p> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos Authentication</a> in the <i>Amazon Aurora User Guide</i>. </p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.</p> <p>For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html\">Kerberos Authentication</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"DomainIAMRoleName":{
"shape":"String",
@@ -12490,7 +12493,7 @@
},
"EngineMode":{
"shape":"String",
- "documentation":"<p>The engine mode of the new cluster. Specify <code>provisioned</code> or <code>serverless</code>, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.</p> <p>Valid for: Aurora DB clusters only</p>"
+ "documentation":"<p>The engine mode of the new cluster. Specify <code>provisioned</code> or <code>serverless</code>, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.</p> <p>Valid for: Aurora DB clusters only</p>"
},
"DBClusterInstanceClass":{
"shape":"String",
@@ -12498,7 +12501,7 @@
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p> <p> Valid values: <code>io1</code> </p> <p> When specified, a value for the <code>Iops</code> parameter is required. </p> <p> Default: <code>io1</code> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.</p> <p>Valid values: <code>io1</code> </p> <p>When specified, a value for the <code>Iops</code> parameter is required.</p> <p>Default: <code>io1</code> </p> <p>Valid for: Multi-AZ DB clusters only</p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
@@ -12506,7 +12509,7 @@
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid <code>Iops</code> values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. </p> <p>Valid for: Multi-AZ DB clusters only</p>"
+ "documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.</p> <p>For information about valid <code>Iops</code> values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS storage to improve performance</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.</p> <p>Valid for: Multi-AZ DB clusters only</p>"
}
},
"documentation":"<p/>"
@@ -12562,7 +12565,7 @@
},
"LicenseModel":{
"shape":"String",
- "documentation":"<p>License model information for the restored DB instance.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: Same as source.</p> <p> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p>"
+ "documentation":"<p>License model information for the restored DB instance.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: Same as source.</p> <p>Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p>"
},
"DBName":{
"shape":"String",
@@ -12574,7 +12577,7 @@
},
"Iops":{
"shape":"IntegerOptional",
- "documentation":"<p>Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. </p> <p>The provisioned IOPS value must follow the requirements for your database engine. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Constraints: Must be an integer greater than 1000.</p>"
+ "documentation":"<p>Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.</p> <p>The provisioned IOPS value must follow the requirements for your database engine. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Constraints: Must be an integer greater than 1000.</p>"
},
"OptionGroupName":{
"shape":"String",
@@ -12583,7 +12586,7 @@
"Tags":{"shape":"TagList"},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p> Valid values: <code>standard | gp2 | io1</code> </p> <p> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </p> <p> Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p>Valid values: <code>standard | gp2 | io1</code> </p> <p>If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter.</p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
},
"TdeCredentialArn":{
"shape":"String",
@@ -12595,7 +12598,7 @@
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
- "documentation":"<p> A list of EC2 VPC security groups to associate with this DB instance. </p> <p> Default: The default EC2 VPC security group for the DB subnet group's VPC. </p>"
+ "documentation":"<p>A list of EC2 VPC security groups to associate with this DB instance.</p> <p>Default: The default EC2 VPC security group for the DB subnet group's VPC.</p>"
},
"Domain":{
"shape":"String",
@@ -12631,7 +12634,7 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p>"
},
"EnableCustomerOwnedIp":{
"shape":"BooleanOptional",
@@ -12668,31 +12671,31 @@
"members":{
"DBName":{
"shape":"String",
- "documentation":"<p>The name of the database to create when the DB instance is created. Follow the naming rules specified in <code>CreateDBInstance</code>. </p>"
+ "documentation":"<p>The name of the database to create when the DB instance is created. Follow the naming rules specified in <code>CreateDBInstance</code>.</p>"
},
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
+ "documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in <code>CreateDBInstance</code>. </p> <note> <p>Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth. </p> </note>"
+ "documentation":"<p>The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in <code>CreateDBInstance</code>.</p> <note> <p>Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.</p> </note>"
},
"DBInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class. </p>"
+ "documentation":"<p>The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.</p>"
},
"Engine":{
"shape":"String",
- "documentation":"<p>The name of the database engine to be used for this instance. </p> <p>Valid Values: <code>mysql</code> </p>"
+ "documentation":"<p>The name of the database engine to be used for this instance.</p> <p>Valid Values: <code>mysql</code> </p>"
},
"MasterUsername":{
"shape":"String",
- "documentation":"<p>The name for the master user. </p> <p>Constraints: </p> <ul> <li> <p>Must be 1 to 16 letters or numbers.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't be a reserved word for the chosen database engine.</p> </li> </ul>"
+ "documentation":"<p>The name for the master user.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 16 letters or numbers.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't be a reserved word for the chosen database engine.</p> </li> </ul>"
},
"MasterUserPassword":{
"shape":"String",
- "documentation":"<p>The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\". </p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
+ "documentation":"<p>The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
},
"DBSecurityGroups":{
"shape":"DBSecurityGroupNameList",
@@ -12700,11 +12703,11 @@
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
- "documentation":"<p>A list of VPC security groups to associate with this DB instance. </p>"
+ "documentation":"<p>A list of VPC security groups to associate with this DB instance.</p>"
},
"AvailabilityZone":{
"shape":"String",
- "documentation":"<p>The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html\">Regions and Availability Zones</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. </p> <p> Example: <code>us-east-1d</code> </p> <p>Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint. </p>"
+ "documentation":"<p>The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html\">Regions and Availability Zones</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p> <p>Example: <code>us-east-1d</code> </p> <p>Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
@@ -12720,7 +12723,7 @@
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
- "documentation":"<p>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see <code>CreateDBInstance</code>. </p>"
+ "documentation":"<p>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see <code>CreateDBInstance</code>.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
@@ -12728,23 +12731,23 @@
},
"Port":{
"shape":"IntegerOptional",
- "documentation":"<p>The port number on which the database accepts connections. </p> <p>Type: Integer </p> <p>Valid Values: <code>1150</code>-<code>65535</code> </p> <p>Default: <code>3306</code> </p>"
+ "documentation":"<p>The port number on which the database accepts connections.</p> <p>Type: Integer</p> <p>Valid Values: <code>1150</code>-<code>65535</code> </p> <p>Default: <code>3306</code> </p>"
},
"MultiAZ":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the <code>AvailabilityZone</code> parameter. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the <code>AvailabilityZone</code> parameter.</p>"
},
"EngineVersion":{
"shape":"String",
- "documentation":"<p>The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see <code>CreateDBInstance</code>, or call <code>DescribeDBEngineVersions</code>. </p>"
+ "documentation":"<p>The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see <code>CreateDBInstance</code>, or call <code>DescribeDBEngineVersions</code>.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically. </p>"
+ "documentation":"<p>A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.</p>"
},
"LicenseModel":{
"shape":"String",
- "documentation":"<p>The license model for this DB instance. Use <code>general-public-license</code>. </p>"
+ "documentation":"<p>The license model for this DB instance. Use <code>general-public-license</code>.</p>"
},
"Iops":{
"shape":"IntegerOptional",
@@ -12752,7 +12755,7 @@
},
"OptionGroupName":{
"shape":"String",
- "documentation":"<p>The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used. </p>"
+ "documentation":"<p>The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.</p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
@@ -12764,27 +12767,27 @@
},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB instance. </p> <p>Valid values: <code>standard</code> | <code>gp2</code> | <code>io1</code> </p> <p>If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>gp2</code> </p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p>Valid values: <code>standard</code> | <code>gp2</code> | <code>io1</code> </p> <p>If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter.</p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified; otherwise <code>gp2</code> </p>"
},
"StorageEncrypted":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the new DB instance is encrypted or not. </p>"
+ "documentation":"<p>A value that indicates whether the new DB instance is encrypted or not.</p>"
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB instance. </p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p> <p>If the <code>StorageEncrypted</code> parameter is enabled, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. </p>"
+ "documentation":"<p>The Amazon Web Services KMS key identifier for an encrypted DB instance.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.</p> <p>If the <code>StorageEncrypted</code> parameter is enabled, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. </p>"
+ "documentation":"<p>A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.</p>"
},
"MonitoringInterval":{
"shape":"IntegerOptional",
- "documentation":"<p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. </p> <p>If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0. </p> <p>Valid Values: 0, 1, 5, 10, 15, 30, 60 </p> <p>Default: <code>0</code> </p>"
+ "documentation":"<p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.</p> <p>If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0.</p> <p>Valid Values: 0, 1, 5, 10, 15, 30, 60</p> <p>Default: <code>0</code> </p>"
},
"MonitoringRoleArn":{
"shape":"String",
- "documentation":"<p>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling\">Setting Up and Enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i> </p> <p>If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value. </p>"
+ "documentation":"<p>The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. For information on creating a monitoring role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling\">Setting Up and Enabling Enhanced Monitoring</a> in the <i>Amazon RDS User Guide.</i> </p> <p>If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value.</p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
@@ -12792,27 +12795,27 @@
},
"SourceEngine":{
"shape":"String",
- "documentation":"<p>The name of the engine of your source database. </p> <p>Valid Values: <code>mysql</code> </p>"
+ "documentation":"<p>The name of the engine of your source database.</p> <p>Valid Values: <code>mysql</code> </p>"
},
"SourceEngineVersion":{
"shape":"String",
- "documentation":"<p>The version of the database that the backup files were created from.</p> <p>MySQL versions 5.6 and 5.7 are supported. </p> <p>Example: <code>5.6.40</code> </p>"
+ "documentation":"<p>The version of the database that the backup files were created from.</p> <p>MySQL versions 5.6 and 5.7 are supported.</p> <p>Example: <code>5.6.40</code> </p>"
},
"S3BucketName":{
"shape":"String",
- "documentation":"<p>The name of your Amazon S3 bucket that contains your database backup file. </p>"
+ "documentation":"<p>The name of your Amazon S3 bucket that contains your database backup file.</p>"
},
"S3Prefix":{
"shape":"String",
- "documentation":"<p>The prefix of your Amazon S3 bucket. </p>"
+ "documentation":"<p>The prefix of your Amazon S3 bucket.</p>"
},
"S3IngestionRoleArn":{
"shape":"String",
- "documentation":"<p>An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. </p>"
+ "documentation":"<p>An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.</p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to enable Performance Insights for the DB instance. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon Relational Database Service User Guide</i>. </p>"
+ "documentation":"<p>A value that indicates whether to enable Performance Insights for the DB instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon Performance Insights</a> in the <i>Amazon RDS User Guide.</i>.</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
@@ -12820,7 +12823,7 @@
},
"PerformanceInsightsRetentionPeriod":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). </p>"
+ "documentation":"<p>The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@@ -12836,7 +12839,7 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p>"
},
"MaxAllocatedStorage":{
"shape":"IntegerOptional",
@@ -12868,11 +12871,11 @@
},
"UseLatestRestorableTime":{
"shape":"Boolean",
- "documentation":"<p> A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. </p> <p>Constraints: Can't be specified if the <code>RestoreTime</code> parameter is provided.</p>"
+ "documentation":"<p>A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.</p> <p>Constraints: Can't be specified if the <code>RestoreTime</code> parameter is provided.</p>"
},
"DBInstanceClass":{
"shape":"String",
- "documentation":"<p>The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide.</i> </p> <p>Default: The same DBInstanceClass as the original DB instance.</p>"
+ "documentation":"<p>The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html\">DB Instance Class</a> in the <i>Amazon RDS User Guide</i>.</p> <p>Default: The same DBInstanceClass as the original DB instance.</p>"
},
"Port":{
"shape":"IntegerOptional",
@@ -12900,7 +12903,7 @@
},
"LicenseModel":{
"shape":"String",
- "documentation":"<p>License model information for the restored DB instance.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: Same as source.</p> <p> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p>"
+ "documentation":"<p>License model information for the restored DB instance.</p> <p>This setting doesn't apply to RDS Custom.</p> <p>Default: Same as source.</p> <p>Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p>"
},
"DBName":{
"shape":"String",
@@ -12925,7 +12928,7 @@
"Tags":{"shape":"TagList"},
"StorageType":{
"shape":"String",
- "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p> Valid values: <code>standard | gp2 | io1</code> </p> <p> If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter. </p> <p> Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
+ "documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p>Valid values: <code>standard | gp2 | io1</code> </p> <p>If you specify <code>io1</code>, you must also include a value for the <code>Iops</code> parameter.</p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>gp2</code> </p>"
},
"TdeCredentialArn":{
"shape":"String",
@@ -12937,7 +12940,7 @@
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
- "documentation":"<p> A list of EC2 VPC security groups to associate with this DB instance. </p> <p> Default: The default EC2 VPC security group for the DB subnet group's VPC. </p>"
+ "documentation":"<p>A list of EC2 VPC security groups to associate with this DB instance.</p> <p>Default: The default EC2 VPC security group for the DB subnet group's VPC.</p>"
},
"Domain":{
"shape":"String",
@@ -12969,7 +12972,7 @@
},
"DeletionProtection":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
+ "documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>.</p>"
},
"SourceDbiResourceId":{
"shape":"String",
@@ -12989,7 +12992,7 @@
},
"CustomIamInstanceProfile":{
"shape":"String",
- "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon Relational Database Service User Guide</i>.</p> <p>This setting is required for RDS Custom.</p>"
+ "documentation":"<p>The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:</p> <ul> <li> <p>The profile must exist in your account.</p> </li> <li> <p>The profile must have an IAM role that Amazon EC2 has permissions to assume.</p> </li> <li> <p>The instance profile name and the associated IAM role name must start with the prefix <code>AWSRDSCustom</code>.</p> </li> </ul> <p>For the list of permissions required for the IAM role, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc\"> Configure IAM and your VPC</a> in the <i>Amazon RDS User Guide</i>.</p> <p>This setting is required for RDS Custom.</p>"
},
"BackupTarget":{
"shape":"String",
@@ -13028,19 +13031,19 @@
},
"CIDRIP":{
"shape":"String",
- "documentation":"<p> The IP range to revoke access from. Must be a valid CIDR range. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code>, <code>EC2SecurityGroupId</code> and <code>EC2SecurityGroupOwnerId</code> can't be provided. </p>"
+ "documentation":"<p>The IP range to revoke access from. Must be a valid CIDR range. If <code>CIDRIP</code> is specified, <code>EC2SecurityGroupName</code>, <code>EC2SecurityGroupId</code> and <code>EC2SecurityGroupOwnerId</code> can't be provided.</p>"
},
"EC2SecurityGroupName":{
"shape":"String",
- "documentation":"<p> The name of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </p>"
+ "documentation":"<p>The name of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.</p>"
},
"EC2SecurityGroupId":{
"shape":"String",
- "documentation":"<p> The id of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </p>"
+ "documentation":"<p>The id of the EC2 security group to revoke access from. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.</p>"
},
"EC2SecurityGroupOwnerId":{
"shape":"String",
- "documentation":"<p> The Amazon Web Services account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided. </p>"
+ "documentation":"<p>The Amazon Web Services account number of the owner of the EC2 security group specified in the <code>EC2SecurityGroupName</code> parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, <code>EC2SecurityGroupId</code> must be provided. Otherwise, EC2SecurityGroupOwnerId and either <code>EC2SecurityGroupName</code> or <code>EC2SecurityGroupId</code> must be provided.</p>"
}
},
"documentation":"<p/>"
@@ -13100,7 +13103,7 @@
},
"AutoPause":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in <code>serverless</code> DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).</p> <note> <p>If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. </p> </note>"
+ "documentation":"<p>A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in <code>serverless</code> DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).</p> <note> <p>If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.</p> </note>"
},
"SecondsUntilAutoPause":{
"shape":"IntegerOptional",
@@ -13108,14 +13111,14 @@
},
"TimeoutAction":{
"shape":"String",
- "documentation":"<p>The action to take when the timeout is reached, either <code>ForceApplyCapacityChange</code> or <code>RollbackCapacityChange</code>.</p> <p> <code>ForceApplyCapacityChange</code> sets the capacity to the specified value as soon as possible.</p> <p> <code>RollbackCapacityChange</code>, the default, ignores the capacity change if a scaling point isn't found in the timeout period.</p> <important> <p>If you specify <code>ForceApplyCapacityChange</code>, connections that prevent Aurora Serverless from finding a scaling point might be dropped.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling\"> Autoscaling for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>"
+ "documentation":"<p>The action to take when the timeout is reached, either <code>ForceApplyCapacityChange</code> or <code>RollbackCapacityChange</code>.</p> <p> <code>ForceApplyCapacityChange</code> sets the capacity to the specified value as soon as possible.</p> <p> <code>RollbackCapacityChange</code>, the default, ignores the capacity change if a scaling point isn't found in the timeout period.</p> <important> <p>If you specify <code>ForceApplyCapacityChange</code>, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling\"> Autoscaling for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"SecondsBeforeTimeout":{
"shape":"IntegerOptional",
- "documentation":"<p>The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.</p> <p>Specify a value between 60 and 600 seconds.</p>"
+ "documentation":"<p>The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.</p> <p>Specify a value between 60 and 600 seconds.</p>"
}
},
- "documentation":"<p>Contains the scaling configuration of an Aurora Serverless DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>"
+ "documentation":"<p>Contains the scaling configuration of an Aurora Serverless v1 DB cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"ScalingConfigurationInfo":{
"type":"structure",
@@ -13130,7 +13133,7 @@
},
"AutoPause":{
"shape":"BooleanOptional",
- "documentation":"<p>A value that indicates whether automatic pause is allowed for the Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.</p>"
+ "documentation":"<p>A value that indicates whether automatic pause is allowed for the Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.</p>"
},
"SecondsUntilAutoPause":{
"shape":"IntegerOptional",
@@ -13138,14 +13141,14 @@
},
"TimeoutAction":{
"shape":"String",
- "documentation":"<p>The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless cluster. The value is either <code>ForceApplyCapacityChange</code> or <code>RollbackCapacityChange</code>.</p> <p> <code>ForceApplyCapacityChange</code>, the default, sets the capacity to the specified value as soon as possible.</p> <p> <code>RollbackCapacityChange</code> ignores the capacity change if a scaling point isn't found in the timeout period.</p>"
+ "documentation":"<p>The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either <code>ForceApplyCapacityChange</code> or <code>RollbackCapacityChange</code>.</p> <p> <code>ForceApplyCapacityChange</code>, the default, sets the capacity to the specified value as soon as possible.</p> <p> <code>RollbackCapacityChange</code> ignores the capacity change if a scaling point isn't found in the timeout period.</p>"
},
"SecondsBeforeTimeout":{
"shape":"IntegerOptional",
"documentation":"<p>The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the <code>TimeoutAction</code> setting.</p>"
}
},
- "documentation":"<p>Shows the scaling configuration for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>"
+ "documentation":"<p>Shows the scaling configuration for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"SharedSnapshotQuotaExceededFault":{
"type":"structure",
@@ -13224,11 +13227,11 @@
"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>"
+ "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>"
},
"SourceRegions":{
"shape":"SourceRegionList",
- "documentation":"<p>A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.</p>"
+ "documentation":"<p>A list of <code>SourceRegion</code> instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.</p>"
}
},
"documentation":"<p>Contains the result of a successful invocation of the <code>DescribeSourceRegions</code> action.</p>"
@@ -13260,7 +13263,7 @@
},
"Mode":{
"shape":"ActivityStreamMode",
- "documentation":"<p>Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. </p>"
+ "documentation":"<p>Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.</p>"
},
"KmsKeyId":{
"shape":"String",
@@ -13355,7 +13358,7 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p> The user-supplied instance identifier. </p>"
+ "documentation":"<p>The user-supplied instance identifier.</p>"
}
}
},
@@ -13377,7 +13380,7 @@
"members":{
"ExportTaskIdentifier":{
"shape":"String",
- "documentation":"<p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to. </p>"
+ "documentation":"<p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.</p>"
},
"SourceArn":{
"shape":"String",
@@ -13389,11 +13392,11 @@
},
"IamRoleArn":{
"shape":"String",
- "documentation":"<p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot. </p>"
+ "documentation":"<p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.</p>"
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy: </p> <ul> <li> <p>GrantOperation.Encrypt</p> </li> <li> <p>GrantOperation.Decrypt</p> </li> <li> <p>GrantOperation.GenerateDataKey</p> </li> <li> <p>GrantOperation.GenerateDataKeyWithoutPlaintext</p> </li> <li> <p>GrantOperation.ReEncryptFrom</p> </li> <li> <p>GrantOperation.ReEncryptTo</p> </li> <li> <p>GrantOperation.CreateGrant</p> </li> <li> <p>GrantOperation.DescribeKey</p> </li> <li> <p>GrantOperation.RetireGrant</p> </li> </ul>"
+ "documentation":"<p>The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy:</p> <ul> <li> <p>GrantOperation.Encrypt</p> </li> <li> <p>GrantOperation.Decrypt</p> </li> <li> <p>GrantOperation.GenerateDataKey</p> </li> <li> <p>GrantOperation.GenerateDataKeyWithoutPlaintext</p> </li> <li> <p>GrantOperation.ReEncryptFrom</p> </li> <li> <p>GrantOperation.ReEncryptTo</p> </li> <li> <p>GrantOperation.CreateGrant</p> </li> <li> <p>GrantOperation.DescribeKey</p> </li> <li> <p>GrantOperation.RetireGrant</p> </li> </ul>"
},
"S3Prefix":{
"shape":"String",
@@ -13411,7 +13414,7 @@
"members":{
"ResourceArn":{
"shape":"String",
- "documentation":"<p>The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, <code>arn:aws:rds:us-east-1:12345667890:cluster:das-cluster</code>. </p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, <code>arn:aws:rds:us-east-1:12345667890:cluster:das-cluster</code>.</p>"
},
"ApplyImmediately":{
"shape":"BooleanOptional",
@@ -13474,11 +13477,11 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
- "documentation":"<p> The user-supplied instance identifier. </p>"
+ "documentation":"<p>The user-supplied instance identifier.</p>"
},
"DBSnapshotIdentifier":{
"shape":"String",
- "documentation":"<p> The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped. </p>"
+ "documentation":"<p>The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.</p>"
}
}
},
@@ -13504,7 +13507,7 @@
"type":"structure",
"members":{
},
- "documentation":"<p>Storage of the <code>StorageType</code> specified can't be associated with the DB instance. </p>",
+ "documentation":"<p>Storage of the <code>StorageType</code> specified can't be associated with the DB instance.</p>",
"error":{
"code":"StorageTypeNotSupported",
"httpStatusCode":400,
@@ -13544,7 +13547,7 @@
"documentation":"<p>The status of the subnet.</p>"
}
},
- "documentation":"<p> This data type is used as a response element for the <code>DescribeDBSubnetGroups</code> operation. </p>"
+ "documentation":"<p>This data type is used as a response element for the <code>DescribeDBSubnetGroups</code> operation.</p>"
},
"SubnetAlreadyInUse":{
"type":"structure",
@@ -13650,7 +13653,7 @@
"members":{
"TagList":{
"shape":"TagList",
- "documentation":"<p>List of tags returned by the ListTagsForResource operation.</p>"
+ "documentation":"<p>List of tags returned by the <code>ListTagsForResource</code> operation.</p>"
}
},
"documentation":"<p/>"
@@ -13664,7 +13667,7 @@
"members":{
"State":{
"shape":"TargetState",
- "documentation":"<p>The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: </p> <p> <code>registering</code> &gt; <code>unavailable</code> &gt; <code>available</code> &gt; <code>unavailable</code> &gt; <code>available</code> </p>"
+ "documentation":"<p>The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:</p> <p> <code>registering</code> &gt; <code>unavailable</code> &gt; <code>available</code> &gt; <code>unavailable</code> &gt; <code>available</code> </p>"
},
"Reason":{
"shape":"TargetHealthReason",
@@ -13723,7 +13726,7 @@
"documentation":"<p>The name of the time zone.</p>"
}
},
- "documentation":"<p>A time zone associated with a <code>DBInstance</code> or a <code>DBSnapshot</code>. This data type is an element in the response to the <code>DescribeDBInstances</code>, the <code>DescribeDBSnapshots</code>, and the <code>DescribeDBEngineVersions</code> actions. </p>"
+ "documentation":"<p>A time zone associated with a <code>DBInstance</code> or a <code>DBSnapshot</code>. This data type is an element in the response to the <code>DescribeDBInstances</code>, the <code>DescribeDBSnapshots</code>, and the <code>DescribeDBEngineVersions</code> actions.</p>"
},
"UpgradeTarget":{
"type":"structure",
@@ -13759,6 +13762,10 @@
"SupportsGlobalDatabases":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether you can use Aurora global databases with the target engine version.</p>"
+ },
+ "SupportsBabelfish":{
+ "shape":"BooleanOptional",
+ "documentation":"<p>A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.</p>"
}
},
"documentation":"<p>The version of the database engine that a DB instance can be upgraded to.</p>"
@@ -13828,14 +13835,14 @@
"members":{
"Storage":{
"shape":"ValidStorageOptionsList",
- "documentation":"<p>Valid storage options for your DB instance. </p>"
+ "documentation":"<p>Valid storage options for your DB instance.</p>"
},
"ValidProcessorFeatures":{
"shape":"AvailableProcessorFeatureList",
- "documentation":"<p>Valid processor features for your DB instance. </p>"
+ "documentation":"<p>Valid processor features for your DB instance.</p>"
}
},
- "documentation":"<p>Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the <code>DescribeValidDBInstanceModifications</code> action. You can use this information when you call <code>ModifyDBInstance</code>. </p>",
+ "documentation":"<p>Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the <code>DescribeValidDBInstanceModifications</code> action. You can use this information when you call <code>ModifyDBInstance</code>.</p>",
"wrapper":true
},
"ValidStorageOptions":{
@@ -13843,26 +13850,26 @@
"members":{
"StorageType":{
"shape":"String",
- "documentation":"<p>The valid storage types for your DB instance. For example, gp2, io1. </p>"
+ "documentation":"<p>The valid storage types for your DB instance. For example, gp2, io1.</p>"
},
"StorageSize":{
"shape":"RangeList",
- "documentation":"<p>The valid range of storage in gibibytes (GiB). For example, 100 to 16384. </p>"
+ "documentation":"<p>The valid range of storage in gibibytes (GiB). For example, 100 to 16384.</p>"
},
"ProvisionedIops":{
"shape":"RangeList",
- "documentation":"<p>The valid range of provisioned IOPS. For example, 1000-20000. </p>"
+ "documentation":"<p>The valid range of provisioned IOPS. For example, 1000-20000.</p>"
},
"IopsToStorageRatio":{
"shape":"DoubleRangeList",
- "documentation":"<p>The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage. </p>"
+ "documentation":"<p>The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.</p>"
},
"SupportsStorageAutoscaling":{
"shape":"Boolean",
"documentation":"<p>Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.</p>"
}
},
- "documentation":"<p>Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the <code>DescribeValidDBInstanceModifications</code> action. </p>"
+ "documentation":"<p>Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the <code>DescribeValidDBInstanceModifications</code> action.</p>"
},
"ValidStorageOptionsList":{
"type":"list",
@@ -13947,5 +13954,5 @@
]
}
},
- "documentation":"<fullname>Amazon Relational Database Service</fullname> <p> </p> <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.</p> <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.</p> <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html\">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html\">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html\">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html\">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces\">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html\">Using the Query API</a>.</p> </li> </ul>"
+ "documentation":"<fullname>Amazon Relational Database Service</fullname> <p/> <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.</p> <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.</p> <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html\">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html\">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html\">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html\">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces\">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html\">Using the Query API</a>.</p> </li> </ul>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/redshift/2012-12-01/service-2.json b/contrib/python/botocore/py3/botocore/data/redshift/2012-12-01/service-2.json
index ecad2f1538..adb924b4ad 100644
--- a/contrib/python/botocore/py3/botocore/data/redshift/2012-12-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/redshift/2012-12-01/service-2.json
@@ -484,7 +484,7 @@
{"shape":"InvalidTagFault"},
{"shape":"DependentServiceRequestThrottlingFault"}
],
- "documentation":"<p>Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from Key Management Service (KMS) to encrypt copied snapshots in a destination region.</p> <p> For more information about managing snapshot copy grants, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html\">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>"
+ "documentation":"<p>Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.</p> <p> For more information about managing snapshot copy grants, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html\">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>"
},
"CreateSnapshotSchedule":{
"name":"CreateSnapshotSchedule",
@@ -1427,7 +1427,7 @@
{"shape":"InvalidClusterStateFault"},
{"shape":"UnauthorizedOperation"}
],
- "documentation":"<p>Disables the automatic copying of snapshots from one region to another region for a specified cluster.</p> <p>If your cluster and its snapshots are encrypted using a customer master key (CMK) from Key Management Service, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that grants Amazon Redshift permission to the CMK in the destination region. </p>"
+ "documentation":"<p>Disables the automatic copying of snapshots from one region to another region for a specified cluster.</p> <p>If your cluster and its snapshots are encrypted using an encrypted symmetric key from Key Management Service, use <a>DeleteSnapshotCopyGrant</a> to delete the grant that grants Amazon Redshift permission to the key in the destination region. </p>"
},
"DisassociateDataShareConsumer":{
"name":"DisassociateDataShareConsumer",
@@ -1657,7 +1657,7 @@
{"shape":"InvalidClusterStateFault"},
{"shape":"ClusterNotFoundFault"}
],
- "documentation":"<p>Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.</p> <p>A cluster can have up to 10 IAM roles associated at any time.</p>"
+ "documentation":"<p>Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.</p> <p>The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html\">Quotas and limits</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"ModifyClusterMaintenance":{
"name":"ModifyClusterMaintenance",
@@ -2313,6 +2313,10 @@
"ConsumerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.</p>"
+ },
+ "ConsumerRegion":{
+ "shape":"String",
+ "documentation":"<p>From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.</p>"
}
}
},
@@ -3649,7 +3653,7 @@
},
"MasterUserPassword":{
"shape":"String",
- "documentation":"<p>The password associated with the admin user account for the cluster that is being created.</p> <p>Constraints:</p> <ul> <li> <p>Must be between 8 and 64 characters in length.</p> </li> <li> <p>Must contain at least one uppercase letter.</p> </li> <li> <p>Must contain at least one lowercase letter.</p> </li> <li> <p>Must contain one number.</p> </li> <li> <p>Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.</p> </li> </ul>"
+ "documentation":"<p>The password associated with the admin user account for the cluster that is being created.</p> <p>Constraints:</p> <ul> <li> <p>Must be between 8 and 64 characters in length.</p> </li> <li> <p>Must contain at least one uppercase letter.</p> </li> <li> <p>Must contain at least one lowercase letter.</p> </li> <li> <p>Must contain one number.</p> </li> <li> <p>Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), \" (double quote), \\, /, or @.</p> </li> </ul>"
},
"ClusterSecurityGroups":{
"shape":"ClusterSecurityGroupNameList",
@@ -3737,7 +3741,7 @@
},
"IamRoles":{
"shape":"IamRoleArnList",
- "documentation":"<p>A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.</p> <p>A cluster can have up to 10 IAM roles associated with it at any time.</p>"
+ "documentation":"<p>A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. </p> <p>The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html\">Quotas and limits</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"MaintenanceTrackName":{
"shape":"String",
@@ -4093,7 +4097,7 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.</p>"
+ "documentation":"<p>The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used.</p>"
},
"Tags":{
"shape":"TagList",
@@ -4174,7 +4178,7 @@
},
"LimitType":{
"shape":"UsageLimitLimitType",
- "documentation":"<p>The type of limit. Depending on the feature type, this can be based on a time duration or data size. If <code>FeatureType</code> is <code>spectrum</code>, then <code>LimitType</code> must be <code>data-scanned</code>. If <code>FeatureType</code> is <code>concurrency-scaling</code>, then <code>LimitType</code> must be <code>time</code>. </p>"
+ "documentation":"<p>The type of limit. Depending on the feature type, this can be based on a time duration or data size. If <code>FeatureType</code> is <code>spectrum</code>, then <code>LimitType</code> must be <code>data-scanned</code>. If <code>FeatureType</code> is <code>concurrency-scaling</code>, then <code>LimitType</code> must be <code>time</code>. If <code>FeatureType</code> is <code>cross-region-datasharing</code>, then <code>LimitType</code> must be <code>data-scanned</code>. </p>"
},
"Amount":{
"shape":"Long",
@@ -4243,6 +4247,10 @@
"shape":"DataShareStatus",
"documentation":"<p>The status of the datashare that is associated.</p>"
},
+ "ConsumerRegion":{
+ "shape":"String",
+ "documentation":"<p>The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare.</p>"
+ },
"CreatedDate":{
"shape":"TStamp",
"documentation":"<p>The creation date of the datashare that is associated.</p>"
@@ -5602,6 +5610,10 @@
"ConsumerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the consumer that association for the datashare is removed from.</p>"
+ },
+ "ConsumerRegion":{
+ "shape":"String",
+ "documentation":"<p>From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.</p>"
}
}
},
@@ -7036,11 +7048,11 @@
},
"AddIamRoles":{
"shape":"IamRoleArnList",
- "documentation":"<p>Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.</p>"
+ "documentation":"<p>Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. </p>"
},
"RemoveIamRoles":{
"shape":"IamRoleArnList",
- "documentation":"<p>Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.</p>"
+ "documentation":"<p>Zero or more IAM roles in ARN format to disassociate from the cluster. </p>"
},
"DefaultIamRoleArn":{
"shape":"String",
@@ -7121,7 +7133,7 @@
},
"MasterUserPassword":{
"shape":"String",
- "documentation":"<p>The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. </p> <note> <p>Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.</p> </note> <p>Default: Uses existing setting.</p> <p>Constraints:</p> <ul> <li> <p>Must be between 8 and 64 characters in length.</p> </li> <li> <p>Must contain at least one uppercase letter.</p> </li> <li> <p>Must contain at least one lowercase letter.</p> </li> <li> <p>Must contain one number.</p> </li> <li> <p>Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.</p> </li> </ul>"
+ "documentation":"<p>The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. </p> <note> <p>Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.</p> </note> <p>Default: Uses existing setting.</p> <p>Constraints:</p> <ul> <li> <p>Must be between 8 and 64 characters in length.</p> </li> <li> <p>Must contain at least one uppercase letter.</p> </li> <li> <p>Must contain at least one lowercase letter.</p> </li> <li> <p>Must contain one number.</p> </li> <li> <p>Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), \" (double quote), \\, /, or @.</p> </li> </ul>"
},
"ClusterParameterGroupName":{
"shape":"String",
@@ -8529,7 +8541,7 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.</p>"
+ "documentation":"<p>The Key Management Service (KMS) key ID of the encryption key to encrypt data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.</p>"
},
"NodeType":{
"shape":"String",
@@ -8545,7 +8557,7 @@
},
"IamRoles":{
"shape":"IamRoleArnList",
- "documentation":"<p>A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.</p> <p>A cluster can have up to 10 IAM roles associated at any time.</p>"
+ "documentation":"<p>A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. </p> <p>The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html\">Quotas and limits</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"MaintenanceTrackName":{
"shape":"String",
@@ -8578,6 +8590,10 @@
"TargetReservedNodeOfferingId":{
"shape":"String",
"documentation":"<p>The identifier of the target reserved node offering.</p>"
+ },
+ "Encrypted":{
+ "shape":"BooleanOptional",
+ "documentation":"<p>Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a CMK.</p>"
}
},
"documentation":"<p/>"
@@ -9262,14 +9278,14 @@
},
"KmsKeyId":{
"shape":"String",
- "documentation":"<p>The unique identifier of the customer master key (CMK) in Amazon Web Services KMS to which Amazon Redshift is granted permission.</p>"
+ "documentation":"<p>The unique identifier of the encrypted symmetric key in Amazon Web Services KMS to which Amazon Redshift is granted permission.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag instances.</p>"
}
},
- "documentation":"<p>The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from Amazon Web Services KMS in the destination region.</p> <p> For more information about managing snapshot copy grants, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html\">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>",
+ "documentation":"<p>The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination region.</p> <p> For more information about managing snapshot copy grants, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html\">Amazon Redshift Database Encryption</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>",
"wrapper":true
},
"SnapshotCopyGrantAlreadyExistsFault":{
@@ -10070,7 +10086,8 @@
"type":"string",
"enum":[
"spectrum",
- "concurrency-scaling"
+ "concurrency-scaling",
+ "cross-region-datasharing"
]
},
"UsageLimitLimitType":{
diff --git a/contrib/python/botocore/py3/botocore/data/robomaker/2018-06-29/service-2.json b/contrib/python/botocore/py3/botocore/data/robomaker/2018-06-29/service-2.json
index 8539d234e2..d84de15812 100644
--- a/contrib/python/botocore/py3/botocore/data/robomaker/2018-06-29/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/robomaker/2018-06-29/service-2.json
@@ -2038,7 +2038,7 @@
"DataSourceConfigs":{
"type":"list",
"member":{"shape":"DataSourceConfig"},
- "max":5,
+ "max":6,
"min":1
},
"DataSourceNames":{
@@ -3024,7 +3024,7 @@
"type":"map",
"key":{"shape":"EnvironmentVariableKey"},
"value":{"shape":"EnvironmentVariableValue"},
- "max":16,
+ "max":20,
"min":0
},
"EnvironmentVariableValue":{
@@ -3670,11 +3670,12 @@
},
"LoggingConfig":{
"type":"structure",
- "required":["recordAllRosTopics"],
"members":{
"recordAllRosTopics":{
"shape":"BoxedBoolean",
- "documentation":"<p>A boolean indicating whether to record all ROS topics.</p>"
+ "documentation":"<p>A boolean indicating whether to record all ROS topics.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important>",
+ "deprecated":true,
+ "deprecatedMessage":"AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html."
}
},
"documentation":"<p>The logging configuration.</p>"
@@ -3987,7 +3988,9 @@
},
"useDefaultUploadConfigurations":{
"shape":"BoxedBoolean",
- "documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>"
+ "documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important>",
+ "deprecated":true,
+ "deprecatedMessage":"AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html."
},
"tools":{
"shape":"Tools",
@@ -3995,7 +3998,9 @@
},
"useDefaultTools":{
"shape":"BoxedBoolean",
- "documentation":"<p>A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is <code>False</code>. </p>"
+ "documentation":"<p>A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is <code>False</code>.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important>",
+ "deprecated":true,
+ "deprecatedMessage":"AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html."
}
},
"documentation":"<p>Application configuration information for a robot.</p>"
@@ -4254,7 +4259,9 @@
},
"useDefaultUploadConfigurations":{
"shape":"BoxedBoolean",
- "documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>"
+ "documentation":"<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important>",
+ "deprecated":true,
+ "deprecatedMessage":"AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html."
},
"tools":{
"shape":"Tools",
@@ -4262,7 +4269,9 @@
},
"useDefaultTools":{
"shape":"BoxedBoolean",
- "documentation":"<p>A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is <code>False</code>. </p>"
+ "documentation":"<p>A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is <code>False</code>.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important>",
+ "deprecated":true,
+ "deprecatedMessage":"AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html."
}
},
"documentation":"<p>Information about a simulation application configuration.</p>"
@@ -5358,7 +5367,8 @@
"worlds":{
"shape":"Arns",
"documentation":"<p>A list of worlds.</p>"
- }
+ },
+ "outputLocation":{"shape":"OutputLocation"}
},
"documentation":"<p>Information about a world export job.</p>"
},
diff --git a/contrib/python/botocore/py3/botocore/data/route53-recovery-cluster/2019-12-02/service-2.json b/contrib/python/botocore/py3/botocore/data/route53-recovery-cluster/2019-12-02/service-2.json
index e578292554..eb0c7bcbb2 100644
--- a/contrib/python/botocore/py3/botocore/data/route53-recovery-cluster/2019-12-02/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/route53-recovery-cluster/2019-12-02/service-2.json
@@ -29,7 +29,7 @@
{"shape":"ThrottlingException"},
{"shape":"EndpointTemporarilyUnavailableException"}
],
- "documentation":"<p>Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's off, traffic does not flow. </p> <p>Before you can create a routing control, you first must create a cluster to host the control. For more information, see <a href=\"https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html\">CreateCluster</a>. Access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.</p> <p>For more information about working with routing controls, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html\">Routing control</a> in the Route 53 Application Recovery Controller Developer Guide.</p>"
+ "documentation":"<p>Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow. </p> <p>Before you can create a routing control, you must first create a cluster to host the control in a control panel. For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html\"> Create routing control structures</a> in the Amazon Route 53 Application Recovery Controller Developer Guide. Then you access one of the endpoints for the cluster to get or update the routing control state to redirect traffic. </p> <p> <i>You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.</i> </p> <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html\">API examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> <p>Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html\"> Viewing and updating routing control states</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html\">Working with routing controls overall</a> </p> </li> </ul>"
},
"UpdateRoutingControlState":{
"name":"UpdateRoutingControlState",
@@ -48,7 +48,7 @@
{"shape":"EndpointTemporarilyUnavailableException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.</p> <p>For more information about working with routing controls, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html\">Routing control</a> in the Route 53 Application Recovery Controller Developer Guide.</p>"
+ "documentation":"<p>Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.</p> <p>With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.</p> <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and update routing control states. For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html\"> Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> <p> <i>You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.</i> </p> <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html\">API examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html\"> Viewing and updating routing control states</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html\">Working with routing controls overall</a> </p> </li> </ul>"
},
"UpdateRoutingControlStates":{
"name":"UpdateRoutingControlStates",
@@ -67,7 +67,7 @@
{"shape":"EndpointTemporarilyUnavailableException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.</p> <p>For more information about working with routing controls, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html\">Routing control</a> in the Route 53 Application Recovery Controller Developer Guide.</p>"
+ "documentation":"<p>Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.</p> <p>With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.</p> <p>The <code>SafetyRulesToOverride</code> property enables you override one or more safety rules and update routing control states. For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html\"> Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> <p> <i>You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.</i> </p> <p>To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html\">API examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html\"> Viewing and updating routing control states</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html\">Working with routing controls overall</a> </p> </li> </ul>"
}
},
"shapes":{
@@ -84,7 +84,11 @@
"type":"string",
"max":255,
"min":1,
- "pattern":"^[A-Za-z0-9:\\/_-]*$"
+ "pattern":"^[A-Za-z0-9:.\\/_-]*$"
+ },
+ "Arns":{
+ "type":"list",
+ "member":{"shape":"Arn"}
},
"ConflictException":{
"type":"structure",
@@ -213,14 +217,14 @@
"members":{
"RoutingControlArn":{
"shape":"Arn",
- "documentation":"<p>The Amazon Resource Number (ARN) for the routing control state entry.</p>"
+ "documentation":"<p>The Amazon Resource Number (ARN) for a routing control state entry.</p>"
},
"RoutingControlState":{
"shape":"RoutingControlState",
"documentation":"<p>The routing control state in a set of routing control state entries.</p>"
}
},
- "documentation":"<p>A routing control state.</p>"
+ "documentation":"<p>A routing control state entry.</p>"
},
"UpdateRoutingControlStateRequest":{
"type":"structure",
@@ -236,6 +240,10 @@
"RoutingControlState":{
"shape":"RoutingControlState",
"documentation":"<p>The state of the routing control. You can set the value to be On or Off.</p>"
+ },
+ "SafetyRulesToOverride":{
+ "shape":"Arns",
+ "documentation":"<p>The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html\"> Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>"
}
}
},
@@ -251,6 +259,10 @@
"UpdateRoutingControlStateEntries":{
"shape":"UpdateRoutingControlStateEntries",
"documentation":"<p>A set of routing control entries that you want to update.</p>"
+ },
+ "SafetyRulesToOverride":{
+ "shape":"Arns",
+ "documentation":"<p>The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html\"> Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>"
}
}
},
@@ -304,5 +316,5 @@
]
}
},
- "documentation":"<p>Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .</p> <p>Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or get the state of routing controls. You use routing controls to failover traffic to recover your application across Availability Zones or Regions.</p> <p>This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.</p> <p>For more information about Route 53 Application Recovery Controller, see the following:</p> <ul> <li> <p>You can create clusters, routing controls, and control panels by using the control plane API for Recovery Control. For more information, see <a href=\"https://docs.aws.amazon.com/recovery-cluster/latest/api/\">Amazon Route 53 Application Recovery Controller Recovery Control API Reference</a>.</p> </li> <li> <p>Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic. For more information about the related API actions, see <a href=\"https://docs.aws.amazon.com/recovery-readiness/latest/api/\">Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference</a>.</p> </li> <li> <p>For more information about creating resilient applications and preparing for recovery readiness with Route 53 Application Recovery Controller, see the <a href=\"r53recovery/latest/dg/\">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p> </li> </ul>"
+ "documentation":"<p>Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.</p> <p>With Amazon Route 53 Application Recovery Controller, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Application Recovery Controller. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control on and another one off, to reroute traffic from one Availability Zone or Amazon Web Services Region to another. </p> <p> <i>Be aware that you must specify the Regional endpoints for a cluster when you work with API cluster operations to get or update routing control states in Application Recovery Controller.</i> In addition, you must specify the US West (Oregon) Region for Application Recovery Controller API calls. For example, use the parameter <code>region us-west-2</code> with AWS CLI commands. For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html\"> Get and update routing control states using the API</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> <p>This API guide includes information about the API operations for how to get and update routing control states in Application Recovery Controller. You also must set up the structures to support routing controls: clusters and control panels.</p> <p>For more information about working with routing control in Application Recovery Controller, see the following:</p> <ul> <li> <p>To create clusters, routing controls, and control panels by using the control plane API for routing control, see the <a href=\"https://docs.aws.amazon.com/recovery-cluster/latest/api/\">Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller</a>.</p> </li> <li> <p>Learn about the components in recovery control configuration, including clusters, routing controls, and control panels. For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing\"> Recovery control components</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p> </li> <li> <p>Application Recovery Controller also provides readiness checks that run continually to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API actions, see the <a href=\"https://docs.aws.amazon.com/recovery-readiness/latest/api/\">Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller</a>.</p> </li> <li> <p>For more information about creating resilient applications and preparing for recovery readiness with Application Recovery Controller, see the <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/\">Amazon Route 53 Application Recovery Controller Developer Guide</a>.</p> </li> </ul>"
}
diff --git a/contrib/python/botocore/py3/botocore/data/route53/2013-04-01/service-2.json b/contrib/python/botocore/py3/botocore/data/route53/2013-04-01/service-2.json
index 8b465864a7..37747203ef 100644
--- a/contrib/python/botocore/py3/botocore/data/route53/2013-04-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/route53/2013-04-01/service-2.json
@@ -52,7 +52,7 @@
{"shape":"LimitsExceeded"},
{"shape":"PriorRequestNotComplete"}
],
- "documentation":"<p>Associates an Amazon VPC with a private hosted zone. </p> <important> <p>To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.</p> </important> <note> <p>If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a <code>CreateVPCAssociationAuthorization</code> request. Then the account that created the VPC must submit an <code>AssociateVPCWithHostedZone</code> request.</p> </note>"
+ "documentation":"<p>Associates an Amazon VPC with a private hosted zone. </p> <important> <p>To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.</p> </important> <note> <p>If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a <code>CreateVPCAssociationAuthorization</code> request. Then the account that created the VPC must submit an <code>AssociateVPCWithHostedZone</code> request.</p> </note> <note> <p>When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.</p> <p>The following are the supported partitions:</p> <ul> <li> <p> <code>aws</code> - Amazon Web Services Regions</p> </li> <li> <p> <code>aws-cn</code> - China Regions</p> </li> <li> <p> <code>aws-us-gov</code> - Amazon Web Services GovCloud (US) Region</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Access Management</a> in the <i>Amazon Web Services General Reference</i>.</p> </note>"
},
"ChangeResourceRecordSets":{
"name":"ChangeResourceRecordSets",
@@ -73,7 +73,7 @@
{"shape":"InvalidInput"},
{"shape":"PriorRequestNotComplete"}
],
- "documentation":"<p>Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use <code>ChangeResourceRecordSets</code> to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.</p> <p> <b>Deleting Resource Record Sets</b> </p> <p>To delete a resource record set, you must specify all the same values that you specified when you created it.</p> <p> <b>Change Batches and Transactional Changes</b> </p> <p>The request body must include a document with a <code>ChangeResourceRecordSetsRequest</code> element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone. </p> <p>For example, suppose a change batch request contains two changes: it deletes the <code>CNAME</code> resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the <code>DELETE</code> or the <code>CREATE</code> action fails, then the request is canceled, and the original <code>CNAME</code> record continues to exist.</p> <note> <p>If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an <code>InvalidChangeBatch</code> error.</p> </note> <p> <b>Traffic Flow</b> </p> <p>To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html\">Using Traffic Flow to Route DNS Traffic</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p> <b>Create, Delete, and Upsert</b> </p> <p>Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions:</p> <ul> <li> <p> <code>CREATE</code>: Creates a resource record set that has the specified values.</p> </li> <li> <p> <code>DELETE</code>: Deletes an existing resource record set that has the specified values.</p> </li> <li> <p> <code>UPSERT</code>: If a resource record set does not already exist, Amazon Web Services creates it. If a resource set does exist, Route 53 updates it with the values in the request. </p> </li> </ul> <p> <b>Syntaxes for Creating, Updating, and Deleting Resource Record Sets</b> </p> <p>The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. </p> <p>For an example for each type of resource record set, see \"Examples.\"</p> <p>Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using <code>ChangeResourceRecordSets</code>. </p> <p> <b>Change Propagation to Route 53 DNS Servers</b> </p> <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html\">GetChange</a>.</p> <p> <b>Limits on ChangeResourceRecordSets Requests</b> </p> <p>For information about the limits on a <code>ChangeResourceRecordSets</code> request, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html\">Limits</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>"
+ "documentation":"<p>Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use <code>ChangeResourceRecordSets</code> to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.</p> <p> <b>Deleting Resource Record Sets</b> </p> <p>To delete a resource record set, you must specify all the same values that you specified when you created it.</p> <p> <b>Change Batches and Transactional Changes</b> </p> <p>The request body must include a document with a <code>ChangeResourceRecordSetsRequest</code> element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone. </p> <p>For example, suppose a change batch request contains two changes: it deletes the <code>CNAME</code> resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the <code>DELETE</code> or the <code>CREATE</code> action fails, then the request is canceled, and the original <code>CNAME</code> record continues to exist.</p> <note> <p>If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an <code>InvalidChangeBatch</code> error.</p> </note> <p> <b>Traffic Flow</b> </p> <p>To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html\">Using Traffic Flow to Route DNS Traffic</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p> <b>Create, Delete, and Upsert</b> </p> <p>Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions:</p> <ul> <li> <p> <code>CREATE</code>: Creates a resource record set that has the specified values.</p> </li> <li> <p> <code>DELETE</code>: Deletes an existing resource record set that has the specified values.</p> </li> <li> <p> <code>UPSERT</code>: If a resource set exists Route 53 updates it with the values in the request. </p> </li> </ul> <p> <b>Syntaxes for Creating, Updating, and Deleting Resource Record Sets</b> </p> <p>The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. </p> <p>For an example for each type of resource record set, see \"Examples.\"</p> <p>Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using <code>ChangeResourceRecordSets</code>. </p> <p> <b>Change Propagation to Route 53 DNS Servers</b> </p> <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html\">GetChange</a>.</p> <p> <b>Limits on ChangeResourceRecordSets Requests</b> </p> <p>For information about the limits on a <code>ChangeResourceRecordSets</code> request, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html\">Limits</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>"
},
"ChangeTagsForResource":{
"name":"ChangeTagsForResource",
@@ -140,7 +140,7 @@
{"shape":"NoSuchDelegationSet"},
{"shape":"DelegationSetNotReusable"}
],
- "documentation":"<p>Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). </p> <important> <p>You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.</p> </important> <p>For more information about charges for hosted zones, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>.</p> <p>Note the following:</p> <ul> <li> <p>You can't create a hosted zone for a top-level domain (TLD) such as .com.</p> </li> <li> <p>For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html\">NS and SOA Records that Route 53 Creates for a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the <code>DelegationSetId</code> element.</p> </li> <li> <p>If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html\">Migrating DNS Service for an Existing Domain to Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. </p> </li> </ul> <p>When you submit a <code>CreateHostedZone</code> request, the initial status of the hosted zone is <code>PENDING</code>. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to <code>INSYNC</code>.</p> <p>The <code>CreateHostedZone</code> request requires the caller to have an <code>ec2:DescribeVpcs</code> permission.</p>"
+ "documentation":"<p>Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). </p> <important> <p>You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.</p> </important> <p>For more information about charges for hosted zones, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>.</p> <p>Note the following:</p> <ul> <li> <p>You can't create a hosted zone for a top-level domain (TLD) such as .com.</p> </li> <li> <p>For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html\">NS and SOA Records that Route 53 Creates for a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the <code>DelegationSetId</code> element.</p> </li> <li> <p>If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html\">Migrating DNS Service for an Existing Domain to Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. </p> </li> </ul> <p>When you submit a <code>CreateHostedZone</code> request, the initial status of the hosted zone is <code>PENDING</code>. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to <code>INSYNC</code>.</p> <p>The <code>CreateHostedZone</code> request requires the caller to have an <code>ec2:DescribeVpcs</code> permission.</p> <note> <p>When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.</p> <p>The following are the supported partitions:</p> <ul> <li> <p> <code>aws</code> - Amazon Web Services Regions</p> </li> <li> <p> <code>aws-cn</code> - China Regions</p> </li> <li> <p> <code>aws-us-gov</code> - Amazon Web Services GovCloud (US) Region</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Access Management</a> in the <i>Amazon Web Services General Reference</i>.</p> </note>"
},
"CreateKeySigningKey":{
"name":"CreateKeySigningKey",
@@ -190,7 +190,7 @@
{"shape":"QueryLoggingConfigAlreadyExists"},
{"shape":"InsufficientCloudWatchLogsResourcePolicy"}
],
- "documentation":"<p>Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.</p> <p>DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:</p> <ul> <li> <p>Route 53 edge location that responded to the DNS query</p> </li> <li> <p>Domain or subdomain that was requested</p> </li> <li> <p>DNS record type, such as A or AAAA</p> </li> <li> <p>DNS response code, such as <code>NoError</code> or <code>ServFail</code> </p> </li> </ul> <dl> <dt>Log Group and Resource Policy</dt> <dd> <p>Before you create a query logging configuration, perform the following operations.</p> <note> <p>If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.</p> </note> <ol> <li> <p>Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:</p> <ul> <li> <p>You must create the log group in the us-east-1 region.</p> </li> <li> <p>You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.</p> </li> <li> <p>When you create log groups for query logging, we recommend that you use a consistent prefix, for example:</p> <p> <code>/aws/route53/<i>hosted zone name</i> </code> </p> <p>In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.</p> </li> </ul> </li> <li> <p>Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of <code>Resource</code>, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with <code>*</code>, for example:</p> <p> <code>arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*</code> </p> <note> <p>You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.</p> </note> </li> </ol> </dd> <dt>Log Streams and Edge Locations</dt> <dd> <p>When Route 53 finishes creating the configuration for DNS query logging, it does the following:</p> <ul> <li> <p>Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.</p> </li> <li> <p>Begins to send query logs to the applicable log stream.</p> </li> </ul> <p>The name of each log stream is in the following format:</p> <p> <code> <i>hosted zone ID</i>/<i>edge location code</i> </code> </p> <p>The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the <a href=\"http://aws.amazon.com/route53/details/\">Route 53 Product Details</a> page.</p> </dd> <dt>Queries That Are Logged</dt> <dd> <p>Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html\">Routing Internet Traffic to Your Website or Web Application</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </dd> <dt>Log File Format</dt> <dd> <p>For a list of the values in each query log and the format of each value, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html\">Logging DNS Queries</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </dd> <dt>Pricing</dt> <dd> <p>For information about charges for query logs, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> </dd> <dt>How to Stop Logging</dt> <dd> <p>If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html\">DeleteQueryLoggingConfig</a>.</p> </dd> </dl>"
+ "documentation":"<p>Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.</p> <p>DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:</p> <ul> <li> <p>Route 53 edge location that responded to the DNS query</p> </li> <li> <p>Domain or subdomain that was requested</p> </li> <li> <p>DNS record type, such as A or AAAA</p> </li> <li> <p>DNS response code, such as <code>NoError</code> or <code>ServFail</code> </p> </li> </ul> <dl> <dt>Log Group and Resource Policy</dt> <dd> <p>Before you create a query logging configuration, perform the following operations.</p> <note> <p>If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.</p> </note> <ol> <li> <p>Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:</p> <ul> <li> <p>You must create the log group in the us-east-1 region.</p> </li> <li> <p>You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.</p> </li> <li> <p>When you create log groups for query logging, we recommend that you use a consistent prefix, for example:</p> <p> <code>/aws/route53/<i>hosted zone name</i> </code> </p> <p>In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.</p> </li> </ul> </li> <li> <p>Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of <code>Resource</code>, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with <code>*</code>, for example:</p> <p> <code>arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*</code> </p> <p>To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:</p> <ul> <li> <p>For <code>aws:SourceArn</code>, supply the hosted zone ARN used in creating the query logging configuration. For example, <code>aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID</code>.</p> </li> <li> <p>For <code>aws:SourceAccount</code>, supply the account ID for the account that creates the query logging configuration. For example, <code>aws:SourceAccount:111111111111</code>.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html\">The confused deputy problem</a> in the <i>Amazon Web Services IAM User Guide</i>.</p> <note> <p>You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.</p> </note> </li> </ol> </dd> <dt>Log Streams and Edge Locations</dt> <dd> <p>When Route 53 finishes creating the configuration for DNS query logging, it does the following:</p> <ul> <li> <p>Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.</p> </li> <li> <p>Begins to send query logs to the applicable log stream.</p> </li> </ul> <p>The name of each log stream is in the following format:</p> <p> <code> <i>hosted zone ID</i>/<i>edge location code</i> </code> </p> <p>The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the <a href=\"http://aws.amazon.com/route53/details/\">Route 53 Product Details</a> page.</p> </dd> <dt>Queries That Are Logged</dt> <dd> <p>Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html\">Routing Internet Traffic to Your Website or Web Application</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </dd> <dt>Log File Format</dt> <dd> <p>For a list of the values in each query log and the format of each value, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html\">Logging DNS Queries</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </dd> <dt>Pricing</dt> <dd> <p>For information about charges for query logs, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> </dd> <dt>How to Stop Logging</dt> <dd> <p>If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html\">DeleteQueryLoggingConfig</a>.</p> </dd> </dl>"
},
"CreateReusableDelegationSet":{
"name":"CreateReusableDelegationSet",
@@ -493,7 +493,7 @@
{"shape":"LastVPCAssociation"},
{"shape":"InvalidInput"}
],
- "documentation":"<p>Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:</p> <ul> <li> <p>You can't disassociate the last Amazon VPC from a private hosted zone.</p> </li> <li> <p>You can't convert a private hosted zone into a public hosted zone.</p> </li> <li> <p>You can submit a <code>DisassociateVPCFromHostedZone</code> request using either the account that created the hosted zone or the account that created the Amazon VPC.</p> </li> <li> <p>Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.</p> <p>When you run <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html\">DisassociateVPCFromHostedZone</a>, if the hosted zone has a value for <code>OwningAccount</code>, you can use <code>DisassociateVPCFromHostedZone</code>. If the hosted zone has a value for <code>OwningService</code>, you can't use <code>DisassociateVPCFromHostedZone</code>.</p> </li> </ul>"
+ "documentation":"<p>Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:</p> <ul> <li> <p>You can't disassociate the last Amazon VPC from a private hosted zone.</p> </li> <li> <p>You can't convert a private hosted zone into a public hosted zone.</p> </li> <li> <p>You can submit a <code>DisassociateVPCFromHostedZone</code> request using either the account that created the hosted zone or the account that created the Amazon VPC.</p> </li> <li> <p>Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.</p> <p>When you run <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html\">DisassociateVPCFromHostedZone</a>, if the hosted zone has a value for <code>OwningAccount</code>, you can use <code>DisassociateVPCFromHostedZone</code>. If the hosted zone has a value for <code>OwningService</code>, you can't use <code>DisassociateVPCFromHostedZone</code>.</p> </li> </ul> <note> <p>When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.</p> <p>The following are the supported partitions:</p> <ul> <li> <p> <code>aws</code> - Amazon Web Services Regions</p> </li> <li> <p> <code>aws-cn</code> - China Regions</p> </li> <li> <p> <code>aws-us-gov</code> - Amazon Web Services GovCloud (US) Region</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Access Management</a> in the <i>Amazon Web Services General Reference</i>.</p> </note>"
},
"EnableHostedZoneDNSSEC":{
"name":"EnableHostedZoneDNSSEC",
@@ -826,7 +826,7 @@
{"shape":"InvalidInput"},
{"shape":"InvalidPaginationToken"}
],
- "documentation":"<p>Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The <code>HostedZoneOwner</code> structure in the response contains one of the following values:</p> <ul> <li> <p>An <code>OwningAccount</code> element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account. </p> </li> <li> <p>An <code>OwningService</code> element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of <code>Owner</code> is <code>efs.amazonaws.com</code>. </p> </li> </ul>"
+ "documentation":"<p>Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The <code>HostedZoneOwner</code> structure in the response contains one of the following values:</p> <ul> <li> <p>An <code>OwningAccount</code> element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account. </p> </li> <li> <p>An <code>OwningService</code> element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of <code>Owner</code> is <code>efs.amazonaws.com</code>. </p> </li> </ul> <note> <p>When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.</p> <p>The following are the supported partitions:</p> <ul> <li> <p> <code>aws</code> - Amazon Web Services Regions</p> </li> <li> <p> <code>aws-cn</code> - China Regions</p> </li> <li> <p> <code>aws-us-gov</code> - Amazon Web Services GovCloud (US) Region</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Access Management</a> in the <i>Amazon Web Services General Reference</i>.</p> </note>"
},
"ListQueryLoggingConfigs":{
"name":"ListQueryLoggingConfigs",
diff --git a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.json b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.json
index d6c97ba480..e5aa3c59ce 100644
--- a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.json
@@ -60,6 +60,7 @@
"input_token": "PartNumberMarker",
"result_key": "Parts",
"non_aggregate_keys": [
+ "ChecksumAlgorithm",
"Initiator",
"Owner",
"StorageClass"
diff --git a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json
index 1298143c68..15426cf7ee 100644
--- a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json
@@ -51,7 +51,7 @@
{"shape":"ObjectNotInActiveTierError"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html",
- "documentation":"<p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html\">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>All copy requests must be authenticated. Additionally, you must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.</p> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. This means that a <code>200 OK</code> response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.</p> <p>If the copy is successful, you receive a response with information about the copied object.</p> <note> <p>If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.</p> </note> <p>The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see <a href=\"http://aws.amazon.com/s3/pricing/\">Amazon S3 pricing</a>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 <code>Bad Request</code> error. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> </important> <p> <b>Metadata</b> </p> <p>When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. </p> <p>To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the <code>x-amz-metadata-directive</code> header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> condition key to enforce certain metadata behavior when objects are uploaded. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html\">Specifying Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list of Amazon S3-specific condition keys, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html\">Actions, Resources, and Condition Keys for Amazon S3</a>.</p> <p> <b> <code>x-amz-copy-source-if</code> Headers</b> </p> <p>To only copy an object under certain conditions, such as whether the <code>Etag</code> matches or whether the object was modified before or after a specified date, use the following request parameters:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-none-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> </p> </li> </ul> <p> If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to true</p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false</p> </li> </ul> <p>If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response code:</p> <ul> <li> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true</p> </li> </ul> <note> <p>All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed.</p> </note> <p> <b>Server-side encryption</b> </p> <p>When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Using Server-Side Encryption</a>.</p> <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html\">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Storage Class Options</b> </p> <p>You can use the <code>CopyObject</code> action to change the storage class of an object that is already stored in Amazon S3 using the <code>StorageClass</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>By default, <code>x-amz-copy-source</code> identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the <code>versionId</code> subresource.</p> <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the <code>x-amz-version-id</code> response header in the response.</p> <p>If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.</p> <p>If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a>.</p> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html\">Copying Objects</a>.</p>",
+ "documentation":"<p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html\">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>All copy requests must be authenticated. Additionally, you must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.</p> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. This means that a <code>200 OK</code> response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.</p> <p>If the copy is successful, you receive a response with information about the copied object.</p> <note> <p>If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.</p> </note> <p>The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see <a href=\"http://aws.amazon.com/s3/pricing/\">Amazon S3 pricing</a>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 <code>Bad Request</code> error. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> </important> <p> <b>Metadata</b> </p> <p>When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. </p> <p>To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the <code>x-amz-metadata-directive</code> header. When you grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> condition key to enforce certain metadata behavior when objects are uploaded. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html\">Specifying Conditions in a Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list of Amazon S3-specific condition keys, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html\">Actions, Resources, and Condition Keys for Amazon S3</a>.</p> <p> <b>x-amz-copy-source-if Headers</b> </p> <p>To only copy an object under certain conditions, such as whether the <code>Etag</code> matches or whether the object was modified before or after a specified date, use the following request parameters:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-none-match</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> </p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> </p> </li> </ul> <p> If both the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p> <ul> <li> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to true</p> </li> <li> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to false</p> </li> </ul> <p>If both the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response code:</p> <ul> <li> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p> </li> <li> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to true</p> </li> </ul> <note> <p>All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed.</p> </note> <p> <b>Server-side encryption</b> </p> <p>When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Using Server-Side Encryption</a>.</p> <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html\">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Checksums</b> </p> <p>When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> header.</p> <p> <b>Storage Class Options</b> </p> <p>You can use the <code>CopyObject</code> action to change the storage class of an object that is already stored in Amazon S3 using the <code>StorageClass</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>By default, <code>x-amz-copy-source</code> identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the <code>versionId</code> subresource.</p> <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the <code>x-amz-version-id</code> response header in the response.</p> <p>If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.</p> <p>If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a>.</p> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html\">Copying Objects</a>.</p>",
"alias":"PutObjectCopy"
},
"CreateBucket":{
@@ -79,7 +79,7 @@
"input":{"shape":"CreateMultipartUploadRequest"},
"output":{"shape":"CreateMultipartUploadOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html",
- "documentation":"<p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request.</p> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a>.</p> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a>.</p> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (Amazon Web Services Signature Version 4)</a>.</p> <note> <p> After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> requests must match the headers you used in the request to initiate the upload by using <code>CreateMultipartUpload</code>. </p> <p>To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a>.</p> <dl> <dt>Access Permissions</dt> <dd> <p>When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption</p> </li> <li> <p>x-amz-server-side-encryption-aws-kms-key-id</p> </li> <li> <p>x-amz-server-side-encryption-context</p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.</p> </note> <important> <p>All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with KMS key (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about server-side encryption with KMS keys (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:</p> <ul> <li> <p>x-amz-grant-read</p> </li> <li> <p>x-amz-grant-write</p> </li> <li> <p>x-amz-grant-read-acp</p> </li> <li> <p>x-amz-grant-write-acp</p> </li> <li> <p>x-amz-grant-full-control</p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" </code> </p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>",
+ "documentation":"<p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request.</p> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a>.</p> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p> <p>For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a>.</p> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (Amazon Web Services Signature Version 4)</a>.</p> <note> <p> After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> requests must match the headers you used in the request to initiate the upload by using <code>CreateMultipartUpload</code>. </p> <p>To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a>.</p> <dl> <dt>Access Permissions</dt> <dd> <p>When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> </dd> <dt>Server-Side- Encryption-Specific Request Headers</dt> <dd> <p>You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use Amazon Web Services managed encryption keys or provide your own encryption key. </p> <ul> <li> <p>Use encryption keys managed by Amazon S3 or customer managed key stored in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-context</code> </p> </li> </ul> <note> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services KMS to protect the data.</p> </note> <important> <p>All GET and PUT requests for an object protected by Amazon Web Services KMS fail if you don't make them with SSL or by using SigV4.</p> </important> <p>For more information about server-side encryption with KMS key (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> <li> <p>Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about server-side encryption with KMS keys (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with KMS keys</a>.</p> </li> </ul> </dd> <dt>Access-Control-List (ACL)-Specific Request Headers</dt> <dd> <p>You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. With this operation, you can grant access permissions using one of the following two methods:</p> <ul> <li> <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:</p> <ul> <li> <p> <code>x-amz-grant-read</code> </p> </li> <li> <p> <code>x-amz-grant-write</code> </p> </li> <li> <p> <code>x-amz-grant-read-acp</code> </p> </li> <li> <p> <code>x-amz-grant-write-acp</code> </p> </li> <li> <p> <code>x-amz-grant-full-control</code> </p> </li> </ul> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:</p> <p> <code>x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" </code> </p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>",
"alias":"InitiateMultipartUpload"
},
"DeleteBucket":{
@@ -252,7 +252,10 @@
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html",
"documentation":"<p>This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p> <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.</p> <p> The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.</p> <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete\"> MFA Delete</a>.</p> <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p> <p>The following operations are related to <code>DeleteObjects</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> </ul>",
"alias":"DeleteMultipleObjects",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"DeletePublicAccessBlock":{
"name":"DeletePublicAccessBlock",
@@ -304,7 +307,7 @@
"input":{"shape":"GetBucketCorsRequest"},
"output":{"shape":"GetBucketCorsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html",
- "documentation":"<p>Returns the cors configuration information set for the bucket.</p> <p> To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.</p> <p> For more information about cors, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\"> Enabling Cross-Origin Resource Sharing</a>.</p> <p>The following operations are related to <code>GetBucketCors</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html\">PutBucketCors</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html\">DeleteBucketCors</a> </p> </li> </ul>"
+ "documentation":"<p>Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.</p> <p> To use this operation, you must have permission to perform the <code>s3:GetBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p> For more information about CORS, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\"> Enabling Cross-Origin Resource Sharing</a>.</p> <p>The following operations are related to <code>GetBucketCors</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html\">PutBucketCors</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html\">DeleteBucketCors</a> </p> </li> </ul>"
},
"GetBucketEncryption":{
"name":"GetBucketEncryption",
@@ -473,7 +476,7 @@
"input":{"shape":"GetBucketTaggingRequest"},
"output":{"shape":"GetBucketTaggingOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html",
- "documentation":"<p>Returns the tag set associated with the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSetError</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html\">PutBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>"
+ "documentation":"<p>Returns the tag set associated with the bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSet</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html\">PutBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>"
},
"GetBucketVersioning":{
"name":"GetBucketVersioning",
@@ -510,7 +513,16 @@
{"shape":"InvalidObjectState"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html",
- "documentation":"<p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> access to the object. If you grant <code>READ</code> access to the anonymous user, you can return the object without using an authorization header.</p> <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>.</p> <p>To get an object from such a logical hierarchy, specify the full key name for the object in the <code>GET</code> operation. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket\">HTTP Host Header Bucket Specification</a>.</p> <p>To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html\">Amazon S3 Torrent</a>. For more information about returning the ACL of an object, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a>.</p> <p>If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a>. Otherwise, this action returns an <code>InvalidObjectStateError</code> error. For information about restoring archived objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a>.</p> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <p>Assuming you have the relevant permission to read object tags, the response also returns the <code>x-amz-tagging-count</code> header that provides the count of number of tags associated with the object. You can use <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a> to retrieve the tag set associated with an object.</p> <p> <b>Permissions</b> </p> <p>You need the relevant read object (or version) permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.</p> </li> </ul> <p> <b>Versioning</b> </p> <p>By default, the GET action returns the current version of an object. To return a different version, use the <code>versionId</code> subresource.</p> <note> <ul> <li> <p> If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> permission to access a specific version of an object. If you request a specific version, you do not need to have the <code>s3:GetObject</code> permission. </p> </li> <li> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </li> </ul> </note> <p>For more information about versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html\">PutBucketVersioning</a>. </p> <p> <b>Overriding Response Header Values</b> </p> <p>There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.</p> <p>You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are <code>Content-Type</code>, <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these header values in the GET response, you use the following request parameters.</p> <note> <p>You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.</p> </note> <ul> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> </ul> <p> <b>Additional Considerations about Request Headers</b> </p> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows: <code>If-Match</code> condition evaluates to <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; then, S3 returns 200 OK and the data requested. </p> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:<code> If-None-Match</code> condition evaluates to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to <code>true</code>; then, S3 returns 304 Not Modified response code.</p> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html\">ListBuckets</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> </ul>"
+ "documentation":"<p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code> access to the object. If you grant <code>READ</code> access to the anonymous user, you can return the object without using an authorization header.</p> <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>, you can name it <code>photos/2006/February/sample.jpg</code>.</p> <p>To get an object from such a logical hierarchy, specify the full key name for the object in the <code>GET</code> operation. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the resource as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the resource as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket\">HTTP Host Header Bucket Specification</a>.</p> <p>For more information about returning the ACL of an object, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a>.</p> <p>If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a>. Otherwise, this action returns an <code>InvalidObjectStateError</code> error. For information about restoring archived objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a>.</p> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <p>Assuming you have the relevant permission to read object tags, the response also returns the <code>x-amz-tagging-count</code> header that provides the count of number of tags associated with the object. You can use <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a> to retrieve the tag set associated with an object.</p> <p> <b>Permissions</b> </p> <p>You need the relevant read object (or version) permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.</p> </li> </ul> <p> <b>Versioning</b> </p> <p>By default, the GET action returns the current version of an object. To return a different version, use the <code>versionId</code> subresource.</p> <note> <ul> <li> <p> If you supply a <code>versionId</code>, you need the <code>s3:GetObjectVersion</code> permission to access a specific version of an object. If you request a specific version, you do not need to have the <code>s3:GetObject</code> permission. </p> </li> <li> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </li> </ul> </note> <p>For more information about versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html\">PutBucketVersioning</a>. </p> <p> <b>Overriding Response Header Values</b> </p> <p>There are times when you want to override certain response header values in a GET response. For example, you might override the <code>Content-Disposition</code> response header value in your GET request.</p> <p>You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are <code>Content-Type</code>, <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>, <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these header values in the GET response, you use the following request parameters.</p> <note> <p>You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.</p> </note> <ul> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> </ul> <p> <b>Additional Considerations about Request Headers</b> </p> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows: <code>If-Match</code> condition evaluates to <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>; then, S3 returns 200 OK and the data requested. </p> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:<code> If-None-Match</code> condition evaluates to <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to <code>true</code>; then, S3 returns 304 Not Modified response code.</p> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html\">ListBuckets</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestValidationModeMember":"ChecksumMode",
+ "responseAlgorithms":[
+ "CRC32",
+ "CRC32C",
+ "SHA256",
+ "SHA1"
+ ]
+ }
},
"GetObjectAcl":{
"name":"GetObjectAcl",
@@ -524,7 +536,20 @@
{"shape":"NoSuchKey"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html",
- "documentation":"<p>Returns the access control list (ACL) of an object. To use this operation, you must have <code>READ_ACP</code> access to the object.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p> <b>Versioning</b> </p> <p>By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.</p> <note> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner being the account that created the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>The following operations are related to <code>GetObjectAcl</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> </ul>"
+ "documentation":"<p>Returns the access control list (ACL) of an object. To use this operation, you must have <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping\">Mapping of ACL permissions and access policy permissions</a> in the <i>Amazon S3 User Guide</i> </p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p> <b>Versioning</b> </p> <p>By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.</p> <note> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code> ACL with the owner being the account that created the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\"> Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>The following operations are related to <code>GetObjectAcl</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> </ul>"
+ },
+ "GetObjectAttributes":{
+ "name":"GetObjectAttributes",
+ "http":{
+ "method":"GET",
+ "requestUri":"/{Bucket}/{Key+}?attributes"
+ },
+ "input":{"shape":"GetObjectAttributesRequest"},
+ "output":{"shape":"GetObjectAttributesOutput"},
+ "errors":[
+ {"shape":"NoSuchKey"}
+ ],
+ "documentation":"<p>Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use <code>GetObjectAttributes</code>, you must have READ access to the object.</p> <p> <code>GetObjectAttributes</code> combines the functionality of <code>GetObjectAcl</code>, <code>GetObjectLegalHold</code>, <code>GetObjectLockConfiguration</code>, <code>GetObjectRetention</code>, <code>GetObjectTagging</code>, <code>HeadObject</code>, and <code>ListParts</code>. All of the data returned with each of those individual calls can be returned with a single call to <code>GetObjectAttributes</code>.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:</p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <ul> <li> <p>Encryption request headers, such as <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP <code>400 Bad Request</code> error.</p> </li> <li> <p> The last modified property in this case is the creation date of the object.</p> </li> </ul> </note> <p>Consider the following when using request headers:</p> <ul> <li> <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <code>200 OK</code> and the data requested:</p> <ul> <li> <p> <code>If-Match</code> condition evaluates to <code>true</code>.</p> </li> <li> <p> <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>.</p> </li> </ul> </li> <li> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <code>304 Not Modified</code>:</p> <ul> <li> <p> <code>If-None-Match</code> condition evaluates to <code>false</code>.</p> </li> <li> <p> <code>If-Modified-Since</code> condition evaluates to <code>true</code>.</p> </li> </ul> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p> <b>Permissions</b> </p> <p>The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If the bucket is not versioned, you need the <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> (\"no such key\") error.</p> </li> <li> <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Forbidden</code> (\"access denied\") error.</p> </li> </ul> <p>The following actions are related to <code>GetObjectAttributes</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html\">GetObjectLegalHold</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html\">GetObjectLockConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html\">GetObjectRetention</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html\">HeadObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> </ul>"
},
"GetObjectLegalHold":{
"name":"GetObjectLegalHold",
@@ -534,7 +559,7 @@
},
"input":{"shape":"GetObjectLegalHoldRequest"},
"output":{"shape":"GetObjectLegalHoldOutput"},
- "documentation":"<p>Gets an object's current Legal Hold status. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p>"
+ "documentation":"<p>Gets an object's current legal hold status. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>The following action is related to <code>GetObjectLegalHold</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> </ul>"
},
"GetObjectLockConfiguration":{
"name":"GetObjectLockConfiguration",
@@ -544,7 +569,7 @@
},
"input":{"shape":"GetObjectLockConfigurationRequest"},
"output":{"shape":"GetObjectLockConfigurationOutput"},
- "documentation":"<p>Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p>"
+ "documentation":"<p>Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> </ul>"
},
"GetObjectRetention":{
"name":"GetObjectRetention",
@@ -554,7 +579,7 @@
},
"input":{"shape":"GetObjectRetentionRequest"},
"output":{"shape":"GetObjectRetentionOutput"},
- "documentation":"<p>Retrieves an object's retention settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p>"
+ "documentation":"<p>Retrieves an object's retention settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>The following action is related to <code>GetObjectRetention</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> </ul>"
},
"GetObjectTagging":{
"name":"GetObjectTagging",
@@ -564,7 +589,7 @@
},
"input":{"shape":"GetObjectTaggingRequest"},
"output":{"shape":"GetObjectTaggingOutput"},
- "documentation":"<p>Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code> action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code> action.</p> <p> By default, the bucket owner has this permission and can grant this permission to others.</p> <p> For information about the Amazon S3 object tagging feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</p> <p>The following action is related to <code>GetObjectTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html\">PutObjectTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html\">DeleteObjectTagging</a> </p> </li> </ul>"
+ "documentation":"<p>Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetObjectTagging</code> action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code> action.</p> <p> By default, the bucket owner has this permission and can grant this permission to others.</p> <p> For information about the Amazon S3 object tagging feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</p> <p>The following actions are related to <code>GetObjectTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html\">DeleteObjectTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html\">PutObjectTagging</a> </p> </li> </ul>"
},
"GetObjectTorrent":{
"name":"GetObjectTorrent",
@@ -612,7 +637,7 @@
{"shape":"NoSuchKey"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html",
- "documentation":"<p>The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.</p> <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an object. The response is identical to the <code>GET</code> response except that there is no response body. Because of this, if the <code>HEAD</code> request generates an error, it returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. It is not possible to retrieve the exact exception beyond these error codes.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <note> <ul> <li> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> </li> <li> <p> The last modified property in this case is the creation date of the object.</p> </li> </ul> </note> <p>Request headers are limited to 8 KB in size. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html\">Common Request Headers</a>.</p> <p>Consider the following when using request headers:</p> <ul> <li> <p> Consideration 1 – If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows:</p> <ul> <li> <p> <code>If-Match</code> condition evaluates to <code>true</code>, and;</p> </li> <li> <p> <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>;</p> </li> </ul> <p>Then Amazon S3 returns <code>200 OK</code> and the data requested.</p> </li> <li> <p> Consideration 2 – If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:</p> <ul> <li> <p> <code>If-None-Match</code> condition evaluates to <code>false</code>, and;</p> </li> <li> <p> <code>If-Modified-Since</code> condition evaluates to <code>true</code>;</p> </li> </ul> <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p> <b>Permissions</b> </p> <p>You need the relevant read object (or version) permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"no such key\") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.</p> </li> </ul> <p>The following action is related to <code>HeadObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> </ul>"
+ "documentation":"<p>The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.</p> <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an object. The response is identical to the <code>GET</code> response except that there is no response body. Because of this, if the <code>HEAD</code> request generates an error, it returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. It is not possible to retrieve the exact exception beyond these error codes.</p> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a>.</p> <note> <ul> <li> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p> </li> <li> <p> The last modified property in this case is the creation date of the object.</p> </li> </ul> </note> <p>Request headers are limited to 8 KB in size. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html\">Common Request Headers</a>.</p> <p>Consider the following when using request headers:</p> <ul> <li> <p> Consideration 1 – If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows:</p> <ul> <li> <p> <code>If-Match</code> condition evaluates to <code>true</code>, and;</p> </li> <li> <p> <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>;</p> </li> </ul> <p>Then Amazon S3 returns <code>200 OK</code> and the data requested.</p> </li> <li> <p> Consideration 2 – If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows:</p> <ul> <li> <p> <code>If-None-Match</code> condition evaluates to <code>false</code>, and;</p> </li> <li> <p> <code>If-Modified-Since</code> condition evaluates to <code>true</code>;</p> </li> </ul> <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <p> <b>Permissions</b> </p> <p>You need the relevant read object (or version) permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"no such key\") error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.</p> </li> </ul> <p>The following actions are related to <code>HeadObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> </ul>"
},
"ListBucketAnalyticsConfigurations":{
"name":"ListBucketAnalyticsConfigurations",
@@ -662,7 +687,7 @@
},
"output":{"shape":"ListBucketsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html",
- "documentation":"<p>Returns a list of all buckets owned by the authenticated sender of the request.</p>",
+ "documentation":"<p>Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the <code>s3:ListAllMyBuckets</code> permission.</p>",
"alias":"GetService"
},
"ListMultipartUploads":{
@@ -738,7 +763,7 @@
"input":{"shape":"ListPartsRequest"},
"output":{"shape":"ListPartsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html",
- "documentation":"<p>Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code> requests you can include the part-number-marker query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>For more information on multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a>.</p> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>"
+ "documentation":"<p>Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true, and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code> requests you can include the part-number-marker query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>If the upload was created using a checksum algorithm, you will need to have permission to the <code>kms:Decrypt</code> action for the request to succeed. </p> <p>For more information on multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a>.</p> <p>For information on permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a>.</p> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>"
},
"PutBucketAccelerateConfiguration":{
"name":"PutBucketAccelerateConfiguration",
@@ -747,7 +772,11 @@
"requestUri":"/{Bucket}?accelerate"
},
"input":{"shape":"PutBucketAccelerateConfigurationRequest"},
- "documentation":"<p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p> <p> To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> The Transfer Acceleration state of a bucket can be set to one of the following two values:</p> <ul> <li> <p> Enabled – Enables accelerated data transfers to the bucket.</p> </li> <li> <p> Suspended – Disables accelerated data transfers to the bucket.</p> </li> </ul> <p>The <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html\">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state of a bucket.</p> <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.</p> <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").</p> <p> For more information about transfer acceleration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> <p>The following operations are related to <code>PutBucketAccelerateConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html\">GetBucketAccelerateConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> </ul>"
+ "documentation":"<p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p> <p> To use this operation, you must have permission to perform the <code>s3:PutAccelerateConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> The Transfer Acceleration state of a bucket can be set to one of the following two values:</p> <ul> <li> <p> Enabled – Enables accelerated data transfers to the bucket.</p> </li> <li> <p> Suspended – Disables accelerated data transfers to the bucket.</p> </li> </ul> <p>The <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html\">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state of a bucket.</p> <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.</p> <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").</p> <p> For more information about transfer acceleration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> <p>The following operations are related to <code>PutBucketAccelerateConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html\">GetBucketAccelerateConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":false
+ }
},
"PutBucketAcl":{
"name":"PutBucketAcl",
@@ -758,7 +787,10 @@
"input":{"shape":"PutBucketAclRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html",
"documentation":"<p>Sets the permissions on an existing bucket using access control lists (ACL). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Using ACLs</a>. To set the ACL of a bucket, you must have <code>WRITE_ACP</code> permission.</p> <p>You can use one of the following two ways to set a bucket's permissions:</p> <ul> <li> <p>Specify the ACL in the request body</p> </li> <li> <p>Specify permissions using request headers</p> </li> </ul> <note> <p>You cannot specify access permission using both the body and the request headers.</p> </note> <p>Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.</p> <important> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-acl</code>. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-write</code> header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.</p> <p> <code>x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt;</code> </p> <p>DisplayName is optional and ignored in the request</p> </li> <li> <p>By URI:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt;</code> </p> </li> <li> <p>By Email address:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;lt;/Grantee&gt;</code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. </p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketAnalyticsConfiguration":{
"name":"PutBucketAnalyticsConfiguration",
@@ -778,7 +810,10 @@
"input":{"shape":"PutBucketCorsRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html",
"documentation":"<p>Sets the <code>cors</code> configuration for your bucket. If the configuration exists, Amazon S3 replaces it.</p> <p>To use this operation, you must be allowed to perform the <code>s3:PutBucketCORS</code> action. By default, the bucket owner has this permission and can grant it to others.</p> <p>You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is <code>http://www.example.com</code> to access your Amazon S3 bucket at <code>my.example.bucket.com</code> by using the browser's <code>XMLHttpRequest</code> capability.</p> <p>To enable cross-origin resource sharing (CORS) on a bucket, you add the <code>cors</code> subresource to the bucket. The <code>cors</code> subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. </p> <p>When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the <code>cors</code> configuration on the bucket and uses the first <code>CORSRule</code> rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:</p> <ul> <li> <p>The request's <code>Origin</code> header must match <code>AllowedOrigin</code> elements.</p> </li> <li> <p>The request method (for example, GET, PUT, HEAD, and so on) or the <code>Access-Control-Request-Method</code> header in case of a pre-flight <code>OPTIONS</code> request must be one of the <code>AllowedMethod</code> elements. </p> </li> <li> <p>Every header specified in the <code>Access-Control-Request-Headers</code> request header of a pre-flight request must match an <code>AllowedHeader</code> element. </p> </li> </ul> <p> For more information about CORS, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html\">Enabling Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html\">GetBucketCors</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html\">DeleteBucketCors</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html\">RESTOPTIONSobject</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketEncryption":{
"name":"PutBucketEncryption",
@@ -787,8 +822,11 @@
"requestUri":"/{Bucket}?encryption"
},
"input":{"shape":"PutBucketEncryptionRequest"},
- "documentation":"<p>This action uses the <code>encryption</code> subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.</p> <p>Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">Amazon S3 default bucket encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about S3 Bucket Keys, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon S3 User Guide. </p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html\">GetBucketEncryption</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html\">DeleteBucketEncryption</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "documentation":"<p>This action uses the <code>encryption</code> subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket.</p> <p>Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3 uses the default Amazon Web Services managed KMS key for your account. For information about default encryption, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">Amazon S3 default bucket encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about S3 Bucket Keys, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p> </important> <p>To use this operation, you must have permissions to perform the <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the Amazon S3 User Guide. </p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html\">GetBucketEncryption</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html\">DeleteBucketEncryption</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketIntelligentTieringConfiguration":{
"name":"PutBucketIntelligentTieringConfiguration",
@@ -818,7 +856,10 @@
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html",
"documentation":"<important> <p>For an updated version of this API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a>. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. </p> </important> <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in the <i>Amazon S3 User Guide</i>. </p> <p>By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples\">Examples of Lifecycle Configuration</a>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html\">GetBucketLifecycle</a>(Deprecated)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a> </p> </li> <li> <p>By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> </p> </li> </ul> </li> </ul>",
"deprecated":true,
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketLifecycleConfiguration":{
"name":"PutBucketLifecycleConfiguration",
@@ -827,8 +868,11 @@
"requestUri":"/{Bucket}?lifecycle"
},
"input":{"shape":"PutBucketLifecycleConfigurationRequest"},
- "documentation":"<p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html\">Managing your storage lifecycle</a>.</p> <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html\">PutBucketLifecycle</a>.</p> </note> <p> <b>Rules</b> </p> <p>You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:</p> <ul> <li> <p>Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.</p> </li> <li> <p>Status whether the rule is in effect.</p> </li> <li> <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html\">Lifecycle Configuration Elements</a>.</p> <p> <b>Permissions</b> </p> <p>By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.</p> <p>You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:</p> <ul> <li> <p>s3:DeleteObject</p> </li> <li> <p>s3:DeleteObjectVersion</p> </li> <li> <p>s3:PutLifecycleConfiguration</p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html\">Examples of Lifecycle Configuration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html\">DeleteBucketLifecycle</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "documentation":"<p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html\">Managing your storage lifecycle</a>.</p> <note> <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html\">PutBucketLifecycle</a>.</p> </note> <p> <b>Rules</b> </p> <p>You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:</p> <ul> <li> <p>Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.</p> </li> <li> <p>Status whether the rule is in effect.</p> </li> <li> <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html\">Lifecycle Configuration Elements</a>.</p> <p> <b>Permissions</b> </p> <p>By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:</p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html\">Examples of Lifecycle Configuration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html\">DeleteBucketLifecycle</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketLogging":{
"name":"PutBucketLogging",
@@ -839,7 +883,10 @@
"input":{"shape":"PutBucketLoggingRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html",
"documentation":"<p>Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.</p> <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> request element to grant access to other people. The <code>Permissions</code> request element specifies the kind of access the grantee has to the logs.</p> <important> <p>If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the <code>Grantee</code> request element to grant access to others. Permissions can only be granted using policies. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general\">Permissions for server access log delivery</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt;</code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By Email address:</p> <p> <code> &lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;&lt;/Grantee&gt;</code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> </li> <li> <p>By URI:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt;</code> </p> </li> </ul> <p>To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:</p> <p> <code>&lt;BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" /&gt;</code> </p> <p>For more information about server access logging, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html\">Server Access Logging</a> in the <i>Amazon S3 User Guide</i>. </p> <p>For more information about creating a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a>. For more information about returning the logging status of a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html\">GetBucketLogging</a>.</p> <p>The following operations are related to <code>PutBucketLogging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html\">GetBucketLogging</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketMetricsConfiguration":{
"name":"PutBucketMetricsConfiguration",
@@ -860,7 +907,10 @@
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html",
"documentation":"<p> No longer used, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html\">PutBucketNotificationConfiguration</a> operation.</p>",
"deprecated":true,
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketNotificationConfiguration":{
"name":"PutBucketNotificationConfiguration",
@@ -869,7 +919,7 @@
"requestUri":"/{Bucket}?notification"
},
"input":{"shape":"PutBucketNotificationConfigurationRequest"},
- "documentation":"<p>Enables notifications of specified events for a bucket. For more information about event notifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a>.</p> <p>Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.</p> <p>By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty <code>NotificationConfiguration</code>.</p> <p> <code>&lt;NotificationConfiguration&gt;</code> </p> <p> <code>&lt;/NotificationConfiguration&gt;</code> </p> <p>This action replaces the existing notification configuration with the configuration you include in the request body.</p> <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Notifications for Amazon S3 Events</a>.</p> <p>You can disable notifications by adding the empty NotificationConfiguration element.</p> <p>By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with <code>s3:PutBucketNotification</code> permission.</p> <note> <p>The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.</p> </note> <p> <b>Responses</b> </p> <p>If the configuration in the request body includes only one <code>TopicConfiguration</code> specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test notification sent to the topic.</p> <p>The following action is related to <code>PutBucketNotificationConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html\">GetBucketNotificationConfiguration</a> </p> </li> </ul>"
+ "documentation":"<p>Enables notifications of specified events for a bucket. For more information about event notifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a>.</p> <p>Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.</p> <p>By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty <code>NotificationConfiguration</code>.</p> <p> <code>&lt;NotificationConfiguration&gt;</code> </p> <p> <code>&lt;/NotificationConfiguration&gt;</code> </p> <p>This action replaces the existing notification configuration with the configuration you include in the request body.</p> <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Notifications for Amazon S3 Events</a>.</p> <p>You can disable notifications by adding the empty NotificationConfiguration element.</p> <p>For more information about the number of event notification configurations that you can create per bucket, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3\">Amazon S3 service quotas</a> in <i>Amazon Web Services General Reference</i>.</p> <p>By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with <code>s3:PutBucketNotification</code> permission.</p> <note> <p>The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.</p> </note> <p> <b>Responses</b> </p> <p>If the configuration in the request body includes only one <code>TopicConfiguration</code> specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test notification sent to the topic.</p> <p>The following action is related to <code>PutBucketNotificationConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html\">GetBucketNotificationConfiguration</a> </p> </li> </ul>"
},
"PutBucketOwnershipControls":{
"name":"PutBucketOwnershipControls",
@@ -879,7 +929,7 @@
},
"input":{"shape":"PutBucketOwnershipControlsRequest"},
"documentation":"<p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html\">Specifying permissions in a policy</a>. </p> <p>For information about Amazon S3 Object Ownership, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html\">Using object ownership</a>. </p> <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p> <ul> <li> <p> <a>GetBucketOwnershipControls</a> </p> </li> <li> <p> <a>DeleteBucketOwnershipControls</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{"requestChecksumRequired":true}
},
"PutBucketPolicy":{
"name":"PutBucketPolicy",
@@ -890,7 +940,10 @@
"input":{"shape":"PutBucketPolicyRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html",
"documentation":"<p>Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p> As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. </p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html\">Bucket policy examples</a>.</p> <p>The following operations are related to <code>PutBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketReplication":{
"name":"PutBucketReplication",
@@ -900,7 +953,10 @@
},
"input":{"shape":"PutBucketReplicationRequest"},
"documentation":"<p> Creates a replication configuration or replaces an existing one. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html\">Replication</a> in the <i>Amazon S3 User Guide</i>. </p> <p>Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.</p> <p>A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.</p> <p>To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: <code>DeleteMarkerReplication</code>, <code>Status</code>, and <code>Priority</code>.</p> <note> <p>If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations\">Backward Compatibility</a>.</p> </note> <p>For information about enabling versioning on a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html\">Using Versioning</a>.</p> <p> <b>Handling Replication of Encrypted Objects</b> </p> <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>, <code>Status</code>, <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. For information about replication configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html\">Replicating Objects Created with SSE Using KMS keys</a>.</p> <p>For information on <code>PutBucketReplication</code> errors, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList\">List of replication-related error codes</a> </p> <p> <b>Permissions</b> </p> <p>To create a <code>PutBucketReplication</code> request, you must have <code>s3:PutReplicationConfiguration</code> permissions for the bucket. </p> <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <note> <p>To perform this operation, the user or role performing the action must have the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html\">iam:PassRole</a> permission.</p> </note> <p>The following operations are related to <code>PutBucketReplication</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html\">GetBucketReplication</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html\">DeleteBucketReplication</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketRequestPayment":{
"name":"PutBucketRequestPayment",
@@ -911,7 +967,10 @@
"input":{"shape":"PutBucketRequestPaymentRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html",
"documentation":"<p>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a>.</p> <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html\">GetBucketRequestPayment</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketTagging":{
"name":"PutBucketTagging",
@@ -922,7 +981,10 @@
"input":{"shape":"PutBucketTaggingRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html",
"documentation":"<p>Sets the tags for a bucket.</p> <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Cost Allocation and Tagging</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html\">Using Cost Allocation in Amazon S3 Bucket Tags</a>.</p> <note> <p> When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.</p> </note> <p>To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>PutBucketTagging</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>InvalidTagError</code> </p> <ul> <li> <p>Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> and <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html\">Amazon Web Services-Generated Cost Allocation Tag Restrictions</a>.</p> </li> </ul> </li> <li> <p>Error code: <code>MalformedXMLError</code> </p> <ul> <li> <p>Description: The XML provided does not match the schema.</p> </li> </ul> </li> <li> <p>Error code: <code>OperationAbortedError </code> </p> <ul> <li> <p>Description: A conflicting conditional action is currently in progress against this resource. Please try again.</p> </li> </ul> </li> <li> <p>Error code: <code>InternalError</code> </p> <ul> <li> <p>Description: The service was unable to apply the provided tag to the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>PutBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html\">GetBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketVersioning":{
"name":"PutBucketVersioning",
@@ -932,8 +994,11 @@
},
"input":{"shape":"PutBucketVersioningRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html",
- "documentation":"<p>Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> request does not return a versioning state value.</p> <p>If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config\">Lifecycle and Versioning</a>.</p> </important> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "documentation":"<p>Sets the versioning state of an existing bucket.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> request does not return a versioning state value.</p> <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config\">Lifecycle and Versioning</a>.</p> </important> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutBucketWebsite":{
"name":"PutBucketWebsite",
@@ -944,7 +1009,10 @@
"input":{"shape":"PutBucketWebsiteRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html",
"documentation":"<p>Sets the configuration of the website that is specified in the <code>website</code> subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html\">Hosting Websites on Amazon S3</a>.</p> <p>This PUT action requires the <code>S3:PutBucketWebsite</code> permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the <code>S3:PutBucketWebsite</code> permission.</p> <p>To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.</p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>RedirectAllRequestsTo</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> </ul> <p>If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. </p> <ul> <li> <p> <code>WebsiteConfiguration</code> </p> </li> <li> <p> <code>IndexDocument</code> </p> </li> <li> <p> <code>Suffix</code> </p> </li> <li> <p> <code>ErrorDocument</code> </p> </li> <li> <p> <code>Key</code> </p> </li> <li> <p> <code>RoutingRules</code> </p> </li> <li> <p> <code>RoutingRule</code> </p> </li> <li> <p> <code>Condition</code> </p> </li> <li> <p> <code>HttpErrorCodeReturnedEquals</code> </p> </li> <li> <p> <code>KeyPrefixEquals</code> </p> </li> <li> <p> <code>Redirect</code> </p> </li> <li> <p> <code>Protocol</code> </p> </li> <li> <p> <code>HostName</code> </p> </li> <li> <p> <code>ReplaceKeyPrefixWith</code> </p> </li> <li> <p> <code>ReplaceKeyWith</code> </p> </li> <li> <p> <code>HttpRedirectCode</code> </p> </li> </ul> <p>Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html\">Configuring an Object Redirect</a> in the <i>Amazon S3 User Guide</i>.</p>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutObject":{
"name":"PutObject",
@@ -955,7 +1023,11 @@
"input":{"shape":"PutObjectRequest"},
"output":{"shape":"PutObjectOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html",
- "documentation":"<p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.</p> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.</p> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.</p> <p>To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> <note> <ul> <li> <p>To successfully complete the <code>PutObject</code> request, you must have the <code>s3:PutObject</code> in your IAM permissions.</p> </li> <li> <p>To successfully change the objects acl of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code> in your IAM permissions.</p> </li> <li> <p> The <code>Content-MD5</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html\">Amazon S3 Object Lock Overview</a> in the <i>Amazon S3 User Guide</i>. </p> </li> </ul> </note> <p> <b>Server-side Encryption</b> </p> <p>You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a>.</p> <p>If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html\">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Storage Class Options</b> </p> <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.</p> <p>For more information about versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html\">Adding Objects to Versioning Enabled Buckets</a>. For information about returning the versioning state of a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a>. </p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> </ul>"
+ "documentation":"<p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.</p> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.</p> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.</p> <p>To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> <note> <ul> <li> <p>To successfully complete the <code>PutObject</code> request, you must have the <code>s3:PutObject</code> in your IAM permissions.</p> </li> <li> <p>To successfully change the objects acl of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code> in your IAM permissions.</p> </li> <li> <p> The <code>Content-MD5</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html\">Amazon S3 Object Lock Overview</a> in the <i>Amazon S3 User Guide</i>. </p> </li> </ul> </note> <p> <b>Server-side Encryption</b> </p> <p>You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a>.</p> <p>If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access Control List (ACL)-Specific Request Headers</b> </p> <p>You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html\">Managing ACLs Using the REST API</a>. </p> <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\"> Controlling ownership of objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.</p> </note> <p> <b>Storage Class Options</b> </p> <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Versioning</b> </p> <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.</p> <p>For more information about versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html\">Adding Objects to Versioning Enabled Buckets</a>. For information about returning the versioning state of a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a>. </p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":false
+ }
},
"PutObjectAcl":{
"name":"PutObjectAcl",
@@ -970,7 +1042,10 @@
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html",
"documentation":"<p>Uses the <code>acl</code> subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have <code>WRITE_ACP</code> permission to set the ACL of an object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions\">What permissions can I grant?</a> in the <i>Amazon S3 User Guide</i>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a> in the <i>Amazon S3 User Guide</i>.</p> <important> <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are still supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\">Controlling object ownership</a> in the <i>Amazon S3 User Guide</i>.</p> </important> <p> <b>Access Permissions</b> </p> <p>You can set access permissions using one of the following methods:</p> <ul> <li> <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of <code>x-amz-ac</code>l. If you use this header, you cannot use other access control-specific headers in your request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL\">Canned ACL</a>.</p> </li> <li> <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code> headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html\">Access Control List (ACL) Overview</a>.</p> <p>You specify each grantee as a type=value pair, where the type is one of the following:</p> <ul> <li> <p> <code>id</code> – if the value specified is the canonical user ID of an Amazon Web Services account</p> </li> <li> <p> <code>uri</code> – if you are granting permissions to a predefined group</p> </li> <li> <p> <code>emailAddress</code> – if the value specified is the email address of an Amazon Web Services account</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p>For example, the following <code>x-amz-grant-read</code> header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.</p> <p> <code>x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\" </code> </p> </li> </ul> <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do both.</p> <p> <b>Grantee Values</b> </p> <p>You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:</p> <ul> <li> <p>By the person's ID:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"&gt;&lt;ID&gt;&lt;&gt;ID&lt;&gt;&lt;/ID&gt;&lt;DisplayName&gt;&lt;&gt;GranteesEmail&lt;&gt;&lt;/DisplayName&gt; &lt;/Grantee&gt;</code> </p> <p>DisplayName is optional and ignored in the request.</p> </li> <li> <p>By URI:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"&gt;&lt;URI&gt;&lt;&gt;http://acs.amazonaws.com/groups/global/AuthenticatedUsers&lt;&gt;&lt;/URI&gt;&lt;/Grantee&gt;</code> </p> </li> <li> <p>By Email address:</p> <p> <code>&lt;Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"&gt;&lt;EmailAddress&gt;&lt;&gt;Grantees@email.com&lt;&gt;&lt;/EmailAddress&gt;lt;/Grantee&gt;</code> </p> <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.</p> <note> <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p> <ul> <li> <p>US East (N. Virginia)</p> </li> <li> <p>US West (N. California)</p> </li> <li> <p> US West (Oregon)</p> </li> <li> <p> Asia Pacific (Singapore)</p> </li> <li> <p>Asia Pacific (Sydney)</p> </li> <li> <p>Asia Pacific (Tokyo)</p> </li> <li> <p>Europe (Ireland)</p> </li> <li> <p>South America (São Paulo)</p> </li> </ul> <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p> </note> </li> </ul> <p> <b>Versioning</b> </p> <p>The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the <code>versionId</code> subresource.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutObjectLegalHold":{
"name":"PutObjectLegalHold",
@@ -980,8 +1055,11 @@
},
"input":{"shape":"PutObjectLegalHoldRequest"},
"output":{"shape":"PutObjectLegalHoldOutput"},
- "documentation":"<p>Applies a Legal Hold configuration to the specified object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p>",
- "httpChecksumRequired":true
+ "documentation":"<p>Applies a legal hold configuration to the specified object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>.</p> <p>This action is not supported by Amazon S3 on Outposts.</p>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutObjectLockConfiguration":{
"name":"PutObjectLockConfiguration",
@@ -992,7 +1070,10 @@
"input":{"shape":"PutObjectLockConfigurationRequest"},
"output":{"shape":"PutObjectLockConfigurationOutput"},
"documentation":"<p>Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>. </p> <note> <ul> <li> <p>The <code>DefaultRetention</code> settings require both a mode and a period.</p> </li> <li> <p>The <code>DefaultRetention</code> period can be either <code>Days</code> or <code>Years</code> but you must select one. You cannot specify <code>Days</code> and <code>Years</code> at the same time.</p> </li> <li> <p>You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.</p> </li> </ul> </note>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutObjectRetention":{
"name":"PutObjectRetention",
@@ -1002,8 +1083,11 @@
},
"input":{"shape":"PutObjectRetentionRequest"},
"output":{"shape":"PutObjectRetentionOutput"},
- "documentation":"<p>Places an Object Retention configuration on an object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>. Users or accounts require the <code>s3:PutObjectRetention</code> permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the <code>s3:BypassGovernanceRetention</code> permission. </p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p> <b>Permissions</b> </p> <p>When the Object Lock retention mode is set to compliance, you need <code>s3:PutObjectRetention</code> and <code>s3:BypassGovernanceRetention</code> permissions. For other requests to <code>PutObjectRetention</code>, only <code>s3:PutObjectRetention</code> permissions are required.</p>",
- "httpChecksumRequired":true
+ "documentation":"<p>Places an Object Retention configuration on an object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html\">Locking Objects</a>. Users or accounts require the <code>s3:PutObjectRetention</code> permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the <code>s3:BypassGovernanceRetention</code> permission. </p> <p>This action is not supported by Amazon S3 on Outposts.</p>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutObjectTagging":{
"name":"PutObjectTagging",
@@ -1014,7 +1098,10 @@
"input":{"shape":"PutObjectTaggingRequest"},
"output":{"shape":"PutObjectTaggingOutput"},
"documentation":"<p>Sets the supplied tag-set to an object that already exists in a bucket.</p> <p>A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a>.</p> <p>For tagging-related restrictions related to characters and encodings, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">Tag Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.</p> <p>To use this operation, you must have permission to perform the <code>s3:PutObjectTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p>To put tags of any other version, use the <code>versionId</code> query parameter. You also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p> <p>For information about the Amazon S3 object tagging feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: InvalidTagError </i> </p> </li> <li> <p> <i>Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html\">Object Tagging</a>.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: MalformedXMLError </i> </p> </li> <li> <p> <i>Cause: The XML provided does not match the schema.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: OperationAbortedError </i> </p> </li> <li> <p> <i>Cause: A conflicting conditional action is currently in progress against this resource. Please try again.</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: InternalError</i> </p> </li> <li> <p> <i>Cause: The service was unable to apply the provided tag to the object.</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html\">DeleteObjectTagging</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"PutPublicAccessBlock":{
"name":"PutPublicAccessBlock",
@@ -1024,7 +1111,10 @@
},
"input":{"shape":"PutPublicAccessBlockRequest"},
"documentation":"<p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about Amazon S3 permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a>.</p> <important> <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or an object, it checks the <code>PublicAccessBlock</code> configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the <code>PublicAccessBlock</code> configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.</p> </important> <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a>.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html\">GetPublicAccessBlock</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html\">DeletePublicAccessBlock</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html\">GetBucketPolicyStatus</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html\">Using Amazon S3 Block Public Access</a> </p> </li> </ul>",
- "httpChecksumRequired":true
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":true
+ }
},
"RestoreObject":{
"name":"RestoreObject",
@@ -1038,8 +1128,12 @@
{"shape":"ObjectAlreadyInActiveTierError"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html",
- "documentation":"<p>Restores an archived copy of an object back into Amazon S3</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>This action performs the following types of requests: </p> <ul> <li> <p> <code>select</code> - Perform a select query on an archived object</p> </li> <li> <p> <code>restore an archive</code> - Restore an archived object</p> </li> </ul> <p>To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Querying Archives with Select Requests</b> </p> <p>You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html\">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When making a select request, do the following:</p> <ul> <li> <p>Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html\">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more information about the <code>S3</code> structure in the request body, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Managing Access with ACLs</a> in the <i>Amazon S3 User Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul> </li> <li> <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your query in the request body's <code>SelectParameters</code> structure. You can use expressions like the following examples.</p> <ul> <li> <p>The following expression returns all records from the specified object.</p> <p> <code>SELECT * FROM Object</code> </p> </li> <li> <p>Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.</p> <p> <code>SELECT s._1, s._2 FROM Object s WHERE s._3 &gt; 100</code> </p> </li> <li> <p>If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> structure in the request body to <code>USE</code>, you can specify headers in the query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. </p> <p> <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> </p> </li> </ul> </li> </ul> <p>For more information about using SQL with S3 Glacier Select restore, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\">SQL Reference for Amazon S3 Select and S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>. </p> <p>When making a select request, you can also do the following:</p> <ul> <li> <p>To expedite your queries, specify the <code>Expedited</code> tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.</p> </li> <li> <p>Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.</p> </li> </ul> <p>The following are additional important facts about the select feature:</p> <ul> <li> <p>The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.</p> </li> <li> <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.</p> </li> <li> <p> Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response <code>409</code>.</p> </li> </ul> <p> <b>Restoring objects</b> </p> <p>Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.</p> <p>To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.</p> <p>When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the <code>Tier</code> element of the request body: </p> <ul> <li> <p> <b> <code>Expedited</code> </b> - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.</p> </li> <li> <p> <b> <code>Standard</code> </b> - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> <li> <p> <b> <code>Bulk</code> </b> - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> </ul> <p>For more information about archive retrieval options and provisioned capacity for <code>Expedited</code> data access, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>. </p> <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html\"> Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. </p> <p>To get the status of object restoration, you can send a <code>HEAD</code> request. Operations return the <code>x-amz-restore</code> header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p> <p>After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.</p> <p>If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in <i>Amazon S3 User Guide</i>.</p> <p> <b>Responses</b> </p> <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> status code. </p> <ul> <li> <p>If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> in the response. </p> </li> <li> <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the response. </p> </li> </ul> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: RestoreAlreadyInProgress</i> </p> </li> <li> <p> <i>Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 409 Conflict</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: GlacierExpeditedRetrievalNotAvailable</i> </p> </li> <li> <p> <i>Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 503</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: N/A</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html\">GetBucketNotificationConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\">SQL Reference for Amazon S3 Select and S3 Glacier Select </a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul>",
- "alias":"PostObjectRestore"
+ "documentation":"<p>Restores an archived copy of an object back into Amazon S3</p> <p>This action is not supported by Amazon S3 on Outposts.</p> <p>This action performs the following types of requests: </p> <ul> <li> <p> <code>select</code> - Perform a select query on an archived object</p> </li> <li> <p> <code>restore an archive</code> - Restore an archived object</p> </li> </ul> <p>To use this operation, you must have permissions to perform the <code>s3:RestoreObject</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Querying Archives with Select Requests</b> </p> <p>You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html\">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When making a select request, do the following:</p> <ul> <li> <p>Define an output location for the select query's output. This must be an Amazon S3 bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is being queried. The Amazon Web Services account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html\">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more information about the <code>S3</code> structure in the request body, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html\">Managing Access with ACLs</a> in the <i>Amazon S3 User Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul> </li> <li> <p>Define the SQL expression for the <code>SELECT</code> type of restoration for your query in the request body's <code>SelectParameters</code> structure. You can use expressions like the following examples.</p> <ul> <li> <p>The following expression returns all records from the specified object.</p> <p> <code>SELECT * FROM Object</code> </p> </li> <li> <p>Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.</p> <p> <code>SELECT s._1, s._2 FROM Object s WHERE s._3 &gt; 100</code> </p> </li> <li> <p>If you have headers and you set the <code>fileHeaderInfo</code> in the <code>CSV</code> structure in the request body to <code>USE</code>, you can specify headers in the query. (If you set the <code>fileHeaderInfo</code> field to <code>IGNORE</code>, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. </p> <p> <code>SELECT s.Id, s.FirstName, s.SSN FROM S3Object s</code> </p> </li> </ul> </li> </ul> <p>For more information about using SQL with S3 Glacier Select restore, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\">SQL Reference for Amazon S3 Select and S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>. </p> <p>When making a select request, you can also do the following:</p> <ul> <li> <p>To expedite your queries, specify the <code>Expedited</code> tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.</p> </li> <li> <p>Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.</p> </li> </ul> <p>The following are additional important facts about the select feature:</p> <ul> <li> <p>The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.</p> </li> <li> <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.</p> </li> <li> <p> Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response <code>409</code>.</p> </li> </ul> <p> <b>Restoring objects</b> </p> <p>Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in Archive Access or Deep Archive Access tiers you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive storage classes you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.</p> <p>To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.</p> <p>When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the <code>Tier</code> element of the request body: </p> <ul> <li> <p> <code>Expedited</code> - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.</p> </li> <li> <p> <code>Standard</code> - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> <li> <p> <code>Bulk</code> - Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.</p> </li> </ul> <p>For more information about archive retrieval options and provisioned capacity for <code>Expedited</code> data access, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>. </p> <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html\"> Upgrading the speed of an in-progress restore</a> in the <i>Amazon S3 User Guide</i>. </p> <p>To get the status of object restoration, you can send a <code>HEAD</code> request. Operations return the <code>x-amz-restore</code> header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Amazon S3 Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p> <p>After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.</p> <p>If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in <i>Amazon S3 User Guide</i>.</p> <p> <b>Responses</b> </p> <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code> status code. </p> <ul> <li> <p>If the object is not previously restored, then Amazon S3 returns <code>202 Accepted</code> in the response. </p> </li> <li> <p>If the object is previously restored, Amazon S3 returns <code>200 OK</code> in the response. </p> </li> </ul> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: RestoreAlreadyInProgress</i> </p> </li> <li> <p> <i>Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 409 Conflict</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: GlacierExpeditedRetrievalNotAvailable</i> </p> </li> <li> <p> <i>Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)</i> </p> </li> <li> <p> <i>HTTP Status Code: 503</i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: N/A</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html\">GetBucketNotificationConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html\">SQL Reference for Amazon S3 Select and S3 Glacier Select </a> in the <i>Amazon S3 User Guide</i> </p> </li> </ul>",
+ "alias":"PostObjectRestore",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":false
+ }
},
"SelectObjectContent":{
"name":"SelectObjectContent",
@@ -1064,7 +1158,11 @@
"input":{"shape":"UploadPartRequest"},
"output":{"shape":"UploadPartOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html",
- "documentation":"<p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.</p> <p>To ensure that data is not corrupted when traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p> <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. For more information see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html\">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> <p>For more information on multipart uploads, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide </i>.</p> <p>For information on the permissions required to use the multipart upload API, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>.</p> <p>If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i> HTTP Status Code: 404 Not Found </i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>"
+ "documentation":"<p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.</p> <p>To ensure that data is not corrupted when traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p> <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. For more information see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html\">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> <p>For more information on multipart uploads, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide </i>.</p> <p>For information on the permissions required to use the multipart upload API, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>.</p> <p>If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i> HTTP Status Code: 404 Not Found </i> </p> </li> <li> <p> <i>SOAP Fault Code Prefix: Client</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>",
+ "httpChecksum":{
+ "requestAlgorithmMember":"ChecksumAlgorithm",
+ "requestChecksumRequired":false
+ }
},
"UploadPartCopy":{
"name":"UploadPartCopy",
@@ -1075,7 +1173,7 @@
"input":{"shape":"UploadPartCopyRequest"},
"output":{"shape":"UploadPartCopyOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html",
- "documentation":"<p>Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header <code>x-amz-copy-source</code> in your request and a byte range by adding the request header <code>x-amz-copy-source-range</code> in your request. </p> <p>The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html\">Quick Facts</a> in the <i>Amazon S3 User Guide</i>. </p> <note> <p>Instead of using an existing object as part data, you might use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> action and provide data in your request.</p> </note> <p>You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.</p> <p>For more information about using the <code>UploadPartCopy</code> operation, see the following:</p> <ul> <li> <p>For conceptual information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>For information about copying objects using a single atomic action vs. the multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html\">Operations on Objects</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>.</p> </li> </ul> <p>Note the following additional considerations about the request headers <code>x-amz-copy-source-if-match</code>, <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, and <code>x-amz-copy-source-if-modified-since</code>:</p> <p> </p> <ul> <li> <p> <b>Consideration 1</b> - If both of the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as follows:</p> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, and;</p> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>;</p> <p>Amazon S3 returns <code>200 OK</code> and copies the data. </p> </li> <li> <p> <b>Consideration 2</b> - If both of the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as follows:</p> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, and;</p> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>;</p> <p>Amazon S3 returns <code>412 Precondition Failed</code> response code. </p> </li> </ul> <p> <b>Versioning</b> </p> <p>If your bucket has versioning enabled, you could have multiple versions of the same object. By default, <code>x-amz-copy-source</code> identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the <code>x-amz-copy-source</code>. </p> <p>You can optionally specify a specific version of the source object to copy by adding the <code>versionId</code> subresource as shown in the following example:</p> <p> <code>x-amz-copy-source: /bucket/object?versionId=version id</code> </p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i>HTTP Status Code: 404 Not Found</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: InvalidRequest</i> </p> </li> <li> <p> <i>Cause: The specified copy source is not supported as a byte-range copy source.</i> </p> </li> <li> <p> <i>HTTP Status Code: 400 Bad Request</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>"
+ "documentation":"<p>Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header <code>x-amz-copy-source</code> in your request and a byte range by adding the request header <code>x-amz-copy-source-range</code> in your request. </p> <p>The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html\">Quick Facts</a> in the <i>Amazon S3 User Guide</i>. </p> <note> <p>Instead of using an existing object as part data, you might use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> action and provide data in your request.</p> </note> <p>You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.</p> <p>For more information about using the <code>UploadPartCopy</code> operation, see the following:</p> <ul> <li> <p>For conceptual information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>For information about copying objects using a single atomic action vs. a multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html\">Operations on Objects</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>For information about using server-side encryption with customer-provided encryption keys with the <code>UploadPartCopy</code> operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>.</p> </li> </ul> <p>Note the following additional considerations about the request headers <code>x-amz-copy-source-if-match</code>, <code>x-amz-copy-source-if-none-match</code>, <code>x-amz-copy-source-if-unmodified-since</code>, and <code>x-amz-copy-source-if-modified-since</code>:</p> <p> </p> <ul> <li> <p> <b>Consideration 1</b> - If both of the <code>x-amz-copy-source-if-match</code> and <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as follows:</p> <p> <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, and;</p> <p> <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to <code>false</code>;</p> <p>Amazon S3 returns <code>200 OK</code> and copies the data. </p> </li> <li> <p> <b>Consideration 2</b> - If both of the <code>x-amz-copy-source-if-none-match</code> and <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as follows:</p> <p> <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>, and;</p> <p> <code>x-amz-copy-source-if-modified-since</code> condition evaluates to <code>true</code>;</p> <p>Amazon S3 returns <code>412 Precondition Failed</code> response code. </p> </li> </ul> <p> <b>Versioning</b> </p> <p>If your bucket has versioning enabled, you could have multiple versions of the same object. By default, <code>x-amz-copy-source</code> identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the <code>x-amz-copy-source</code> and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the <code>x-amz-copy-source</code>. </p> <p>You can optionally specify a specific version of the source object to copy by adding the <code>versionId</code> subresource as shown in the following example:</p> <p> <code>x-amz-copy-source: /bucket/object?versionId=version id</code> </p> <p class=\"title\"> <b>Special Errors</b> </p> <ul> <li> <ul> <li> <p> <i>Code: NoSuchUpload</i> </p> </li> <li> <p> <i>Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</i> </p> </li> <li> <p> <i>HTTP Status Code: 404 Not Found</i> </p> </li> </ul> </li> <li> <ul> <li> <p> <i>Code: InvalidRequest</i> </p> </li> <li> <p> <i>Cause: The specified copy source is not supported as a byte-range copy source.</i> </p> </li> <li> <p> <i>HTTP Status Code: 400 Bad Request</i> </p> </li> </ul> </li> </ul> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>"
},
"WriteGetObjectResponse":{
"name":"WriteGetObjectResponse",
@@ -1123,7 +1221,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name to which the upload was taking place. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name to which the upload was taking place. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -1146,7 +1244,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -1511,7 +1609,7 @@
},
"QuoteEscapeCharacter":{
"shape":"QuoteEscapeCharacter",
- "documentation":"<p>A single character used for escaping the quotation mark character inside an already escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".</p>"
+ "documentation":"<p>A single character used for escaping the quotation mark character inside an already escaped value. For example, the value <code>\"\"\" a , b \"\"\"</code> is parsed as <code>\" a , b \"</code>.</p>"
},
"RecordDelimiter":{
"shape":"RecordDelimiter",
@@ -1559,6 +1657,50 @@
"documentation":"<p>Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.</p>"
},
"CacheControl":{"type":"string"},
+ "Checksum":{
+ "type":"structure",
+ "members":{
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ }
+ },
+ "documentation":"<p>Contains all the possible checksum or digest values for an object.</p>"
+ },
+ "ChecksumAlgorithm":{
+ "type":"string",
+ "enum":[
+ "CRC32",
+ "CRC32C",
+ "SHA1",
+ "SHA256"
+ ]
+ },
+ "ChecksumAlgorithmList":{
+ "type":"list",
+ "member":{"shape":"ChecksumAlgorithm"},
+ "flattened":true
+ },
+ "ChecksumCRC32":{"type":"string"},
+ "ChecksumCRC32C":{"type":"string"},
+ "ChecksumMode":{
+ "type":"string",
+ "enum":["ENABLED"]
+ },
+ "ChecksumSHA1":{"type":"string"},
+ "ChecksumSHA256":{"type":"string"},
"CloudFunction":{"type":"string"},
"CloudFunctionConfiguration":{
"type":"structure",
@@ -1611,7 +1753,7 @@
},
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ "documentation":"<p>The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>"
},
"Key":{
"shape":"ObjectKey",
@@ -1619,13 +1761,29 @@
},
"Expiration":{
"shape":"Expiration",
- "documentation":"<p>If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.</p>",
+ "documentation":"<p>If the object expiration is configured, this will contain the expiration date (<code>expiry-date</code>) and rule ID (<code>rule-id</code>). The value of <code>rule-id</code> is URL-encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
"ETag":{
"shape":"ETag",
- "documentation":"<p>Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.</p>"
+ "documentation":"<p>Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
@@ -1668,7 +1826,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -1690,6 +1848,30 @@
"location":"querystring",
"locationName":"uploadId"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"RequestPayer":{
"shape":"RequestPayer",
"location":"header",
@@ -1697,9 +1879,27 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "SSECustomerAlgorithm":{
+ "shape":"SSECustomerAlgorithm",
+ "documentation":"<p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-algorithm"
+ },
+ "SSECustomerKey":{
+ "shape":"SSECustomerKey",
+ "documentation":"<p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-key"
+ },
+ "SSECustomerKeyMD5":{
+ "shape":"SSECustomerKeyMD5",
+ "documentation":"<p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-key-MD5"
}
},
"payload":"MultipartUpload"
@@ -1722,6 +1922,22 @@
"shape":"ETag",
"documentation":"<p>Entity tag returned when the part was uploaded.</p>"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
"PartNumber":{
"shape":"PartNumber",
"documentation":"<p>Part number that identifies the part. This is a positive integer between 1 and 10,000.</p>"
@@ -1856,7 +2072,7 @@
},
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the destination bucket.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the destination bucket.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -1866,6 +2082,12 @@
"location":"header",
"locationName":"Cache-Control"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-algorithm"
+ },
"ContentDisposition":{
"shape":"ContentDisposition",
"documentation":"<p>Specifies presentational information for the object.</p>",
@@ -1892,7 +2114,7 @@
},
"CopySource":{
"shape":"CopySource",
- "documentation":"<p>Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">access point</a>:</p> <ul> <li> <p>For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object <code>reports/january.pdf</code> from the bucket <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL encoded.</p> </li> <li> <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:&lt;Region&gt;:&lt;account-id&gt;:accesspoint/&lt;access-point-name&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p> <note> <p>Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.</p> </note> <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:&lt;Region&gt;:&lt;account-id&gt;:outpost/&lt;outpost-id&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL encoded. </p> </li> </ul> <p>To copy a specific version of an object, append <code>?versionId=&lt;version-id&gt;</code> to the value (for example, <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.</p>",
+ "documentation":"<p>Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">access point</a>:</p> <ul> <li> <p>For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object <code>reports/january.pdf</code> from the bucket <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL-encoded.</p> </li> <li> <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:&lt;Region&gt;:&lt;account-id&gt;:accesspoint/&lt;access-point-name&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p> <note> <p>Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.</p> </note> <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:&lt;Region&gt;:&lt;account-id&gt;:outpost/&lt;outpost-id&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. </p> </li> </ul> <p>To copy a specific version of an object, append <code>?versionId=&lt;version-id&gt;</code> to the value (for example, <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.</p>",
"location":"header",
"locationName":"x-amz-copy-source"
},
@@ -2071,19 +2293,19 @@
},
"ObjectLockLegalHoldStatus":{
"shape":"ObjectLockLegalHoldStatus",
- "documentation":"<p>Specifies whether you want to apply a Legal Hold to the copied object.</p>",
+ "documentation":"<p>Specifies whether you want to apply a legal hold to the copied object.</p>",
"location":"header",
"locationName":"x-amz-object-lock-legal-hold"
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
},
"ExpectedSourceBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-source-expected-bucket-owner"
}
@@ -2099,6 +2321,22 @@
"LastModified":{
"shape":"LastModified",
"documentation":"<p>Creation date of the object.</p>"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
}
},
"documentation":"<p>Container for all response elements.</p>"
@@ -2113,6 +2351,22 @@
"LastModified":{
"shape":"LastModified",
"documentation":"<p>Date and time at which the object was uploaded.</p>"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
}
},
"documentation":"<p>Container for all response elements.</p>"
@@ -2148,7 +2402,7 @@
"members":{
"Location":{
"shape":"Location",
- "documentation":"<p>Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.</p>",
+ "documentation":"<p>A forward slash followed by the name of the bucket.</p>",
"location":"header",
"locationName":"Location"
}
@@ -2237,7 +2491,7 @@
},
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"locationName":"Bucket"
},
"Key":{
@@ -2288,6 +2542,12 @@
"shape":"RequestCharged",
"location":"header",
"locationName":"x-amz-request-charged"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-algorithm"
}
}
},
@@ -2306,7 +2566,7 @@
},
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket to which to initiate the upload</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket to which to initiate the upload</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -2461,15 +2721,21 @@
},
"ObjectLockLegalHoldStatus":{
"shape":"ObjectLockLegalHoldStatus",
- "documentation":"<p>Specifies whether you want to apply a Legal Hold to the uploaded object.</p>",
+ "documentation":"<p>Specifies whether you want to apply a legal hold to the uploaded object.</p>",
"location":"header",
"locationName":"x-amz-object-lock-legal-hold"
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-algorithm"
}
}
},
@@ -2535,7 +2801,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2553,7 +2819,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2571,7 +2837,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2619,7 +2885,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2637,7 +2903,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2664,7 +2930,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2682,7 +2948,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2700,7 +2966,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2718,7 +2984,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2736,7 +3002,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2754,7 +3020,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2772,7 +3038,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2859,7 +3125,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name of the bucket containing the object. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name of the bucket containing the object. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -2888,13 +3154,13 @@
},
"BypassGovernanceRetention":{
"shape":"BypassGovernanceRetention",
- "documentation":"<p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission.</p>",
+ "documentation":"<p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the <code>s3:BypassGovernanceRetention</code> permission.</p>",
"location":"header",
"locationName":"x-amz-bypass-governance-retention"
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2920,7 +3186,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the objects from which to remove the tags. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the objects from which to remove the tags. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -2938,7 +3204,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -2972,7 +3238,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the objects to delete. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the objects to delete. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -2995,15 +3261,21 @@
},
"BypassGovernanceRetention":{
"shape":"BypassGovernanceRetention",
- "documentation":"<p>Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission.</p>",
+ "documentation":"<p>Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the <code>s3:BypassGovernanceRetention</code> permission.</p>",
"location":"header",
"locationName":"x-amz-bypass-governance-retention"
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p> <p>This checksum algorithm must be the same for all parts and it match the checksum value supplied in the <code>CreateMultipartUpload</code> request.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
}
},
"payload":"Delete"
@@ -3020,7 +3292,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3318,7 +3590,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3350,7 +3622,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3387,7 +3659,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3415,7 +3687,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3440,7 +3712,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3508,7 +3780,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3536,7 +3808,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3564,7 +3836,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3591,7 +3863,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3615,7 +3887,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3652,7 +3924,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3670,7 +3942,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3698,7 +3970,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3726,7 +3998,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3754,7 +4026,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3779,7 +4051,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3806,7 +4078,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3834,7 +4106,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3866,7 +4138,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3905,7 +4177,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -3962,9 +4234,164 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
+ "location":"header",
+ "locationName":"x-amz-expected-bucket-owner"
+ }
+ }
+ },
+ "GetObjectAttributesOutput":{
+ "type":"structure",
+ "members":{
+ "DeleteMarker":{
+ "shape":"DeleteMarker",
+ "documentation":"<p>Specifies whether the object retrieved was (<code>true</code>) or was not (<code>false</code>) a delete marker. If <code>false</code>, this response header does not appear in the response.</p>",
+ "location":"header",
+ "locationName":"x-amz-delete-marker"
+ },
+ "LastModified":{
+ "shape":"LastModified",
+ "documentation":"<p>The creation date of the object.</p>",
+ "location":"header",
+ "locationName":"Last-Modified"
+ },
+ "VersionId":{
+ "shape":"ObjectVersionId",
+ "documentation":"<p>The version ID of the object.</p>",
+ "location":"header",
+ "locationName":"x-amz-version-id"
+ },
+ "RequestCharged":{
+ "shape":"RequestCharged",
+ "location":"header",
+ "locationName":"x-amz-request-charged"
+ },
+ "ETag":{
+ "shape":"ETag",
+ "documentation":"<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>"
+ },
+ "Checksum":{
+ "shape":"Checksum",
+ "documentation":"<p>The checksum or digest of the object.</p>"
+ },
+ "ObjectParts":{
+ "shape":"GetObjectAttributesParts",
+ "documentation":"<p>A collection of parts associated with a multipart upload.</p>"
+ },
+ "StorageClass":{
+ "shape":"StorageClass",
+ "documentation":"<p>Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a>.</p>"
+ },
+ "ObjectSize":{
+ "shape":"ObjectSize",
+ "documentation":"<p>The size of the object in bytes.</p>"
+ }
+ }
+ },
+ "GetObjectAttributesParts":{
+ "type":"structure",
+ "members":{
+ "TotalPartsCount":{
+ "shape":"PartsCount",
+ "documentation":"<p>The total number of parts.</p>",
+ "locationName":"PartsCount"
+ },
+ "PartNumberMarker":{
+ "shape":"PartNumberMarker",
+ "documentation":"<p>The marker for the current part.</p>"
+ },
+ "NextPartNumberMarker":{
+ "shape":"NextPartNumberMarker",
+ "documentation":"<p>When a list is truncated, this element specifies the last part in the list, as well as the value to use for the <code>PartNumberMarker</code> request parameter in a subsequent request.</p>"
+ },
+ "MaxParts":{
+ "shape":"MaxParts",
+ "documentation":"<p>The maximum number of parts allowed in the response.</p>"
+ },
+ "IsTruncated":{
+ "shape":"IsTruncated",
+ "documentation":"<p>Indicates whether the returned list of parts is truncated. A value of <code>true</code> indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the <code>MaxParts</code> element.</p>"
+ },
+ "Parts":{
+ "shape":"PartsList",
+ "documentation":"<p>A container for elements related to a particular part. A response can contain zero or more <code>Parts</code> elements.</p>",
+ "locationName":"Part"
+ }
+ },
+ "documentation":"<p>A collection of parts associated with a multipart upload.</p>"
+ },
+ "GetObjectAttributesRequest":{
+ "type":"structure",
+ "required":[
+ "Bucket",
+ "Key",
+ "ObjectAttributes"
+ ],
+ "members":{
+ "Bucket":{
+ "shape":"BucketName",
+ "documentation":"<p>The name of the bucket that contains the object.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"uri",
+ "locationName":"Bucket"
+ },
+ "Key":{
+ "shape":"ObjectKey",
+ "documentation":"<p>The object key.</p>",
+ "location":"uri",
+ "locationName":"Key"
+ },
+ "VersionId":{
+ "shape":"ObjectVersionId",
+ "documentation":"<p>The version ID used to reference a specific version of the object.</p>",
+ "location":"querystring",
+ "locationName":"versionId"
+ },
+ "MaxParts":{
+ "shape":"MaxParts",
+ "documentation":"<p>Sets the maximum number of parts to return.</p>",
+ "location":"header",
+ "locationName":"x-amz-max-parts"
+ },
+ "PartNumberMarker":{
+ "shape":"PartNumberMarker",
+ "documentation":"<p>Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.</p>",
+ "location":"header",
+ "locationName":"x-amz-part-number-marker"
+ },
+ "SSECustomerAlgorithm":{
+ "shape":"SSECustomerAlgorithm",
+ "documentation":"<p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-algorithm"
+ },
+ "SSECustomerKey":{
+ "shape":"SSECustomerKey",
+ "documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-key"
+ },
+ "SSECustomerKeyMD5":{
+ "shape":"SSECustomerKeyMD5",
+ "documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-key-MD5"
+ },
+ "RequestPayer":{
+ "shape":"RequestPayer",
+ "location":"header",
+ "locationName":"x-amz-request-payer"
+ },
+ "ExpectedBucketOwner":{
+ "shape":"AccountId",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "ObjectAttributes":{
+ "shape":"ObjectAttributesList",
+ "documentation":"<p>An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.</p>",
+ "location":"header",
+ "locationName":"x-amz-object-attributes"
}
}
},
@@ -3973,7 +4400,7 @@
"members":{
"LegalHold":{
"shape":"ObjectLockLegalHold",
- "documentation":"<p>The current Legal Hold status for the specified object.</p>"
+ "documentation":"<p>The current legal hold status for the specified object.</p>"
}
},
"payload":"LegalHold"
@@ -3987,19 +4414,19 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the object whose Legal Hold status you want to retrieve. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the object whose legal hold status you want to retrieve. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Key":{
"shape":"ObjectKey",
- "documentation":"<p>The key name for the object whose Legal Hold status you want to retrieve.</p>",
+ "documentation":"<p>The key name for the object whose legal hold status you want to retrieve.</p>",
"location":"uri",
"locationName":"Key"
},
"VersionId":{
"shape":"ObjectVersionId",
- "documentation":"<p>The version ID of the object whose Legal Hold status you want to retrieve.</p>",
+ "documentation":"<p>The version ID of the object whose legal hold status you want to retrieve.</p>",
"location":"querystring",
"locationName":"versionId"
},
@@ -4010,7 +4437,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -4038,7 +4465,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -4066,7 +4493,7 @@
},
"Expiration":{
"shape":"Expiration",
- "documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.</p>",
+ "documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
@@ -4090,10 +4517,34 @@
},
"ETag":{
"shape":"ETag",
- "documentation":"<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>",
+ "documentation":"<p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>",
"location":"header",
"locationName":"ETag"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"MissingMeta":{
"shape":"MissingMeta",
"documentation":"<p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p>",
@@ -4209,7 +4660,7 @@
},
"PartsCount":{
"shape":"PartsCount",
- "documentation":"<p>The count of parts this object has.</p>",
+ "documentation":"<p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>",
"location":"header",
"locationName":"x-amz-mp-parts-count"
},
@@ -4249,31 +4700,31 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the object. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using an Object Lambda access point the hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the object. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using an Object Lambda access point the hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
"IfMatch":{
"shape":"IfMatch",
- "documentation":"<p>Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).</p>",
+ "documentation":"<p>Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.</p>",
"location":"header",
"locationName":"If-Match"
},
"IfModifiedSince":{
"shape":"IfModifiedSince",
- "documentation":"<p>Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).</p>",
+ "documentation":"<p>Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.</p>",
"location":"header",
"locationName":"If-Modified-Since"
},
"IfNoneMatch":{
"shape":"IfNoneMatch",
- "documentation":"<p>Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).</p>",
+ "documentation":"<p>Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.</p>",
"location":"header",
"locationName":"If-None-Match"
},
"IfUnmodifiedSince":{
"shape":"IfUnmodifiedSince",
- "documentation":"<p>Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).</p>",
+ "documentation":"<p>Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.</p>",
"location":"header",
"locationName":"If-Unmodified-Since"
},
@@ -4362,9 +4813,15 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "ChecksumMode":{
+ "shape":"ChecksumMode",
+ "documentation":"<p>To retrieve the checksum, this mode must be enabled.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-mode"
}
}
},
@@ -4411,7 +4868,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -4442,7 +4899,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the object for which to get the tagging information. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the object for which to get the tagging information. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -4460,7 +4917,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
},
@@ -4513,7 +4970,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -4541,7 +4998,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -4623,13 +5080,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -4652,7 +5109,7 @@
},
"Expiration":{
"shape":"Expiration",
- "documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.</p>",
+ "documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
@@ -4680,9 +5137,33 @@
"location":"header",
"locationName":"Content-Length"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"ETag":{
"shape":"ETag",
- "documentation":"<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>",
+ "documentation":"<p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>",
"location":"header",
"locationName":"ETag"
},
@@ -4789,13 +5270,13 @@
},
"ReplicationStatus":{
"shape":"ReplicationStatus",
- "documentation":"<p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p> <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p> <ul> <li> <p>If requesting an object from the source bucket — Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p> <p> For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p> </li> <li> <p>If requesting an object from a destination bucket — Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p> </li> <li> <p>When replicating objects to multiple destination buckets the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Replication</a>.</p>",
+ "documentation":"<p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p> <p>In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p> <ul> <li> <p> <b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p> <p> For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p> </li> <li> <p> <b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.</p> </li> <li> <p> <b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Replication</a>.</p>",
"location":"header",
"locationName":"x-amz-replication-status"
},
"PartsCount":{
"shape":"PartsCount",
- "documentation":"<p>The count of parts this object has.</p>",
+ "documentation":"<p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>",
"location":"header",
"locationName":"x-amz-mp-parts-count"
},
@@ -4828,31 +5309,31 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket containing the object.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket containing the object.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
"IfMatch":{
"shape":"IfMatch",
- "documentation":"<p>Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).</p>",
+ "documentation":"<p>Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.</p>",
"location":"header",
"locationName":"If-Match"
},
"IfModifiedSince":{
"shape":"IfModifiedSince",
- "documentation":"<p>Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).</p>",
+ "documentation":"<p>Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.</p>",
"location":"header",
"locationName":"If-Modified-Since"
},
"IfNoneMatch":{
"shape":"IfNoneMatch",
- "documentation":"<p>Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).</p>",
+ "documentation":"<p>Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.</p>",
"location":"header",
"locationName":"If-None-Match"
},
"IfUnmodifiedSince":{
"shape":"IfUnmodifiedSince",
- "documentation":"<p>Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).</p>",
+ "documentation":"<p>Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.</p>",
"location":"header",
"locationName":"If-Unmodified-Since"
},
@@ -4905,9 +5386,15 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "ChecksumMode":{
+ "shape":"ChecksumMode",
+ "documentation":"<p>To retrieve the checksum, this parameter must be enabled.</p> <p>In addition, if you enable <code>ChecksumMode</code> and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the <code>kms:Decrypt</code> action for the request to succeed.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-mode"
}
}
},
@@ -5177,7 +5664,8 @@
"ObjectLockMode",
"ObjectLockLegalHoldStatus",
"IntelligentTieringAccessTier",
- "BucketKeyStatus"
+ "BucketKeyStatus",
+ "ChecksumAlgorithm"
]
},
"InventoryOptionalFields":{
@@ -5341,7 +5829,7 @@
},
"Filter":{
"shape":"LifecycleRuleFilter",
- "documentation":"<p>The <code>Filter</code> is used to identify objects that a Lifecycle Rule applies to. A <code>Filter</code> must have exactly one of <code>Prefix</code>, <code>Tag</code>, or <code>And</code> specified. <code>Filter</code> is required if the <code>LifecycleRule</code> does not containt a <code>Prefix</code> element.</p>"
+ "documentation":"<p>The <code>Filter</code> is used to identify objects that a Lifecycle Rule applies to. A <code>Filter</code> must have exactly one of <code>Prefix</code>, <code>Tag</code>, or <code>And</code> specified. <code>Filter</code> is required if the <code>LifecycleRule</code> does not contain a <code>Prefix</code> element.</p>"
},
"Status":{
"shape":"ExpirationStatus",
@@ -5454,7 +5942,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -5465,11 +5953,11 @@
"members":{
"IsTruncated":{
"shape":"IsTruncated",
- "documentation":"<p>Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.</p>"
+ "documentation":"<p>Indicates whether the returned list of analytics configurations is complete. A value of <code>true</code> indicates that the list is not complete and the <code>NextContinuationToken</code> will be provided for a subsequent request.</p>"
},
"ContinuationToken":{
"shape":"Token",
- "documentation":"<p>The ContinuationToken that represents a placeholder from where this request should begin.</p>"
+ "documentation":"<p>The <code>ContinuationToken</code> that represents a placeholder from where this request should begin.</p>"
},
"NextContinuationToken":{
"shape":"NextToken",
@@ -5494,7 +5982,7 @@
},
"ContinuationToken":{
"shape":"Token",
- "documentation":"<p>The ContinuationToken that represents a placeholder from where this request should begin.</p>",
+ "documentation":"<p>The <code>ContinuationToken</code> that represents a placeholder from where this request should begin.</p>",
"location":"querystring",
"locationName":"continuation-token"
}
@@ -5540,7 +6028,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -5586,7 +6074,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -5597,7 +6085,7 @@
"members":{
"Buckets":{
"shape":"Buckets",
- "documentation":"<p>The list of buckets owned by the requestor.</p>"
+ "documentation":"<p>The list of buckets owned by the requester.</p>"
},
"Owner":{
"shape":"Owner",
@@ -5665,7 +6153,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket to which the multipart upload was initiated. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket to which the multipart upload was initiated. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -5706,7 +6194,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -5818,7 +6306,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -5875,7 +6363,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket containing the objects.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket containing the objects.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -5916,7 +6404,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -5935,7 +6423,7 @@
},
"Name":{
"shape":"BucketName",
- "documentation":"<p>The bucket name.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ "documentation":"<p>The bucket name.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>"
},
"Prefix":{
"shape":"Prefix",
@@ -5981,7 +6469,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>Bucket name to list. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>Bucket name to list. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -6035,7 +6523,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -6158,6 +6646,10 @@
"shape":"RequestCharged",
"location":"header",
"locationName":"x-amz-request-charged"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>"
}
}
},
@@ -6171,7 +6663,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket to which the parts are being uploaded. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket to which the parts are being uploaded. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -6206,9 +6698,27 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "SSECustomerAlgorithm":{
+ "shape":"SSECustomerAlgorithm",
+ "documentation":"<p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-algorithm"
+ },
+ "SSECustomerKey":{
+ "shape":"SSECustomerKey",
+ "documentation":"<p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-key"
+ },
+ "SSECustomerKeyMD5":{
+ "shape":"SSECustomerKeyMD5",
+ "documentation":"<p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-server-side-encryption-customer-key-MD5"
}
}
},
@@ -6321,7 +6831,7 @@
},
"AccessPointArn":{
"shape":"AccessPointArn",
- "documentation":"<p>The access point ARN used when evaluating an AND predicate.</p>"
+ "documentation":"<p>The access point ARN used when evaluating an <code>AND</code> predicate.</p>"
}
},
"documentation":"<p>A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.</p>"
@@ -6404,6 +6914,10 @@
"Initiator":{
"shape":"Initiator",
"documentation":"<p>Identifies who initiated the multipart upload.</p>"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>"
}
},
"documentation":"<p>Container for the <code>MultipartUpload</code> for the Amazon S3 object.</p>"
@@ -6549,6 +7063,10 @@
"shape":"ETag",
"documentation":"<p>The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:</p> <ul> <li> <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.</p> </li> <li> <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.</p> </li> <li> <p>If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption.</p> </li> </ul>"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithmList",
+ "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>"
+ },
"Size":{
"shape":"Size",
"documentation":"<p>Size in bytes of the object</p>"
@@ -6605,6 +7123,20 @@
"documentation":"<p>This action is not allowed against this storage tier.</p>",
"exception":true
},
+ "ObjectAttributes":{
+ "type":"string",
+ "enum":[
+ "ETag",
+ "Checksum",
+ "ObjectParts",
+ "StorageClass",
+ "ObjectSize"
+ ]
+ },
+ "ObjectAttributesList":{
+ "type":"list",
+ "member":{"shape":"ObjectAttributes"}
+ },
"ObjectCannedACL":{
"type":"string",
"enum":[
@@ -6675,10 +7207,10 @@
"members":{
"Status":{
"shape":"ObjectLockLegalHoldStatus",
- "documentation":"<p>Indicates whether the specified object has a Legal Hold in place.</p>"
+ "documentation":"<p>Indicates whether the specified object has a legal hold in place.</p>"
}
},
- "documentation":"<p>A Legal Hold configuration for an object.</p>"
+ "documentation":"<p>A legal hold configuration for an object.</p>"
},
"ObjectLockLegalHoldStatus":{
"type":"string",
@@ -6746,6 +7278,37 @@
"BucketOwnerEnforced"
]
},
+ "ObjectPart":{
+ "type":"structure",
+ "members":{
+ "PartNumber":{
+ "shape":"PartNumber",
+ "documentation":"<p>The part number identifying the part. This value is a positive integer between 1 and 10,000.</p>"
+ },
+ "Size":{
+ "shape":"Size",
+ "documentation":"<p>The size of the uploaded part in bytes.</p>"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ }
+ },
+ "documentation":"<p>A container for elements related to an individual part.</p>"
+ },
+ "ObjectSize":{"type":"long"},
"ObjectSizeGreaterThanBytes":{"type":"long"},
"ObjectSizeLessThanBytes":{"type":"long"},
"ObjectStorageClass":{
@@ -6769,6 +7332,10 @@
"shape":"ETag",
"documentation":"<p>The entity tag is an MD5 hash of that version of the object.</p>"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithmList",
+ "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>"
+ },
"Size":{
"shape":"Size",
"documentation":"<p>Size in bytes of the object.</p>"
@@ -6901,6 +7468,22 @@
"Size":{
"shape":"Size",
"documentation":"<p>Size in bytes of the uploaded part data.</p>"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
}
},
"documentation":"<p>Container for elements related to a part.</p>"
@@ -6913,6 +7496,11 @@
"flattened":true
},
"PartsCount":{"type":"integer"},
+ "PartsList":{
+ "type":"list",
+ "member":{"shape":"ObjectPart"},
+ "flattened":true
+ },
"Payer":{
"type":"string",
"enum":[
@@ -6986,7 +7574,7 @@
"members":{
"BlockPublicAcls":{
"shape":"Setting",
- "documentation":"<p>Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to <code>TRUE</code> causes the following behavior:</p> <ul> <li> <p>PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.</p> </li> <li> <p>PUT Object calls fail if the request includes a public ACL.</p> </li> <li> <p>PUT Bucket calls fail if the request includes a public ACL.</p> </li> </ul> <p>Enabling this setting doesn't affect existing policies or ACLs.</p>",
+ "documentation":"<p>Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to <code>TRUE</code> causes the following behavior:</p> <ul> <li> <p>PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.</p> </li> <li> <p>PUT Object calls fail if the request includes a public ACL.</p> </li> <li> <p>PUT Bucket calls fail if the request includes a public ACL.</p> </li> </ul> <p>Enabling this setting doesn't affect existing policies or ACLs.</p>",
"locationName":"BlockPublicAcls"
},
"IgnorePublicAcls":{
@@ -7028,9 +7616,15 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
}
},
"payload":"AccelerateConfiguration"
@@ -7063,6 +7657,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
@@ -7095,7 +7695,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7130,7 +7730,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7162,9 +7762,15 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7190,6 +7796,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ServerSideEncryptionConfiguration":{
"shape":"ServerSideEncryptionConfiguration",
"locationName":"ServerSideEncryptionConfiguration",
@@ -7197,7 +7809,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7261,7 +7873,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7278,6 +7890,12 @@
"location":"uri",
"locationName":"Bucket"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"LifecycleConfiguration":{
"shape":"BucketLifecycleConfiguration",
"documentation":"<p>Container for lifecycle rules. You can add as many as 1,000 rules.</p>",
@@ -7286,7 +7904,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7309,6 +7927,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"LifecycleConfiguration":{
"shape":"LifecycleConfiguration",
"documentation":"<p/>",
@@ -7317,7 +7941,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7349,9 +7973,15 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7386,7 +8016,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7413,7 +8043,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
},
@@ -7445,6 +8075,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"NotificationConfiguration":{
"shape":"NotificationConfigurationDeprecated",
"documentation":"<p>The container for the configuration.</p>",
@@ -7453,7 +8089,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7481,7 +8117,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
},
@@ -7513,6 +8149,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ConfirmRemoveSelfBucketAccess":{
"shape":"ConfirmRemoveSelfBucketAccess",
"documentation":"<p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p>",
@@ -7525,7 +8167,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7551,6 +8193,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ReplicationConfiguration":{
"shape":"ReplicationConfiguration",
"locationName":"ReplicationConfiguration",
@@ -7564,7 +8212,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7590,6 +8238,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"RequestPaymentConfiguration":{
"shape":"RequestPaymentConfiguration",
"documentation":"<p>Container for Payer.</p>",
@@ -7598,7 +8252,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7624,6 +8278,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"Tagging":{
"shape":"Tagging",
"documentation":"<p>Container for the <code>TagSet</code> and <code>Tag</code> elements.</p>",
@@ -7632,7 +8292,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7658,6 +8318,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"MFA":{
"shape":"MFA",
"documentation":"<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.</p>",
@@ -7672,7 +8338,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7698,6 +8364,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"WebsiteConfiguration":{
"shape":"WebsiteConfiguration",
"documentation":"<p>Container for the request.</p>",
@@ -7706,7 +8378,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7754,6 +8426,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p> <p>This action is not supported by Amazon S3 on Outposts.</p>",
@@ -7786,7 +8464,7 @@
},
"Key":{
"shape":"ObjectKey",
- "documentation":"<p>Key for which the PUT action was initiated.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>Key for which the PUT action was initiated.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Key"
},
@@ -7803,7 +8481,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7829,19 +8507,19 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the object that you want to place a Legal Hold on. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the object that you want to place a legal hold on. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Key":{
"shape":"ObjectKey",
- "documentation":"<p>The key name for the object that you want to place a Legal Hold on.</p>",
+ "documentation":"<p>The key name for the object that you want to place a legal hold on.</p>",
"location":"uri",
"locationName":"Key"
},
"LegalHold":{
"shape":"ObjectLockLegalHold",
- "documentation":"<p>Container element for the Legal Hold configuration you want to apply to the specified object.</p>",
+ "documentation":"<p>Container element for the legal hold configuration you want to apply to the specified object.</p>",
"locationName":"LegalHold",
"xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}
},
@@ -7852,7 +8530,7 @@
},
"VersionId":{
"shape":"ObjectVersionId",
- "documentation":"<p>The version ID of the object that you want to place a Legal Hold on.</p>",
+ "documentation":"<p>The version ID of the object that you want to place a legal hold on.</p>",
"location":"querystring",
"locationName":"versionId"
},
@@ -7862,9 +8540,15 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7914,9 +8598,15 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -7928,7 +8618,7 @@
"members":{
"Expiration":{
"shape":"Expiration",
- "documentation":"<p> If the expiration is configured for the object (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a>), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.</p>",
+ "documentation":"<p>If the expiration is configured for the object (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs that provide information about object expiration. The value of the <code>rule-id</code> is URL-encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
@@ -7938,6 +8628,30 @@
"location":"header",
"locationName":"ETag"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"<p>If you specified server-side encryption either with an Amazon Web Services KMS key or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.</p>",
@@ -8007,7 +8721,7 @@
},
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name to which the PUT action was initiated. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name to which the PUT action was initiated. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -8053,6 +8767,36 @@
"location":"header",
"locationName":"Content-Type"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"Expires":{
"shape":"Expires",
"documentation":"<p>The date and time at which the object is no longer cacheable. For more information, see <a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21\">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21</a>.</p>",
@@ -8180,7 +8924,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -8245,9 +8989,15 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -8275,7 +9025,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the object. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the object. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -8297,6 +9047,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"Tagging":{
"shape":"Tagging",
"documentation":"<p>Container for the <code>TagSet</code> and <code>Tag</code> elements</p>",
@@ -8305,7 +9061,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
},
@@ -8336,6 +9092,12 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"PublicAccessBlockConfiguration":{
"shape":"PublicAccessBlockConfiguration",
"documentation":"<p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a> in the <i>Amazon S3 User Guide</i>.</p>",
@@ -8344,7 +9106,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -8642,7 +9404,7 @@
},
"RequestPayer":{
"type":"string",
- "documentation":"<p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html\">Downloading Objects in Requestor Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html\">Downloading Objects in Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>",
"enum":["requester"]
},
"RequestPaymentConfiguration":{
@@ -8703,7 +9465,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name containing the object to restore. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name containing the object to restore. </p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -8729,9 +9491,15 @@
"location":"header",
"locationName":"x-amz-request-payer"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -8925,7 +9693,7 @@
"members":{
"Start":{
"shape":"Start",
- "documentation":"<p>Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file.For example; <code>&lt;scanrange&gt;&lt;start&gt;50&lt;/start&gt;&lt;/scanrange&gt;</code> means scan from byte 50 until the end of the file.</p>"
+ "documentation":"<p>Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only <code>start</code> is supplied, it means scan from that point to the end of the file. For example, <code>&lt;scanrange&gt;&lt;start&gt;50&lt;/start&gt;&lt;/scanrange&gt;</code> means scan from byte 50 until the end of the file.</p>"
},
"End":{
"shape":"End",
@@ -8996,19 +9764,19 @@
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
- "documentation":"<p>The SSE Algorithm used to encrypt the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
+ "documentation":"<p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
- "documentation":"<p>The SSE Customer Key. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
+ "documentation":"<p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
- "documentation":"<p>The SSE Customer Key MD5. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
+ "documentation":"<p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
@@ -9038,7 +9806,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -9496,13 +10264,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The bucket name.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The bucket name.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
"CopySource":{
"shape":"CopySource",
- "documentation":"<p>Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">access point</a>:</p> <ul> <li> <p>For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object <code>reports/january.pdf</code> from the bucket <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL encoded.</p> </li> <li> <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:&lt;Region&gt;:&lt;account-id&gt;:accesspoint/&lt;access-point-name&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p> <note> <p>Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.</p> </note> <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:&lt;Region&gt;:&lt;account-id&gt;:outpost/&lt;outpost-id&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL encoded. </p> </li> </ul> <p>To copy a specific version of an object, append <code>?versionId=&lt;version-id&gt;</code> to the value (for example, <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.</p>",
+ "documentation":"<p>Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">access point</a>:</p> <ul> <li> <p>For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object <code>reports/january.pdf</code> from the bucket <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL-encoded.</p> </li> <li> <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:&lt;Region&gt;:&lt;account-id&gt;:accesspoint/&lt;access-point-name&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p> <note> <p>Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.</p> </note> <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:&lt;Region&gt;:&lt;account-id&gt;:outpost/&lt;outpost-id&gt;/object/&lt;key&gt;</code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. </p> </li> </ul> <p>To copy a specific version of an object, append <code>?versionId=&lt;version-id&gt;</code> to the value (for example, <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.</p>",
"location":"header",
"locationName":"x-amz-copy-source"
},
@@ -9597,13 +10365,13 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
},
"ExpectedSourceBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-source-expected-bucket-owner"
}
@@ -9624,6 +10392,30 @@
"location":"header",
"locationName":"ETag"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
@@ -9671,7 +10463,7 @@
},
"Bucket":{
"shape":"BucketName",
- "documentation":"<p>The name of the bucket to which the multipart upload was initiated.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "documentation":"<p>The name of the bucket to which the multipart upload was initiated.</p> <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>",
"location":"uri",
"locationName":"Bucket"
},
@@ -9687,6 +10479,36 @@
"location":"header",
"locationName":"Content-MD5"
},
+ "ChecksumAlgorithm":{
+ "shape":"ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p> <p>This checksum algorithm must be the same for all parts and it match the checksum value supplied in the <code>CreateMultipartUpload</code> request.</p>",
+ "location":"header",
+ "locationName":"x-amz-sdk-checksum-algorithm"
+ },
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>",
+ "location":"header",
+ "locationName":"x-amz-checksum-sha256"
+ },
"Key":{
"shape":"ObjectKey",
"documentation":"<p>Object key for which the multipart upload was initiated.</p>",
@@ -9730,7 +10552,7 @@
},
"ExpectedBucketOwner":{
"shape":"AccountId",
- "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP <code>403 (Access Denied)</code> error.</p>",
+ "documentation":"<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>",
"location":"header",
"locationName":"x-amz-expected-bucket-owner"
}
@@ -9812,13 +10634,13 @@
},
"StatusCode":{
"shape":"GetObjectResponseStatusCode",
- "documentation":"<p>The integer status code for an HTTP response of a corresponding <code>GetObject</code> request.</p> <p class=\"title\"> <b>Status Codes</b> </p> <ul> <li> <p> <i>200 - OK</i> </p> </li> <li> <p> <i>206 - Partial Content</i> </p> </li> <li> <p> <i>304 - Not Modified</i> </p> </li> <li> <p> <i>400 - Bad Request</i> </p> </li> <li> <p> <i>401 - Unauthorized</i> </p> </li> <li> <p> <i>403 - Forbidden</i> </p> </li> <li> <p> <i>404 - Not Found</i> </p> </li> <li> <p> <i>405 - Method Not Allowed</i> </p> </li> <li> <p> <i>409 - Conflict</i> </p> </li> <li> <p> <i>411 - Length Required</i> </p> </li> <li> <p> <i>412 - Precondition Failed</i> </p> </li> <li> <p> <i>416 - Range Not Satisfiable</i> </p> </li> <li> <p> <i>500 - Internal Server Error</i> </p> </li> <li> <p> <i>503 - Service Unavailable</i> </p> </li> </ul>",
+ "documentation":"<p>The integer status code for an HTTP response of a corresponding <code>GetObject</code> request.</p> <p class=\"title\"> <b>Status Codes</b> </p> <ul> <li> <p> <code>200 - OK</code> </p> </li> <li> <p> <code>206 - Partial Content</code> </p> </li> <li> <p> <code>304 - Not Modified</code> </p> </li> <li> <p> <code>400 - Bad Request</code> </p> </li> <li> <p> <code>401 - Unauthorized</code> </p> </li> <li> <p> <code>403 - Forbidden</code> </p> </li> <li> <p> <code>404 - Not Found</code> </p> </li> <li> <p> <code>405 - Method Not Allowed</code> </p> </li> <li> <p> <code>409 - Conflict</code> </p> </li> <li> <p> <code>411 - Length Required</code> </p> </li> <li> <p> <code>412 - Precondition Failed</code> </p> </li> <li> <p> <code>416 - Range Not Satisfiable</code> </p> </li> <li> <p> <code>500 - Internal Server Error</code> </p> </li> <li> <p> <code>503 - Service Unavailable</code> </p> </li> </ul>",
"location":"header",
"locationName":"x-amz-fwd-status"
},
"ErrorCode":{
"shape":"ErrorCode",
- "documentation":"<p>A string that uniquely identifies an error condition. Returned in the &lt;Code&gt; tag of the error XML response for a corresponding <code>GetObject</code> call. Cannot be used with a successful <code>StatusCode</code> header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. Regex value is \"^[A-Z][a-zA-Z]+$\".</p>",
+ "documentation":"<p>A string that uniquely identifies an error condition. Returned in the &lt;Code&gt; tag of the error XML response for a corresponding <code>GetObject</code> call. Cannot be used with a successful <code>StatusCode</code> header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is <code>\"^[A-Z][a-zA-Z]+$\"</code>.</p>",
"location":"header",
"locationName":"x-amz-fwd-error-code"
},
@@ -9876,6 +10698,30 @@
"location":"header",
"locationName":"x-amz-fwd-header-Content-Type"
},
+ "ChecksumCRC32":{
+ "shape":"ChecksumCRC32",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p> <p/>",
+ "location":"header",
+ "locationName":"x-amz-fwd-header-x-amz-checksum-crc32"
+ },
+ "ChecksumCRC32C":{
+ "shape":"ChecksumCRC32C",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>",
+ "location":"header",
+ "locationName":"x-amz-fwd-header-x-amz-checksum-crc32c"
+ },
+ "ChecksumSHA1":{
+ "shape":"ChecksumSHA1",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>",
+ "location":"header",
+ "locationName":"x-amz-fwd-header-x-amz-checksum-sha1"
+ },
+ "ChecksumSHA256":{
+ "shape":"ChecksumSHA256",
+ "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>",
+ "location":"header",
+ "locationName":"x-amz-fwd-header-x-amz-checksum-sha256"
+ },
"DeleteMarker":{
"shape":"DeleteMarker",
"documentation":"<p>Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not (<code>false</code>) a delete marker. </p>",
@@ -9896,7 +10742,7 @@
},
"Expiration":{
"shape":"Expiration",
- "documentation":"<p>If object stored in Amazon S3 expiration is configured (see PUT Bucket lifecycle) it includes expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded. </p>",
+ "documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs that provide the object expiration information. The value of the <code>rule-id</code> is URL-encoded. </p>",
"location":"header",
"locationName":"x-amz-fwd-header-x-amz-expiration"
},
@@ -9985,7 +10831,7 @@
},
"StorageClass":{
"shape":"StorageClass",
- "documentation":"<p> The class of storage used to store object in Amazon S3.</p>",
+ "documentation":"<p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html\">Storage Classes</a>.</p>",
"location":"header",
"locationName":"x-amz-fwd-header-x-amz-storage-class"
},
diff --git a/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json b/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json
index f46d44bd23..085065aeb6 100644
--- a/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json
@@ -4400,6 +4400,15 @@
"bucket-owner-full-control"
]
},
+ "S3ChecksumAlgorithm":{
+ "type":"string",
+ "enum":[
+ "CRC32",
+ "CRC32C",
+ "SHA1",
+ "SHA256"
+ ]
+ },
"S3ContentLength":{
"type":"long",
"min":0
@@ -4476,6 +4485,10 @@
"BucketKeyEnabled":{
"shape":"Boolean",
"documentation":"<p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p> <p>Specifying this header with an <i>object</i> action doesn’t affect <i>bucket-level</i> settings for S3 Bucket Key.</p>"
+ },
+ "ChecksumAlgorithm":{
+ "shape":"S3ChecksumAlgorithm",
+ "documentation":"<p>Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/CheckingObjectIntegrity.xml\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>"
}
},
"documentation":"<p>Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying PUT Copy object API. For more information about the parameters for this operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html\">PUT Object - Copy</a>.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/paginators-1.json b/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/paginators-1.json
index 87587d156b..d74556d69f 100644
--- a/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/paginators-1.json
@@ -5,6 +5,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Endpoints"
+ },
+ "ListSharedEndpoints": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "Endpoints"
}
}
}
diff --git a/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/service-2.json
index 942f9101ba..c62245c9aa 100644
--- a/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/s3outposts/2017-07-25/service-2.json
@@ -28,7 +28,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p> <p>This action creates an endpoint and associates it with the specified Outposts.</p> <note> <p>It can take up to 5 minutes for this action to complete.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
+ "documentation":"<p>Creates an endpoint and associates it with the specified Outpost.</p> <note> <p>It can take up to 5 minutes for this action to finish.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
},
"DeleteEndpoint":{
"name":"DeleteEndpoint",
@@ -43,7 +43,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p> <p>This action deletes an endpoint.</p> <note> <p>It can take up to 5 minutes for this action to complete.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
+ "documentation":"<p>Deletes an endpoint.</p> <note> <p>It can take up to 5 minutes for this action to finish.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
},
"ListEndpoints":{
"name":"ListEndpoints",
@@ -59,7 +59,23 @@
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"}
],
- "documentation":"<p>Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p> <p>This action lists endpoints associated with the Outposts. </p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> </ul>"
+ "documentation":"<p>Lists endpoints associated with the specified Outpost. </p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> </ul>"
+ },
+ "ListSharedEndpoints":{
+ "name":"ListSharedEndpoints",
+ "http":{
+ "method":"GET",
+ "requestUri":"/S3Outposts/ListSharedEndpoints"
+ },
+ "input":{"shape":"ListSharedEndpointsRequest"},
+ "output":{"shape":"ListSharedEndpointsResult"},
+ "errors":[
+ {"shape":"InternalServerException"},
+ {"shape":"ResourceNotFoundException"},
+ {"shape":"AccessDeniedException"},
+ {"shape":"ValidationException"}
+ ],
+ "documentation":"<p>Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).</p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> </ul>"
}
},
"shapes":{
@@ -92,11 +108,11 @@
"members":{
"OutpostId":{
"shape":"OutpostId",
- "documentation":"<p>The ID of the AWS Outposts. </p>"
+ "documentation":"<p>The ID of the Outposts. </p>"
},
"SubnetId":{
"shape":"SubnetId",
- "documentation":"<p>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has the Amazon S3 on Outposts provisioned.</p>"
+ "documentation":"<p>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.</p>"
},
"SecurityGroupId":{
"shape":"SecurityGroupId",
@@ -104,11 +120,11 @@
},
"AccessType":{
"shape":"EndpointAccessType",
- "documentation":"<p>The type of access for the on-premise network connectivity for the Outpost endpoint. To access the endpoint from an on-premises network, you must specify the access type and provide the customer owned IPv4 pool.</p>"
+ "documentation":"<p>The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose <code>Private</code>. To use the endpoint with an on-premises network, choose <code>CustomerOwnedIp</code>. If you choose <code>CustomerOwnedIp</code>, you must also provide the customer-owned IP address pool (CoIP pool).</p> <note> <p> <code>Private</code> is the default access type value.</p> </note>"
},
"CustomerOwnedIpv4Pool":{
"shape":"CustomerOwnedIpv4Pool",
- "documentation":"<p>The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.</p>"
+ "documentation":"<p>The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.</p>"
}
}
},
@@ -141,7 +157,7 @@
},
"OutpostId":{
"shape":"OutpostId",
- "documentation":"<p>The ID of the AWS Outposts. </p>",
+ "documentation":"<p>The ID of the Outposts. </p>",
"location":"querystring",
"locationName":"outpostId"
}
@@ -156,7 +172,7 @@
},
"OutpostsId":{
"shape":"OutpostId",
- "documentation":"<p>The ID of the AWS Outposts.</p>"
+ "documentation":"<p>The ID of the Outposts.</p>"
},
"CidrBlock":{
"shape":"CidrBlock",
@@ -188,14 +204,14 @@
},
"AccessType":{
"shape":"EndpointAccessType",
- "documentation":"<p/>"
+ "documentation":"<p>The type of connectivity used to access the Amazon S3 on Outposts endpoint.</p>"
},
"CustomerOwnedIpv4Pool":{
"shape":"CustomerOwnedIpv4Pool",
- "documentation":"<p>The ID of the customer-owned IPv4 pool used for the endpoint.</p>"
+ "documentation":"<p>The ID of the customer-owned IPv4 address pool used for the endpoint.</p>"
}
},
- "documentation":"<p>Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p>"
+ "documentation":"<p>Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html\"> Accessing S3 on Outposts using VPC-only access points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"EndpointAccessType":{
"type":"string",
@@ -240,13 +256,13 @@
"members":{
"NextToken":{
"shape":"NextToken",
- "documentation":"<p>The next endpoint requested in the list.</p>",
+ "documentation":"<p>If a previous response from this operation included a <code>NextToken</code> value, provide that value here to retrieve the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
- "documentation":"<p>The max number of endpoints that can be returned on the request.</p>",
+ "documentation":"<p>The maximum number of endpoints that will be returned in the response.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@@ -257,11 +273,48 @@
"members":{
"Endpoints":{
"shape":"Endpoints",
- "documentation":"<p>Returns an array of endpoints associated with AWS Outposts.</p>"
+ "documentation":"<p>The list of endpoints associated with the specified Outpost.</p>"
+ },
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>If the number of endpoints associated with the specified Outpost exceeds <code>MaxResults</code>, you can include this value in subsequent calls to this operation to retrieve more results.</p>"
+ }
+ }
+ },
+ "ListSharedEndpointsRequest":{
+ "type":"structure",
+ "required":["OutpostId"],
+ "members":{
+ "NextToken":{
+ "shape":"NextToken",
+ "documentation":"<p>If a previous response from this operation included a <code>NextToken</code> value, you can provide that value here to retrieve the next page of results.</p>",
+ "location":"querystring",
+ "locationName":"nextToken"
+ },
+ "MaxResults":{
+ "shape":"MaxResults",
+ "documentation":"<p>The maximum number of endpoints that will be returned in the response.</p>",
+ "location":"querystring",
+ "locationName":"maxResults"
+ },
+ "OutpostId":{
+ "shape":"OutpostId",
+ "documentation":"<p>The ID of the Amazon Web Services Outpost.</p>",
+ "location":"querystring",
+ "locationName":"outpostId"
+ }
+ }
+ },
+ "ListSharedEndpointsResult":{
+ "type":"structure",
+ "members":{
+ "Endpoints":{
+ "shape":"Endpoints",
+ "documentation":"<p>The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).</p>"
},
"NextToken":{
"shape":"NextToken",
- "documentation":"<p>The next endpoint returned in the list.</p>"
+ "documentation":"<p>If the number of endpoints associated with the specified Outpost exceeds <code>MaxResults</code>, you can include this value in subsequent calls to this operation to retrieve more results.</p>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/secretsmanager/2017-10-17/service-2.json b/contrib/python/botocore/py3/botocore/data/secretsmanager/2017-10-17/service-2.json
index 2ab0e1dbf0..464ef7171c 100644
--- a/contrib/python/botocore/py3/botocore/data/secretsmanager/2017-10-17/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/secretsmanager/2017-10-17/service-2.json
@@ -175,7 +175,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"InternalServiceError"}
],
- "documentation":"<p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account. </p> <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p> <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>, call <a>GetSecretValue</a>.</p> <p>For information about finding secrets in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html\">Enhanced search capabilities for secrets in Secrets Manager</a>.</p> <p> <b>Required permissions: </b> <code>secretsmanager:ListSecrets</code>. For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\"> IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication and access control in Secrets Manager</a>. </p>"
+ "documentation":"<p>Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.</p> <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p> <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>, call <a>GetSecretValue</a>.</p> <p>For information about finding secrets in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html\">Enhanced search capabilities for secrets in Secrets Manager</a>.</p> <p> <b>Required permissions: </b> <code>secretsmanager:ListSecrets</code>. For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\"> IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication and access control in Secrets Manager</a>. </p>"
},
"PutResourcePolicy":{
"name":"PutResourcePolicy",
diff --git a/contrib/python/botocore/py3/botocore/data/servicecatalog-appregistry/2020-06-24/service-2.json b/contrib/python/botocore/py3/botocore/data/servicecatalog-appregistry/2020-06-24/service-2.json
index 5cc5f543ec..9dfd7f6a6a 100644
--- a/contrib/python/botocore/py3/botocore/data/servicecatalog-appregistry/2020-06-24/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/servicecatalog-appregistry/2020-06-24/service-2.json
@@ -1394,7 +1394,9 @@
},
"name":{
"shape":"Name",
- "documentation":"<p>The new name of the application. The name must be unique in the region in which you are updating the application.</p>"
+ "documentation":"<p>The new name of the application. The name must be unique in the region in which you are updating the application.</p>",
+ "deprecated":true,
+ "deprecatedMessage":"Name update for application is deprecated."
},
"description":{
"shape":"Description",
@@ -1423,7 +1425,9 @@
},
"name":{
"shape":"Name",
- "documentation":"<p>The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group.</p>"
+ "documentation":"<p>The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group.</p>",
+ "deprecated":true,
+ "deprecatedMessage":"Name update for attribute group is deprecated."
},
"description":{
"shape":"Description",
diff --git a/contrib/python/botocore/py3/botocore/data/ssm-incidents/2018-05-10/service-2.json b/contrib/python/botocore/py3/botocore/data/ssm-incidents/2018-05-10/service-2.json
index 1ff42cb673..9cc266525d 100644
--- a/contrib/python/botocore/py3/botocore/data/ssm-incidents/2018-05-10/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ssm-incidents/2018-05-10/service-2.json
@@ -1277,7 +1277,7 @@
"documentation":"<p>The principal that started the incident.</p>"
},
"invokedBy":{
- "shape":"Arn",
+ "shape":"ServicePrincipal",
"documentation":"<p>The principal the assumed the role specified of the <code>createdBy</code>.</p>"
},
"resourceArn":{
@@ -1992,6 +1992,11 @@
"type":"string",
"enum":["ssm-incidents"]
},
+ "ServicePrincipal":{
+ "type":"string",
+ "max":1000,
+ "min":0
+ },
"ServiceQuotaExceededException":{
"type":"structure",
"required":[
diff --git a/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json b/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json
index 1ebd3125b1..aa13205942 100644
--- a/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json
@@ -1133,7 +1133,7 @@
{"shape":"DoesNotExistException"},
{"shape":"InternalServerError"}
],
- "documentation":"<p>Lists the tasks in a maintenance window.</p> <note> <p>For maintenance window tasks without a specified target, you can't supply values for <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.</p> </note>"
+ "documentation":"<p>Retrieves the details of a maintenance window task.</p> <note> <p>For maintenance window tasks without a specified target, you can't supply values for <code>--max-errors</code> and <code>--max-concurrency</code>. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.</p> </note> <p>To retrieve a list of tasks in a maintenance window, instead use the <a>DescribeMaintenanceWindowTasks</a> command.</p>"
},
"GetOpsItem":{
"name":"GetOpsItem",
@@ -1881,7 +1881,7 @@
"errors":[
{"shape":"InternalServerError"}
],
- "documentation":"<p>Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session isn't be resumed.</p>"
+ "documentation":"<p>Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.</p>"
},
"UnlabelParameterVersion":{
"name":"UnlabelParameterVersion",
@@ -1921,7 +1921,7 @@
{"shape":"InvalidAssociationVersion"},
{"shape":"AssociationVersionLimitExceeded"}
],
- "documentation":"<p>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call <code>UpdateAssociation</code>, the system drops all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the <code>Name</code> parameter. Before calling this API action, we recommend that you call the <a>DescribeAssociation</a> API operation and make a note of all optional parameters required for your <code>UpdateAssociation</code> call.</p> <p>In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API operation. If you don't have permission to call <code>DescribeAssociation</code>, then you receive the following error: <code>An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: &lt;user_arn&gt; isn't authorized to perform: ssm:DescribeAssociation on resource: &lt;resource_arn&gt;</code> </p> <important> <p>When you update an association, the association immediately runs against the specified targets. You can add the <code>ApplyOnlyAtCronInterval</code> parameter to run the association during the next schedule run.</p> </important>"
+ "documentation":"<p>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call <code>UpdateAssociation</code>, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the <code>Name</code> parameter. Before calling this API action, we recommend that you call the <a>DescribeAssociation</a> API operation and make a note of all optional parameters required for your <code>UpdateAssociation</code> call.</p> <p>In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API operation. If you don't have permission to call <code>DescribeAssociation</code>, then you receive the following error: <code>An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: &lt;user_arn&gt; isn't authorized to perform: ssm:DescribeAssociation on resource: &lt;resource_arn&gt;</code> </p> <important> <p>When you update an association, the association immediately runs against the specified targets. You can add the <code>ApplyOnlyAtCronInterval</code> parameter to run the association during the next schedule run.</p> </important>"
},
"UpdateAssociationStatus":{
"name":"UpdateAssociationStatus",
@@ -1977,7 +1977,7 @@
{"shape":"InvalidDocumentVersion"},
{"shape":"InvalidDocumentSchemaVersion"}
],
- "documentation":"<p>Set the default version of a document. </p>"
+ "documentation":"<p>Set the default version of a document. </p> <note> <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p> </note>"
},
"UpdateDocumentMetadata":{
"name":"UpdateDocumentMetadata",
@@ -2159,7 +2159,7 @@
"AccountSharingInfoList":{
"type":"list",
"member":{"shape":"AccountSharingInfo"},
- "documentation":"<p>A list of of Amazon Web Services accounts where the current document is shared and the version shared with each account.</p>"
+ "documentation":"<p>A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.</p>"
},
"Accounts":{
"type":"list",
@@ -2346,7 +2346,7 @@
},
"DocumentVersion":{
"shape":"DocumentVersion",
- "documentation":"<p>The version of the document used in the association.</p> <important> <p>State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the <code>default</code> version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to <code>default</code>.</p> </important>"
+ "documentation":"<p>The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p> <important> <p>State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the <code>default</code> version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to <code>default</code>.</p> </important>"
},
"Targets":{
"shape":"Targets",
@@ -4483,7 +4483,7 @@
},
"DocumentType":{
"shape":"DocumentType",
- "documentation":"<p>The type of document to create.</p>"
+ "documentation":"<p>The type of document to create.</p> <note> <p>The <code>DeploymentStrategy</code> document type is an internal-use-only document type reserved for AppConfig.</p> </note>"
},
"DocumentFormat":{
"shape":"DocumentFormat",
@@ -6629,7 +6629,7 @@
"documentation":"<p>The value for the filter key.</p>"
}
},
- "documentation":"<p>One or more filters. Use a filter to return a more specific list of documents.</p> <p>For keys, you can specify one or more tags that have been applied to a document. </p> <p>You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:</p> <dl> <dt>DocumentType</dt> <dd> <ul> <li> <p> <code>ApplicationConfiguration</code> </p> </li> <li> <p> <code>ApplicationConfigurationSchema</code> </p> </li> <li> <p> <code>Automation</code> </p> </li> <li> <p> <code>ChangeCalendar</code> </p> </li> <li> <p> <code>Command</code> </p> </li> <li> <p> <code>DeploymentStrategy</code> </p> </li> <li> <p> <code>Package</code> </p> </li> <li> <p> <code>Policy</code> </p> </li> <li> <p> <code>Session</code> </p> </li> </ul> </dd> <dt>Owner</dt> <dd> <p>Note that only one <code>Owner</code> can be specified in a request. For example: <code>Key=Owner,Values=Self</code>.</p> <ul> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>Private</code> </p> </li> <li> <p> <code>Public</code> </p> </li> <li> <p> <code>Self</code> </p> </li> <li> <p> <code>ThirdParty</code> </p> </li> </ul> </dd> <dt>PlatformTypes</dt> <dd> <ul> <li> <p> <code>Linux</code> </p> </li> <li> <p> <code>Windows</code> </p> </li> </ul> </dd> </dl> <p> <code>Name</code> is another Amazon Web Services-provided key. If you use <code>Name</code> as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with <code>Te</code>, run the following command:</p> <p> <code>aws ssm list-documents --filters Key=Name,Values=Te</code> </p> <p>You can also use the <code>TargetType</code> Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p> <p>If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.</p> <p>To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p> <p>For example, if you created a key called region and are using the Amazon Web Services CLI to call the <code>list-documents</code> command: </p> <p> <code>aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self</code> </p>"
+ "documentation":"<p>One or more filters. Use a filter to return a more specific list of documents.</p> <p>For keys, you can specify one or more tags that have been applied to a document. </p> <p>You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:</p> <dl> <dt>DocumentType</dt> <dd> <ul> <li> <p> <code>ApplicationConfiguration</code> </p> </li> <li> <p> <code>ApplicationConfigurationSchema</code> </p> </li> <li> <p> <code>Automation</code> </p> </li> <li> <p> <code>ChangeCalendar</code> </p> </li> <li> <p> <code>Command</code> </p> </li> <li> <p> <code>Package</code> </p> </li> <li> <p> <code>Policy</code> </p> </li> <li> <p> <code>Session</code> </p> </li> </ul> </dd> <dt>Owner</dt> <dd> <p>Note that only one <code>Owner</code> can be specified in a request. For example: <code>Key=Owner,Values=Self</code>.</p> <ul> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>Private</code> </p> </li> <li> <p> <code>Public</code> </p> </li> <li> <p> <code>Self</code> </p> </li> <li> <p> <code>ThirdParty</code> </p> </li> </ul> </dd> <dt>PlatformTypes</dt> <dd> <ul> <li> <p> <code>Linux</code> </p> </li> <li> <p> <code>Windows</code> </p> </li> </ul> </dd> </dl> <p> <code>Name</code> is another Amazon Web Services-provided key. If you use <code>Name</code> as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with <code>Te</code>, run the following command:</p> <p> <code>aws ssm list-documents --filters Key=Name,Values=Te</code> </p> <p>You can also use the <code>TargetType</code> Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p> <p>If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.</p> <p>To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p> <p>For example, if you created a key called region and are using the Amazon Web Services CLI to call the <code>list-documents</code> command: </p> <p> <code>aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self</code> </p>"
},
"DocumentKeyValuesFilterKey":{
"type":"string",
@@ -7982,7 +7982,7 @@
"members":{
"Path":{
"shape":"PSParameterName",
- "documentation":"<p>The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: <code>/Finance/Prod/IAD/WinServ2016/license33 </code> </p>"
+ "documentation":"<p>The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: <code>/Finance/Prod/IAD/WinServ2016/license33 </code> </p>"
},
"Recursive":{
"shape":"Boolean",
@@ -8060,7 +8060,7 @@
},
"OperatingSystem":{
"shape":"OperatingSystem",
- "documentation":"<p>Returns he operating system rule specified for patch groups using the patch baseline.</p>"
+ "documentation":"<p>Returns the operating system rule specified for patch groups using the patch baseline.</p>"
}
}
},
@@ -10753,11 +10753,11 @@
},
"MaxConcurrency":{
"shape":"MaxConcurrency",
- "documentation":"<p>The maximum number of targets this task can be run for, in parallel.</p>"
+ "documentation":"<p>The maximum number of targets this task can be run for, in parallel.</p> <note> <p>Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">targetless task</a> You must provide a value in all other cases.</p> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>"
},
"MaxErrors":{
"shape":"MaxErrors",
- "documentation":"<p>The maximum number of errors allowed before this task stops being scheduled.</p>"
+ "documentation":"<p>The maximum number of errors allowed before this task stops being scheduled.</p> <note> <p>Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">targetless task</a> You must provide a value in all other cases.</p> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>"
},
"Name":{
"shape":"MaintenanceWindowName",
@@ -11063,7 +11063,8 @@
"ORACLE_LINUX",
"DEBIAN",
"MACOS",
- "RASPBIAN"
+ "RASPBIAN",
+ "ROCKY_LINUX"
]
},
"OpsAggregator":{
@@ -12060,11 +12061,11 @@
},
"Type":{
"shape":"ParameterType",
- "documentation":"<p>The type of parameter. Valid values include the following: <code>String</code>, <code>StringList</code>, and <code>SecureString</code>.</p>"
+ "documentation":"<p>The type of parameter. Valid values include the following: <code>String</code>, <code>StringList</code>, and <code>SecureString</code>.</p> <note> <p>If type is <code>StringList</code>, the system returns a comma-separated string with no spaces between commas in the <code>Value</code> field.</p> </note>"
},
"Value":{
"shape":"PSParameterValue",
- "documentation":"<p>The parameter value.</p>"
+ "documentation":"<p>The parameter value.</p> <note> <p>If type is <code>StringList</code>, the system returns a comma-separated string with no spaces between commas in the <code>Value</code> field.</p> </note>"
},
"Version":{
"shape":"PSParameterVersion",
@@ -12182,7 +12183,7 @@
},
"PolicyType":{
"shape":"String",
- "documentation":"<p>The type of policy. Parameter Store, a capablility of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. </p>"
+ "documentation":"<p>The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. </p>"
},
"PolicyStatus":{
"shape":"String",
@@ -12629,7 +12630,7 @@
},
"Severity":{
"shape":"PatchSeverity",
- "documentation":"<p>The severity of the patchsuch as <code>Critical</code>, <code>Important</code>, and <code>Moderate</code>.</p>"
+ "documentation":"<p>The severity of the patch such as <code>Critical</code>, <code>Important</code>, and <code>Moderate</code>.</p>"
},
"State":{
"shape":"PatchComplianceDataState",
@@ -13152,7 +13153,7 @@
"members":{
"Name":{
"shape":"PSParameterName",
- "documentation":"<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an Amazon Web Services Region</p> </li> <li> <p>A parameter name can't be prefixed with \"<code>aws</code>\" or \"<code>ssm</code>\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code> </p> <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html\">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:</p> <p> <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code> </p> </note>"
+ "documentation":"<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an Amazon Web Services Region</p> </li> <li> <p>A parameter name can't be prefixed with \"<code>aws</code>\" or \"<code>ssm</code>\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code> </p> <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html\">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint of 2048 characters listed below includes 1037 characters reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is 1011 characters. This includes the characters in the ARN that precede the name you specify, such as <code>arn:aws:ssm:us-east-2:111122223333:parameter/</code>.</p> </note>"
},
"Description":{
"shape":"ParameterDescription",
@@ -13193,7 +13194,7 @@
},
"DataType":{
"shape":"ParameterDataType",
- "documentation":"<p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p> <p> <b>The following data type values are supported.</b> </p> <ul> <li> <p> <code>text</code> </p> </li> <li> <p> <code>aws:ec2:image</code> </p> </li> </ul> <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html\">Native parameter support for Amazon Machine Image (AMI) IDs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
+ "documentation":"<p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p> <p> <b>The following data type values are supported.</b> </p> <ul> <li> <p> <code>text</code> </p> </li> <li> <p> <code>aws:ec2:image</code> </p> </li> <li> <p> <code>aws:ssm:integration</code> </p> </li> </ul> <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html\">Native parameter support for Amazon Machine Image (AMI) IDs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
}
}
},
@@ -13365,12 +13366,12 @@
},
"MaxConcurrency":{
"shape":"MaxConcurrency",
- "documentation":"<p>The maximum number of targets this task can be run for in parallel.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>",
+ "documentation":"<p>The maximum number of targets this task can be run for, in parallel.</p> <note> <p>Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">targetless task</a> You must provide a value in all other cases.</p> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>",
"box":true
},
"MaxErrors":{
"shape":"MaxErrors",
- "documentation":"<p>The maximum number of errors allowed before this task stops being scheduled.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>",
+ "documentation":"<p>The maximum number of errors allowed before this task stops being scheduled.</p> <note> <p>Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">targetless task</a> You must provide a value in all other cases.</p> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>",
"box":true
},
"LoggingInfo":{
@@ -13908,7 +13909,8 @@
"Parameter",
"PatchBaseline",
"OpsItem",
- "OpsMetadata"
+ "OpsMetadata",
+ "Automation"
]
},
"ResponseCode":{"type":"integer"},
@@ -14690,7 +14692,7 @@
},
"Parameters":{
"shape":"SessionManagerParameters",
- "documentation":"<p>Reserved for future use.</p>"
+ "documentation":"<p>The values you want to specify for the parameters defined in the Session document.</p>"
}
}
},
@@ -15298,7 +15300,7 @@
},
"ApplyOnlyAtCronInterval":{
"shape":"ApplyOnlyAtCronInterval",
- "documentation":"<p>By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.</p> <p>Also, if you specified this option when you created the association, you can reset it. To do so, specify the <code>no-apply-only-at-cron-interval</code> parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.</p>"
+ "documentation":"<p>By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.</p> <p>If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the <code>Latest</code> version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.</p> <p>You can reset this option. To do so, specify the <code>no-apply-only-at-cron-interval</code> parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.</p>"
},
"CalendarNames":{
"shape":"CalendarNameOrARNList",
@@ -15431,7 +15433,7 @@
},
"DocumentVersion":{
"shape":"DocumentVersion",
- "documentation":"<p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p>"
+ "documentation":"<p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p> <note> <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p> </note>"
},
"DocumentFormat":{
"shape":"DocumentFormat",
@@ -15470,7 +15472,7 @@
},
"StartDate":{
"shape":"MaintenanceWindowStringDateTime",
- "documentation":"<p>The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p>"
+ "documentation":"<p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. <code>StartDate</code> allows you to delay activation of the maintenance window until the specified future date.</p>"
},
"EndDate":{
"shape":"MaintenanceWindowStringDateTime",
@@ -15679,11 +15681,11 @@
},
"MaxConcurrency":{
"shape":"MaxConcurrency",
- "documentation":"<p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task in parallel.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.</p> </note>"
+ "documentation":"<p>The new <code>MaxConcurrency</code> value you want to specify. <code>MaxConcurrency</code> is the number of targets that are allowed to run this task, in parallel.</p> <note> <p>Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">targetless task</a> You must provide a value in all other cases.</p> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>"
},
"MaxErrors":{
"shape":"MaxErrors",
- "documentation":"<p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled.</p> <note> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.</p> </note>"
+ "documentation":"<p>The new <code>MaxErrors</code> value to specify. <code>MaxErrors</code> is the maximum number of errors that are allowed before the task stops being scheduled.</p> <note> <p>Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">targetless task</a> You must provide a value in all other cases.</p> <p>For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of <code>1</code>. This value doesn't affect the running of your task.</p> </note>"
},
"LoggingInfo":{
"shape":"LoggingInfo",
@@ -15870,7 +15872,7 @@
"members":{
"OpsMetadataArn":{
"shape":"OpsMetadataArn",
- "documentation":"<p>The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.</p>"
+ "documentation":"<p>The Amazon Resource Name (ARN) of the OpsMetadata Object to update.</p>"
},
"MetadataToUpdate":{
"shape":"MetadataMap",
diff --git a/contrib/python/botocore/py3/botocore/data/sts/2011-06-15/service-2.json b/contrib/python/botocore/py3/botocore/data/sts/2011-06-15/service-2.json
index a793781267..990994190c 100644
--- a/contrib/python/botocore/py3/botocore/data/sts/2011-06-15/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/sts/2011-06-15/service-2.json
@@ -73,7 +73,7 @@
{"shape":"ExpiredTokenException"},
{"shape":"RegionDisabledException"}
],
- "documentation":"<p>Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.</p> <note> <p>For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href=\"http://aws.amazon.com/sdkforios/\">Amazon Web Services SDK for iOS Developer Guide</a> and the <a href=\"http://aws.amazon.com/sdkforandroid/\">Amazon Web Services SDK for Android Developer Guide</a> to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.</p> <p>To learn more about Amazon Cognito, see <a href=\"https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840\">Amazon Cognito Overview</a> in <i>Amazon Web Services SDK for Android Developer Guide</i> and <a href=\"https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664\">Amazon Cognito Overview</a> in the <i>Amazon Web Services SDK for iOS Developer Guide</i>.</p> </note> <p>Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of Amazon Web Services security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term Amazon Web Services credentials in the application. You also don't need to deploy server-based proxy services that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of <code>AssumeRoleWithWebIdentity</code> with the other API operations that produce temporary credentials, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html\">Requesting Temporary Security Credentials</a> and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison\">Comparing the Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services service API operations.</p> <p> <b>Session Duration</b> </p> <p>By default, the temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session\">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html\">Using IAM Roles</a> in the <i>IAM User Guide</i>. </p> <p> <b>Permissions</b> </p> <p>The temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session\">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session\">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p> <b>Tags</b> </p> <p>(Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html\">Passing Session Tags in STS</a> in the <i>IAM User Guide</i>.</p> <p>You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length\">IAM and STS Character Limits</a> in the <i>IAM User Guide</i>.</p> <note> <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The <code>PackedPolicySize</code> response element indicates by percentage how close the policies and tags for your request are to the upper size limit. </p> </note> <p>You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key.</p> <p>An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html\">Tutorial: Using Tags for Attribute-Based Access Control</a> in the <i>IAM User Guide</i>.</p> <p>You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining\">Chaining Roles with Session Tags</a> in the <i>IAM User Guide</i>.</p> <p> <b>Identities</b> </p> <p>Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </p> <important> <p>Calling <code>AssumeRoleWithWebIdentity</code> can result in an entry in your CloudTrail logs. The entry includes the <a href=\"http://openid.net/specs/openid-connect-core-1_0.html#Claims\">Subject</a> of the provided web identity token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as <a href=\"http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes\">suggested in the OIDC specification</a>.</p> </important> <p>For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html\">Using Web Identity Federation API Operations for Mobile Apps</a> and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity\">Federation Through a Web-based Identity Provider</a>. </p> </li> <li> <p> <a href=\"https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/\"> Web Identity Federation Playground</a>. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to Amazon Web Services. </p> </li> <li> <p> <a href=\"http://aws.amazon.com/sdkforios/\">Amazon Web Services SDK for iOS Developer Guide</a> and <a href=\"http://aws.amazon.com/sdkforandroid/\">Amazon Web Services SDK for Android Developer Guide</a>. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials. </p> </li> <li> <p> <a href=\"http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications\">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </p> </li> </ul>"
+ "documentation":"<p>Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html\">Amazon Cognito federated identities</a>.</p> <note> <p>For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href=\"http://aws.amazon.com/sdkforios/\">Amazon Web Services SDK for iOS Developer Guide</a> and the <a href=\"http://aws.amazon.com/sdkforandroid/\">Amazon Web Services SDK for Android Developer Guide</a> to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.</p> <p>To learn more about Amazon Cognito, see <a href=\"https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840\">Amazon Cognito Overview</a> in <i>Amazon Web Services SDK for Android Developer Guide</i> and <a href=\"https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664\">Amazon Cognito Overview</a> in the <i>Amazon Web Services SDK for iOS Developer Guide</i>.</p> </note> <p>Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of Amazon Web Services security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term Amazon Web Services credentials in the application. You also don't need to deploy server-based proxy services that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of <code>AssumeRoleWithWebIdentity</code> with the other API operations that produce temporary credentials, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html\">Requesting Temporary Security Credentials</a> and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison\">Comparing the Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to Amazon Web Services service API operations.</p> <p> <b>Session Duration</b> </p> <p>By default, the temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session\">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html\">Using IAM Roles</a> in the <i>IAM User Guide</i>. </p> <p> <b>Permissions</b> </p> <p>The temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> can be used to make API calls to any Amazon Web Services service with the following exception: you cannot call the STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session\">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session\">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p> <b>Tags</b> </p> <p>(Optional) You can configure your IdP to pass attributes into your web identity token as session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html\">Passing Session Tags in STS</a> in the <i>IAM User Guide</i>.</p> <p>You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length\">IAM and STS Character Limits</a> in the <i>IAM User Guide</i>.</p> <note> <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The <code>PackedPolicySize</code> response element indicates by percentage how close the policies and tags for your request are to the upper size limit. </p> </note> <p>You can pass a session tag with the same key as a tag that is attached to the role. When you do, the session tag overrides the role tag with the same key.</p> <p>An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html\">Tutorial: Using Tags for Attribute-Based Access Control</a> in the <i>IAM User Guide</i>.</p> <p>You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining\">Chaining Roles with Session Tags</a> in the <i>IAM User Guide</i>.</p> <p> <b>Identities</b> </p> <p>Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </p> <important> <p>Calling <code>AssumeRoleWithWebIdentity</code> can result in an entry in your CloudTrail logs. The entry includes the <a href=\"http://openid.net/specs/openid-connect-core-1_0.html#Claims\">Subject</a> of the provided web identity token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as <a href=\"http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes\">suggested in the OIDC specification</a>.</p> </important> <p>For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html\">Using Web Identity Federation API Operations for Mobile Apps</a> and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity\">Federation Through a Web-based Identity Provider</a>. </p> </li> <li> <p> <a href=\"https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/\"> Web Identity Federation Playground</a>. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to Amazon Web Services. </p> </li> <li> <p> <a href=\"http://aws.amazon.com/sdkforios/\">Amazon Web Services SDK for iOS Developer Guide</a> and <a href=\"http://aws.amazon.com/sdkforandroid/\">Amazon Web Services SDK for Android Developer Guide</a>. These toolkits contain sample apps that show how to invoke the identity providers. The toolkits then show how to use the information from these providers to get and use temporary security credentials. </p> </li> <li> <p> <a href=\"http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications\">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </p> </li> </ul>"
},
"DecodeAuthorizationMessage":{
"name":"DecodeAuthorizationMessage",
@@ -182,7 +182,7 @@
},
"Tags":{
"shape":"tagListType",
- "documentation":"<p>A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html\">Tagging Amazon Web Services STS Sessions</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length\">IAM and STS Character Limits</a> in the <i>IAM User Guide</i>.</p> <note> <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The <code>PackedPolicySize</code> response element indicates by percentage how close the policies and tags for your request are to the upper size limit. </p> </note> <p>You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key. </p> <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the <code>department</code>=<code>engineering</code> session tag. <code>Department</code> and <code>department</code> are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.</p> <p>Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/session-tags.html#id_session-tags_ctlogs\">Viewing Session Tags in CloudTrail</a> in the <i>IAM User Guide</i>.</p>"
+ "documentation":"<p>A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html\">Tagging Amazon Web Services STS Sessions</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length\">IAM and STS Character Limits</a> in the <i>IAM User Guide</i>.</p> <note> <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a packed binary format that has a separate limit. Your request can fail for this limit even if your plaintext meets the other requirements. The <code>PackedPolicySize</code> response element indicates by percentage how close the policies and tags for your request are to the upper size limit. </p> </note> <p>You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key. </p> <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the <code>department</code>=<code>engineering</code> session tag. <code>Department</code> and <code>department</code> are not saved as separate tags, and the session tag passed in the request takes precedence over the role tag.</p> <p>Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_ctlogs\">Viewing Session Tags in CloudTrail</a> in the <i>IAM User Guide</i>.</p>"
},
"TransitiveTagKeys":{
"shape":"tagKeyListType",
@@ -326,7 +326,7 @@
},
"ProviderId":{
"shape":"urlType",
- "documentation":"<p>The fully qualified host component of the domain name of the identity provider.</p> <p>Specify this value only for OAuth 2.0 access tokens. Currently <code>www.amazon.com</code> and <code>graph.facebook.com</code> are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.</p> <p>Do not specify this value for OpenID Connect ID tokens.</p>"
+ "documentation":"<p>The fully qualified host component of the domain name of the OAuth 2.0 identity provider. Do not specify this value for an OpenID Connect identity provider.</p> <p>Currently <code>www.amazon.com</code> and <code>graph.facebook.com</code> are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.</p> <p>Do not specify this value for OpenID Connect ID tokens.</p>"
},
"PolicyArns":{
"shape":"policyDescriptorListType",
diff --git a/contrib/python/botocore/py3/botocore/data/synthetics/2017-10-11/service-2.json b/contrib/python/botocore/py3/botocore/data/synthetics/2017-10-11/service-2.json
index b9e0cebf3a..a15681f851 100644
--- a/contrib/python/botocore/py3/botocore/data/synthetics/2017-10-11/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/synthetics/2017-10-11/service-2.json
@@ -365,8 +365,8 @@
"documentation":"<p>If you input your canary script directly into the canary instead of referring to an S3 location, the value of this parameter is the base64-encoded contents of the .zip file that contains the script. It must be smaller than 225 Kb.</p> <p>For large canary scripts, we recommend that you use an S3 location instead of inputting it directly with this parameter.</p>"
},
"Handler":{
- "shape":"String",
- "documentation":"<p>The entry point to use for the source code when running the canary. This value must end with the string <code>.handler</code>. The string is limited to 29 characters or fewer.</p>"
+ "shape":"CodeHandler",
+ "documentation":"<p>The entry point to use for the source code when running the canary. For canaries that use the <code>syn-python-selenium-1.0</code> runtime or a <code>syn-nodejs.puppeteer</code> runtime earlier than <code>syn-nodejs.puppeteer-3.4</code>, the handler must be specified as <code> <i>fileName</i>.handler</code>. For <code>syn-python-selenium-1.1</code>, <code>syn-nodejs.puppeteer-3.4</code>, and later runtimes, the handler can be specified as <code> <i>fileName</i>.<i>functionName</i> </code>, or you can specify a folder where canary scripts reside as <code> <i>folder</i>/<i>fileName</i>.<i>functionName</i> </code>.</p>"
}
},
"documentation":"<p>Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of <code>Zipfile</code>. </p>"
@@ -609,6 +609,12 @@
},
"documentation":"<p>This structure contains information about when the canary was created and modified.</p>"
},
+ "CodeHandler":{
+ "type":"string",
+ "max":128,
+ "min":1,
+ "pattern":"^([0-9a-zA-Z_-]+\\/)*[0-9A-Za-z_\\\\-]+\\.[A-Za-z_][A-Za-z0-9_]*$"
+ },
"ConflictException":{
"type":"structure",
"members":{
diff --git a/contrib/python/botocore/py3/botocore/data/textract/2018-06-27/service-2.json b/contrib/python/botocore/py3/botocore/data/textract/2018-06-27/service-2.json
index 74d1724eb0..d8eaf573b1 100644
--- a/contrib/python/botocore/py3/botocore/data/textract/2018-06-27/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/textract/2018-06-27/service-2.json
@@ -422,7 +422,9 @@
"WORD",
"TABLE",
"CELL",
- "SELECTION_ELEMENT"
+ "SELECTION_ELEMENT",
+ "MERGED_CELL",
+ "TITLE"
]
},
"BoundingBox":{
@@ -543,7 +545,8 @@
"type":"string",
"enum":[
"KEY",
- "VALUE"
+ "VALUE",
+ "COLUMN_HEADER"
]
},
"EntityTypes":{
@@ -1167,7 +1170,9 @@
"enum":[
"VALUE",
"CHILD",
- "COMPLEX_FEATURES"
+ "COMPLEX_FEATURES",
+ "MERGED_CELL",
+ "TITLE"
]
},
"RoleArn":{
diff --git a/contrib/python/botocore/py3/botocore/data/timestream-query/2018-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/timestream-query/2018-11-01/service-2.json
index 1fb30ad505..5e03179abf 100644
--- a/contrib/python/botocore/py3/botocore/data/timestream-query/2018-11-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/timestream-query/2018-11-01/service-2.json
@@ -29,7 +29,7 @@
{"shape":"ValidationException"},
{"shape":"InvalidEndpointException"}
],
- "documentation":"<p> Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a <code>CancellationMessage</code>, indicating that the query has already been canceled. See <a href=\"https://docs.aws.amazon.com/Timestream/latest/developerguide/code-samples.cancel-query.html\">code sample</a> for details. </p>",
+ "documentation":"<p> Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a <code>CancellationMessage</code>, indicating that the query has already been canceled. See <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html\">code sample</a> for details. </p>",
"endpointdiscovery":{"required":true},
"idempotent":true
},
@@ -86,7 +86,7 @@
{"shape":"ValidationException"},
{"shape":"ThrottlingException"}
],
- "documentation":"<p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.</p> <p>Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, <i>it is not recommended that you use this API unless</i>:</p> <ul> <li> <p>You are using <a href=\"https://docs.aws.amazon.com/Timestream/latest/developerguide/VPCEndpoints\">VPC endpoints (Amazon Web Services PrivateLink) with Timestream </a> </p> </li> <li> <p>Your application uses a programming language that does not yet have SDK support</p> </li> <li> <p>You require better control over the client-side implementation</p> </li> </ul> <p>For detailed information on how and when to use and implement DescribeEndpoints, see <a href=\"https://docs.aws.amazon.com/Timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery\">The Endpoint Discovery Pattern</a>.</p>",
+ "documentation":"<p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.</p> <p>Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, <i>it is not recommended that you use this API unless</i>:</p> <ul> <li> <p>You are using <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints\">VPC endpoints (Amazon Web Services PrivateLink) with Timestream </a> </p> </li> <li> <p>Your application uses a programming language that does not yet have SDK support</p> </li> <li> <p>You require better control over the client-side implementation</p> </li> </ul> <p>For detailed information on how and when to use and implement DescribeEndpoints, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery\">The Endpoint Discovery Pattern</a>.</p>",
"endpointoperation":true
},
"DescribeScheduledQuery":{
@@ -198,7 +198,7 @@
{"shape":"ValidationException"},
{"shape":"InvalidEndpointException"}
],
- "documentation":"<p> <code>Query</code> is a synchronous operation that enables you to run a query against your Amazon Timestream data. <code>Query</code> will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the <a href=\"https://docs.aws.amazon.com/Timestream/latest/developerguide/code-samples.run-query.html\">code sample</a> for details. </p> <p>Your query request will fail in the following cases:</p> <ul> <li> <p> If you submit a <code>Query</code> request with the same client token outside of the 5-minute idempotency window. </p> </li> <li> <p> If you submit a <code>Query</code> request with the same client token, but change other parameters, within the 5-minute idempotency window. </p> </li> <li> <p> If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: </p> <p> <code>Query aborted as max page response size has been exceeded by the output result row</code> </p> </li> <li> <p> If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an <code>Invalid pagination token</code> error. </p> </li> </ul>",
+ "documentation":"<p> <code>Query</code> is a synchronous operation that enables you to run a query against your Amazon Timestream data. <code>Query</code> will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html\">code sample</a> for details. </p> <p>Your query request will fail in the following cases:</p> <ul> <li> <p> If you submit a <code>Query</code> request with the same client token outside of the 5-minute idempotency window. </p> </li> <li> <p> If you submit a <code>Query</code> request with the same client token, but change other parameters, within the 5-minute idempotency window. </p> </li> <li> <p> If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: </p> <p> <code>Query aborted as max page response size has been exceeded by the output result row</code> </p> </li> <li> <p> If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an <code>Invalid pagination token</code> error. </p> </li> </ul>",
"endpointdiscovery":{"required":true},
"idempotent":true
},
@@ -1020,7 +1020,8 @@
"BIGINT",
"BOOLEAN",
"DOUBLE",
- "VARCHAR"
+ "VARCHAR",
+ "TIMESTAMP"
]
},
"ScalarType":{
diff --git a/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json b/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json
index bfa10fdc96..5ae1359d82 100644
--- a/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json
@@ -27,7 +27,7 @@
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Creates an analytics category. Amazon Transcribe applies the conditions specified by your analytics categories to your call analytics jobs. For each analytics category, you specify one or more rules. For example, you can specify a rule that the customer sentiment was neutral or negative within that category. If you start a call analytics job, Amazon Transcribe applies the category to the analytics job that you've specified.</p>"
+ "documentation":"<p>Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: \"Please note this call may be recorded.\") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.</p>"
},
"CreateLanguageModel":{
"name":"CreateLanguageModel",
@@ -43,7 +43,7 @@
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.</p>"
+ "documentation":"<p>Creates a new custom language model. When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.</p>"
},
"CreateMedicalVocabulary":{
"name":"CreateMedicalVocabulary",
@@ -59,7 +59,7 @@
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.</p>"
+ "documentation":"<p>Creates a new custom medical vocabulary.</p> <p>When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the <code>Phrases</code> flag, as <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code> flag.</p> <p>For more information on creating a custom vocabulary text file, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html\">Creating a custom vocabulary</a>.</p>"
},
"CreateVocabulary":{
"name":"CreateVocabulary",
@@ -75,7 +75,7 @@
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.</p>"
+ "documentation":"<p>Creates a new custom vocabulary.</p> <p>When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the <code>Phrases</code> flag.</p> <p>For more information on creating a custom vocabulary, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html\">Creating a custom vocabulary</a>.</p>"
},
"CreateVocabularyFilter":{
"name":"CreateVocabularyFilter",
@@ -91,7 +91,7 @@
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
- "documentation":"<p>Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.</p>"
+ "documentation":"<p>Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript.</p>"
},
"DeleteCallAnalyticsCategory":{
"name":"DeleteCallAnalyticsCategory",
@@ -107,7 +107,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a call analytics category using its name.</p>"
+ "documentation":"<p>Deletes a call analytics category. To use this operation, specify the name of the category you want to delete using <code>CategoryName</code>.</p>"
},
"DeleteCallAnalyticsJob":{
"name":"DeleteCallAnalyticsJob",
@@ -122,7 +122,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a call analytics job using its name.</p>"
+ "documentation":"<p>Deletes a call analytics job. To use this operation, specify the name of the job you want to delete using <code>CallAnalyticsJobName</code>.</p>"
},
"DeleteLanguageModel":{
"name":"DeleteLanguageModel",
@@ -136,7 +136,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a custom language model using its name.</p>"
+ "documentation":"<p>Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using <code>ModelName</code>.</p>"
},
"DeleteMedicalTranscriptionJob":{
"name":"DeleteMedicalTranscriptionJob",
@@ -150,7 +150,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a transcription job generated by Amazon Transcribe Medical and any related information.</p>"
+ "documentation":"<p>Deletes a medical transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using <code>MedicalTranscriptionJobName</code>.</p>"
},
"DeleteMedicalVocabulary":{
"name":"DeleteMedicalVocabulary",
@@ -165,7 +165,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a vocabulary from Amazon Transcribe Medical.</p>"
+ "documentation":"<p>Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using <code>VocabularyName</code>.</p>"
},
"DeleteTranscriptionJob":{
"name":"DeleteTranscriptionJob",
@@ -179,7 +179,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.</p>"
+ "documentation":"<p>Deletes a transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using <code>TranscriptionJobName</code>.</p>"
},
"DeleteVocabulary":{
"name":"DeleteVocabulary",
@@ -194,7 +194,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Deletes a vocabulary from Amazon Transcribe. </p>"
+ "documentation":"<p>Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using <code>VocabularyName</code>.</p>"
},
"DeleteVocabularyFilter":{
"name":"DeleteVocabularyFilter",
@@ -209,7 +209,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
- "documentation":"<p>Removes a vocabulary filter.</p>"
+ "documentation":"<p>Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using <code>VocabularyFilterName</code>.</p>"
},
"DescribeLanguageModel":{
"name":"DescribeLanguageModel",
@@ -225,7 +225,7 @@
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Gets information about a single custom language model. Use this information to see details about the language model in your Amazon Web Services account. You can also see whether the base language model used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If the language model wasn't created, you can use this operation to understand why Amazon Transcribe couldn't create it. </p>"
+ "documentation":"<p>Provides information about a specific custom language model in your Amazon Web Services account.</p> <p>This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.</p> <p>If you tried to create a new custom language model and the request wasn't successful, you can use this operation to help identify the reason. </p>"
},
"GetCallAnalyticsCategory":{
"name":"GetCallAnalyticsCategory",
@@ -257,7 +257,7 @@
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Returns information about a call analytics job. To see the status of the job, check the <code>CallAnalyticsJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptFileUri</code> field. If you enable personally identifiable information (PII) redaction, the redacted transcript appears in the <code>RedactedTranscriptFileUri</code> field.</p>"
+ "documentation":"<p>Retrieves information about a call analytics job.</p> <p>To view the job's status, refer to the <code>CallAnalyticsJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished. You can then find your transcript at the URI specified in the <code>TranscriptFileUri</code> field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the <code>RedactedTranscriptFileUri</code> field.</p>"
},
"GetMedicalTranscriptionJob":{
"name":"GetMedicalTranscriptionJob",
@@ -273,7 +273,7 @@
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"}
],
- "documentation":"<p>Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished. You find the results of the completed job in the <code>TranscriptFileUri</code> field.</p>"
+ "documentation":"<p>Retrieves information about a medical transcription job.</p> <p>To view the job's status, refer to the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished. You can then find your transcript at the URI specified in the <code>TranscriptFileUri</code> field.</p>"
},
"GetMedicalVocabulary":{
"name":"GetMedicalVocabulary",
@@ -691,7 +691,7 @@
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
- "documentation":"<p>The sample rate, in Hertz, of the audio.</p>"
+ "documentation":"<p>The sample rate, in Hertz, of the input audio.</p>"
},
"MediaFormat":{
"shape":"MediaFormat",
@@ -914,11 +914,11 @@
"members":{
"CategoryName":{
"shape":"CategoryName",
- "documentation":"<p>The name that you choose for your category when you create it. </p>"
+ "documentation":"<p>A unique name, chosen by you, for your call analytics category. For example, <code>sentiment-positive-last30seconds</code>.</p>"
},
"Rules":{
"shape":"RuleList",
- "documentation":"<p>To create a category, you must specify between 1 and 20 rules. For each rule, you specify a filter to be applied to the attributes of the call. For example, you can specify a sentiment filter to detect if the customer's sentiment was negative or neutral.</p>"
+ "documentation":"<p>Rules make up a call analytics category. When creating a call analytics category, you must create between 1 and 20 rules for your category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.</p>"
}
}
},
@@ -927,7 +927,7 @@
"members":{
"CategoryProperties":{
"shape":"CategoryProperties",
- "documentation":"<p>The rules and associated metadata used to create a category.</p>"
+ "documentation":"<p>If your audio matches one of your categories, this field contains data on that category and its associated rules. This parameter shows which category is flagged (<code>CategoryName</code>) along with metadata for the rules that match your audio. Metadata includes the rule filter (such as <code>InterruptionFilter</code>, <code>NonTalkTimeFilter</code>, <code>SentimentFilter</code>, and <code>TranscriptFilter</code>) and where in your audio (<code>StartTime</code> and <code>EndTime</code>) the rule has a match.</p>"
}
}
},
@@ -942,23 +942,23 @@
"members":{
"LanguageCode":{
"shape":"CLMLanguageCode",
- "documentation":"<p>The language of the input text you're using to train your custom language model.</p>"
+ "documentation":"<p>The language of your custom language model; note that the language code you select must match the language of your training and tuning data.</p>"
},
"BaseModelName":{
"shape":"BaseModelName",
- "documentation":"<p>The Amazon Transcribe standard language model, or base model used to create your custom language model.</p> <p>If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, choose <code>Wideband</code>.</p> <p>If you want to use your custom language model to transcribe audio with a sample rate that is less than 16,000 Hz, choose <code>Narrowband</code>.</p>"
+ "documentation":"<p>The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.</p> <p>If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose <code>WideBand</code>. To transcribe audio with a sample rate less than 16,000 Hz, choose <code>NarrowBand</code>.</p>"
},
"ModelName":{
"shape":"ModelName",
- "documentation":"<p>The name you choose for your custom language model when you create it.</p>"
+ "documentation":"<p>The name of your new custom language model.</p> <p>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a language model with the same name as a previous language model, you get a <code>ConflictException</code> error.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
- "documentation":"<p>Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom language model.</p>"
+ "documentation":"<p>Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 locations of your training (<code>S3Uri</code>) and tuning (<code>TuningDataS3Uri</code>) data.</p>"
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create this new model.</p>"
+ "documentation":"<p>Optionally add tags, each in the form of a key:value pair, to your new language model. See also: .</p>"
}
}
},
@@ -967,23 +967,23 @@
"members":{
"LanguageCode":{
"shape":"CLMLanguageCode",
- "documentation":"<p>The language code of the text you've used to create a custom language model.</p>"
+ "documentation":"<p>The language code you selected for your custom language model.</p>"
},
"BaseModelName":{
"shape":"BaseModelName",
- "documentation":"<p>The Amazon Transcribe standard language model, or base model you've used to create a custom language model.</p>"
+ "documentation":"<p>The Amazon Transcribe standard language model, or base model, you used when creating your custom language model.</p> <p>If your audio has a sample rate of 16,000 Hz or greater, this value should be <code>WideBand</code>. If your audio has a sample rate of less than 16,000 Hz, this value should be <code>NarrowBand</code>.</p>"
},
"ModelName":{
"shape":"ModelName",
- "documentation":"<p>The name you've chosen for your custom language model.</p>"
+ "documentation":"<p>The unique name you chose for your custom language model.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
- "documentation":"<p>The data access role and Amazon S3 prefixes you've chosen to create your custom language model.</p>"
+ "documentation":"<p>Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations your provided for your training (<code>S3Uri</code>) and tuning (<code>TuningDataS3Uri</code>) data.</p>"
},
"ModelStatus":{
"shape":"ModelStatus",
- "documentation":"<p>The status of the custom language model. When the status is <code>COMPLETED</code> the model is ready to use.</p>"
+ "documentation":"<p>The status of your custom language model. When the status shows as <code>COMPLETED</code>, your model is ready to use.</p>"
}
}
},
@@ -997,19 +997,19 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the custom vocabulary. This case-sensitive name must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a <code>ConflictException</code> error.</p>"
+ "documentation":"<p>The name of your new vocabulary.</p> <p>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a <code>ConflictException</code> error.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
- "documentation":"<p>The language code for the language used for the entries in your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.</p>"
+ "documentation":"<p>The language code that represents the language of the entries in your custom vocabulary. Note that U.S. English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>"
},
"VocabularyFileUri":{
"shape":"Uri",
- "documentation":"<p>The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling. Enter information about your <code>VocabularyFileUri</code> in the following format:</p> <p> <code>https://s3.&lt;aws-region&gt;.amazonaws.com/&lt;bucket-name&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt;</code> </p> <p>The following is an example URI for a vocabulary file that is stored in Amazon S3:</p> <p> <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code> </p> <p>For more information about Amazon S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>For more information about custom vocabularies, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html\">Medical Custom Vocabularies</a>.</p>"
+ "documentation":"<p>The Amazon S3 location (URI) of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling.</p> <p>Here's an example URI path:</p> <p> <code>https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt</code> </p>"
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.</p>"
+ "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create the new vocabulary.</p> <p>To learn more about using tags with Amazon Transcribe, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html\">Tagging resources</a>.</p>"
}
}
},
@@ -1018,23 +1018,23 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case sensitive.</p>"
+ "documentation":"<p>The name you chose for your vocabulary.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
- "documentation":"<p>The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.</p>"
+ "documentation":"<p>The language code you selected for your medical vocabulary. Note that U.S. English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
- "documentation":"<p>The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is <code>READY</code>, you can use the vocabulary in a <code>StartMedicalTranscriptionJob</code> request.</p>"
+ "documentation":"<p>The processing state of your custom medical vocabulary. If the state is <code>READY</code>, you can use the vocabulary in a <code>StartMedicalTranscriptionJob</code> request.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
- "documentation":"<p>The date and time that you created the vocabulary.</p>"
+ "documentation":"<p>The date and time you created your custom medical vocabulary.</p>"
},
"FailureReason":{
"shape":"FailureReason",
- "documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
+ "documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, <code>FailureReason</code> contains information about why the job failed.</p>"
}
}
},
@@ -1047,7 +1047,7 @@
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
- "documentation":"<p>The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a <code>ConflictException</code> error.</p>"
+ "documentation":"<p>The name of your new vocabulary filter.</p> <p>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary filter with the same name as a previous vocabulary filter, you get a <code>ConflictException</code> error.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
@@ -1055,15 +1055,15 @@
},
"Words":{
"shape":"Words",
- "documentation":"<p>The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html\">Character Sets for Custom Vocabularies</a>.</p> <p>If you provide a list of words in the <code>Words</code> parameter, you can't use the <code>VocabularyFilterFileUri</code> parameter.</p>"
+ "documentation":"<p>The words you want in your vocabulary filter. Only use characters specified in the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html\">Character sets</a> for the language you're transcribing.</p> <p>Note that if you include <code>Words</code> in your request, you cannot use <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>"
},
"VocabularyFilterFileUri":{
"shape":"Uri",
- "documentation":"<p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html\">Character Sets for Custom Vocabularies</a>.</p> <p>The specified file must be less than 50 KB of UTF-8 characters.</p> <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code> parameter, you can't use the <code>Words</code> parameter.</p>"
+ "documentation":"<p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html\">Character Sets for Custom Vocabularies</a>.</p> <p>Your vocabulary filter file must be less than 50 KB in size.</p> <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you cannot use <code>Words</code>; you must choose one or the other.</p>"
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you create this new vocabulary filter.</p>"
+ "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new vocabulary filter at the time you create this new vocabulary filter.</p>"
}
}
},
@@ -1076,11 +1076,11 @@
},
"LanguageCode":{
"shape":"LanguageCode",
- "documentation":"<p>The language code of the words in the collection.</p>"
+ "documentation":"<p>The language code associated with your vocabulary filter.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
- "documentation":"<p>The date and time that the vocabulary filter was modified.</p>"
+ "documentation":"<p>The date and time the vocabulary filter was modified.</p>"
}
}
},
@@ -1093,23 +1093,23 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a <code>ConflictException</code> error.</p>"
+ "documentation":"<p>The name of your new vocabulary.</p> <p>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a <code>ConflictException</code> error.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
- "documentation":"<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a>table-language-matrix</a>.</p>"
+ "documentation":"<p>The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p>"
},
"Phrases":{
"shape":"Phrases",
- "documentation":"<p>An array of strings that contains the vocabulary entries. </p>"
+ "documentation":"<p>Use this flag to include a list of terms within your request.</p> <p>Note that if you include <code>Phrases</code> in your request, you cannot use <code>VocabularyFileUri</code>; you must choose one or the other.</p>"
},
"VocabularyFileUri":{
"shape":"Uri",
- "documentation":"<p>The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code>https://s3.&lt;Amazon Web Services-region&gt;.amazonaws.com/&lt;AWSDOC-EXAMPLE-BUCKET&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt; </code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code> </p> <p>For more information about S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>For more information about custom vocabularies, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html\">Custom vocabularies</a>.</p>"
+ "documentation":"<p>The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.</p> <p>Here's an example URI path:</p> <p> <code>https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt</code> </p> <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot use the <code>Phrases</code> flag; you must choose one or the other.</p>"
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.</p>"
+ "documentation":"<p>Adds one or more tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.</p>"
}
}
},
@@ -1118,23 +1118,23 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the vocabulary.</p>"
+ "documentation":"<p>The name you chose for your vocabulary.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
- "documentation":"<p>The language code of the vocabulary entries.</p>"
+ "documentation":"<p>The language code you selected for your vocabulary.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
- "documentation":"<p>The processing state of the vocabulary. When the <code>VocabularyState</code> field contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code> request.</p>"
+ "documentation":"<p>The processing state of your vocabulary. If the state is <code>READY</code>, you can use the vocabulary in a <code>StartTranscriptionJob</code> request.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
- "documentation":"<p>The date and time that the vocabulary was created.</p>"
+ "documentation":"<p>The date and time you created your custom vocabulary.</p>"
},
"FailureReason":{
"shape":"FailureReason",
- "documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
+ "documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, <code>FailureReason</code> contains information about why the job failed.</p>"
}
}
},
@@ -1151,7 +1151,7 @@
"members":{
"CategoryName":{
"shape":"CategoryName",
- "documentation":"<p>The name of the call analytics category that you're choosing to delete. The value is case sensitive. </p>"
+ "documentation":"<p>The name of the call analytics category you want to delete. Category names are case-sensitive.</p>"
}
}
},
@@ -1166,7 +1166,7 @@
"members":{
"CallAnalyticsJobName":{
"shape":"CallAnalyticsJobName",
- "documentation":"<p>The name of the call analytics job you want to delete.</p>"
+ "documentation":"<p>The name of the call analytics job you want to delete. Job names are case-sensitive.</p>"
}
}
},
@@ -1181,7 +1181,7 @@
"members":{
"ModelName":{
"shape":"ModelName",
- "documentation":"<p>The name of the model you're choosing to delete.</p>"
+ "documentation":"<p>The name of the model you want to delete. Model names are case-sensitive.</p>"
}
}
},
@@ -1191,7 +1191,7 @@
"members":{
"MedicalTranscriptionJobName":{
"shape":"TranscriptionJobName",
- "documentation":"<p>The name you provide to the <code>DeleteMedicalTranscriptionJob</code> object to delete a transcription job.</p>"
+ "documentation":"<p>The name of the medical transcription job you want to delete. Job names are case-sensitive.</p>"
}
}
},
@@ -1201,7 +1201,7 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the vocabulary that you want to delete.</p>"
+ "documentation":"<p>The name of the vocabulary that you want to delete. Vocabulary names are case-sensitive.</p>"
}
}
},
@@ -1211,7 +1211,7 @@
"members":{
"TranscriptionJobName":{
"shape":"TranscriptionJobName",
- "documentation":"<p>The name of the transcription job to be deleted.</p>"
+ "documentation":"<p>The name of the transcription job you want to delete. Job names are case-sensitive.</p>"
}
}
},
@@ -1221,7 +1221,7 @@
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
- "documentation":"<p>The name of the vocabulary filter to remove.</p>"
+ "documentation":"<p>The name of the vocabulary filter you want to delete. Vocabulary filter names are case-sensitive.</p>"
}
}
},
@@ -1231,7 +1231,7 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the vocabulary to delete. </p>"
+ "documentation":"<p>The name of the vocabulary you want to delete. Vocabulary names are case-sensitive.</p>"
}
}
},
@@ -1241,7 +1241,7 @@
"members":{
"ModelName":{
"shape":"ModelName",
- "documentation":"<p>The name of the custom language model you submit to get more information.</p>"
+ "documentation":"<p>The name of the custom language model you want described. Model names are case-sensitive.</p>"
}
}
},
@@ -1261,7 +1261,7 @@
"members":{
"CategoryName":{
"shape":"CategoryName",
- "documentation":"<p>The name of the category you want information about. This value is case sensitive.</p>"
+ "documentation":"<p>The name of the category you want information about. Category names are case sensitive.</p>"
}
}
},
@@ -1270,7 +1270,7 @@
"members":{
"CategoryProperties":{
"shape":"CategoryProperties",
- "documentation":"<p>The rules you've defined for a category.</p>"
+ "documentation":"<p>Provides you with the rules associated with the category you specified in your <code>GetCallAnalyticsCategory</code> request.</p>"
}
}
},
@@ -1280,7 +1280,7 @@
"members":{
"CallAnalyticsJobName":{
"shape":"CallAnalyticsJobName",
- "documentation":"<p>The name of the analytics job you want information about. This value is case sensitive. </p>"
+ "documentation":"<p>The name of the analytics job you want information about. This value is case sensitive.</p>"
}
}
},
@@ -1289,7 +1289,7 @@
"members":{
"CallAnalyticsJob":{
"shape":"CallAnalyticsJob",
- "documentation":"<p>An object that contains the results of your call analytics job.</p>"
+ "documentation":"<p>An object that contains detailed information about your call analytics job. Returned fields include: <code>CallAnalyticsJobName</code>, <code>CallAnalyticsJobStatus</code>, <code>ChannelDefinitions</code>, <code>CompletionTime</code>, <code>CreationTime</code>, <code>DataAccessRoleArn</code>, <code>FailureReason</code>, <code>IdentifiedLanguageScore</code>, <code>LanguageCode</code>, <code>Media</code>, <code>MediaFormat</code>, <code>MediaSampleRateHertz</code>, <code>Settings</code>, <code>StartTime</code>, and <code>Transcript</code>.</p>"
}
}
},
@@ -1299,7 +1299,7 @@
"members":{
"MedicalTranscriptionJobName":{
"shape":"TranscriptionJobName",
- "documentation":"<p>The name of the medical transcription job.</p>"
+ "documentation":"<p>The name of the medical transcription job you want information about. This value is case sensitive.</p>"
}
}
},
@@ -1308,7 +1308,7 @@
"members":{
"MedicalTranscriptionJob":{
"shape":"MedicalTranscriptionJob",
- "documentation":"<p>An object that contains the results of the medical transcription job.</p>"
+ "documentation":"<p>An object that contains detailed information about your medical transcription job. Returned fields include: <code>CompletionTime</code>, <code>ContentIdentificationType</code>, <code>CreationTime</code>, <code>FailureReason</code>, <code>LanguageCode</code>, <code>Media</code>, <code>MediaFormat</code>, <code>MediaSampleRateHertz</code>, <code>MedicalTranscriptionJobName</code>, <code>Settings</code>, <code>Specialty</code>, <code>StartTime</code>, <code>Tags</code>, <code>Transcript</code>, <code>TranscriptionJobStatus</code>, and <code>Type</code>.</p>"
}
}
},
@@ -1318,7 +1318,7 @@
"members":{
"VocabularyName":{
"shape":"VocabularyName",
- "documentation":"<p>The name of the vocabulary that you want information about. The value is case sensitive. </p>"
+ "documentation":"<p>The name of the medical vocabulary you want information about. This value is case sensitive.</p>"
}
}
},
@@ -1343,11 +1343,11 @@
},
"FailureReason":{
"shape":"FailureReason",
- "documentation":"<p>If the <code>VocabularyState</code> is <code>FAILED</code>, this field contains information about why the job failed.</p>"
+ "documentation":"<p>If your request returns a <code>VocabularyState</code> that is <code>FAILED</code>, the <code>FailureReason</code> field contains information about why the request failed.</p> <p>For more information, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html\">Common Errors</a> section.</p>"
},
"DownloadUri":{
"shape":"Uri",
- "documentation":"<p>The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.</p>"
+ "documentation":"<p>The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.</p>"
}
}
},
@@ -1624,7 +1624,7 @@
},
"UpgradeAvailability":{
"shape":"Boolean",
- "documentation":"<p>Whether the base model used for the custom language model is up to date. If this field is <code>true</code> then you are running the most up-to-date version of the base model in your custom language model.</p>"
+ "documentation":"<p>Whether the base model used for the custom language model is up to date. If this field is <code>false</code> then you are running the most up-to-date version of the base model in your custom language model.</p>"
},
"FailureReason":{
"shape":"FailureReason",
@@ -1816,7 +1816,7 @@
},
"NextToken":{
"shape":"NextToken",
- "documentation":"<p>The <code>ListMedicalVocabularies</code> operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the <code>MaxResults</code> parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the <code>NextPage</code> token. To return the next page of vocabularies, include the token in the next request to the <code>ListMedicalVocabularies</code> operation .</p>"
+ "documentation":"<p>The <code>ListMedicalVocabularies</code> operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the <code>MaxResults</code> parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the <code>NextPage</code> token. To return the next page of vocabularies, include the token in the next request to the <code>ListMedicalVocabularies</code> operation.</p>"
},
"Vocabularies":{
"shape":"Vocabularies",
@@ -1973,7 +1973,7 @@
"members":{
"MediaFileUri":{
"shape":"Uri",
- "documentation":"<p>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code> s3://&lt;AWSDOC-EXAMPLE-BUCKET&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt;</code> </p> <p>For example:</p> <p> <code>s3://AWSDOC-EXAMPLE-BUCKET/example.mp4</code> </p> <p> <code>s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4</code> </p> <p>For more information about S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
+ "documentation":"<p>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code>s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey</code> </p> <p>For example:</p> <p> <code>s3://DOC-EXAMPLE-BUCKET/example.flac</code> </p> <p> <code>s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac</code> </p> <p>For more information about S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
},
"RedactedMediaFileUri":{
"shape":"Uri",
@@ -2003,6 +2003,11 @@
"type":"string",
"enum":["PHI"]
},
+ "MedicalMediaSampleRateHertz":{
+ "type":"integer",
+ "max":48000,
+ "min":16000
+ },
"MedicalTranscript":{
"type":"structure",
"members":{
@@ -2029,7 +2034,7 @@
"documentation":"<p>The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a <code>BadRequestException</code> error.</p>"
},
"MediaSampleRateHertz":{
- "shape":"MediaSampleRateHertz",
+ "shape":"MedicalMediaSampleRateHertz",
"documentation":"<p>The sample rate, in Hertz, of the source audio containing medical information.</p> <p>If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.</p>"
},
"MediaFormat":{
@@ -2505,7 +2510,7 @@
"documentation":"<p>The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a <code>BadRequestException</code> error.</p>"
},
"MediaSampleRateHertz":{
- "shape":"MediaSampleRateHertz",
+ "shape":"MedicalMediaSampleRateHertz",
"documentation":"<p>The sample rate, in Hertz, of the audio track in the input media file.</p> <p>If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe Medical determine the sample rate.</p>"
},
"MediaFormat":{
@@ -2547,7 +2552,7 @@
},
"Tags":{
"shape":"TagList",
- "documentation":"<p>Add tags to an Amazon Transcribe medical transcription job.</p>"
+ "documentation":"<p>Add tags to an Amazon Transcribe Medical transcription job.</p>"
}
}
},
@@ -2573,7 +2578,7 @@
},
"LanguageCode":{
"shape":"LanguageCode",
- "documentation":"<p>The language code for the language used in the input media file.</p> <p>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.</p>"
+ "documentation":"<p>The language code for the language used in the input media file. You must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request.</p> <p>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.</p>"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
@@ -2621,7 +2626,7 @@
},
"IdentifyLanguage":{
"shape":"Boolean",
- "documentation":"<p>Set this field to <code>true</code> to enable automatic language identification. Automatic language identification is disabled by default. You receive a <code>BadRequestException</code> error if you enter a value for a <code>LanguageCode</code>.</p>"
+ "documentation":"<p>Set this field to <code>true</code> to enable automatic language identification. Automatic language identification is disabled by default. You receive a <code>BadRequestException</code> error if you enter a value for a <code>LanguageCode</code>.</p> <p>You must include either <code>LanguageCode</code> or <code>IdentifyLanguage</code> in your request.</p>"
},
"LanguageOptions":{
"shape":"LanguageOptions",
@@ -2646,7 +2651,7 @@
"members":{
"TranscriptionJob":{
"shape":"TranscriptionJob",
- "documentation":"<p>An object containing details of the asynchronous transcription job.</p>"
+ "documentation":"<p>Provides information about your asynchronous transcription job.</p>"
}
}
},
@@ -2671,29 +2676,42 @@
"type":"list",
"member":{"shape":"SubtitleFormat"}
},
+ "SubtitleOutputStartIndex":{
+ "type":"integer",
+ "max":1,
+ "min":0
+ },
"Subtitles":{
"type":"structure",
"members":{
"Formats":{
"shape":"SubtitleFormats",
- "documentation":"<p>Specify the output format for your subtitle file.</p>"
+ "documentation":"<p>Specify the output format for your subtitle file; if you select both <code>srt</code> and <code>vtt</code> formats, two output files are generated.</p>"
+ },
+ "OutputStartIndex":{
+ "shape":"SubtitleOutputStartIndex",
+ "documentation":"<p>Defines the starting value that is assigned to the first subtitle segment.</p> <p>The default start index for Amazon Transcribe is <code>0</code>, which differs from the more widely used standard of <code>1</code>. If you're uncertain which value to use, we recommend choosing <code>1</code>, as this may improve compatibility with other services.</p>"
}
},
- "documentation":"<p>Generate subtitles for your batch transcription job.</p>"
+ "documentation":"<p>Generate subtitles for your batch transcription job. Note that your subtitle files are placed in the same location as your transcription output.</p>"
},
"SubtitlesOutput":{
"type":"structure",
"members":{
"Formats":{
"shape":"SubtitleFormats",
- "documentation":"<p>Specify the output format for your subtitle file; if you select both SRT and VTT formats, two output files are generated.</p>"
+ "documentation":"<p>The format of your subtitle files. If your request specified both <code>srt</code> and <code>vtt</code> formats, both formats are shown.</p>"
},
"SubtitleFileUris":{
"shape":"SubtitleFileUris",
- "documentation":"<p>Choose the output location for your subtitle file. This location must be an S3 bucket.</p>"
+ "documentation":"<p>Contains the output location for your subtitle file. This location must be an S3 bucket.</p>"
+ },
+ "OutputStartIndex":{
+ "shape":"SubtitleOutputStartIndex",
+ "documentation":"<p>Shows the output start index value for your subtitle files. If you did not specify a value in your request, the default value of <code>0</code> is used.</p>"
}
},
- "documentation":"<p>Specify the output format for your subtitle file.</p>"
+ "documentation":"<p>The S3 location where your subtitle files are located. Note that your subtitle files are placed in the same location as your transcription output. Refer to <code>TranscriptFileUri</code> to download your files.</p>"
},
"Tag":{
"type":"structure",
@@ -3052,7 +3070,7 @@
},
"VocabularyFileUri":{
"shape":"Uri",
- "documentation":"<p>The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:</p> <p> <code> https://s3.&lt;aws-region&gt;.amazonaws.com/&lt;bucket-name&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt; </code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code> </p> <p>For more information about Amazon S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>For more information about custom vocabularies in Amazon Transcribe Medical, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html\">Medical Custom Vocabularies</a>.</p>"
+ "documentation":"<p>The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:</p> <p> <code>https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey</code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt</code> </p> <p>For more information about Amazon S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>For more information about custom vocabularies in Amazon Transcribe Medical, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html\">Medical Custom Vocabularies</a>.</p>"
}
}
},
@@ -3133,7 +3151,7 @@
},
"VocabularyFileUri":{
"shape":"Uri",
- "documentation":"<p>The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code>https://s3.&lt;aws-region&gt;.amazonaws.com/&lt;AWSDOC-EXAMPLE-BUCKET&gt;/&lt;keyprefix&gt;/&lt;objectkey&gt;</code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code> </p> <p>For more information about S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>For more information about custom vocabularies, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html\">Custom Vocabularies</a>.</p>"
+ "documentation":"<p>The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code>https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey</code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt</code> </p> <p>For more information about S3 object names, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>For more information about custom vocabularies, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html\">Custom Vocabularies</a>.</p>"
}
}
},
diff --git a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/paginators-1.json b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/paginators-1.json
index cef7950830..b737abb91d 100644
--- a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/paginators-1.json
+++ b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/paginators-1.json
@@ -5,6 +5,54 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Servers"
+ },
+ "ListAccesses": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "ServerId"
+ ],
+ "output_token": "NextToken",
+ "result_key": "Accesses"
+ },
+ "ListExecutions": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "WorkflowId"
+ ],
+ "output_token": "NextToken",
+ "result_key": "Executions"
+ },
+ "ListSecurityPolicies": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "SecurityPolicyNames"
+ },
+ "ListTagsForResource": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "Arn"
+ ],
+ "output_token": "NextToken",
+ "result_key": "Tags"
+ },
+ "ListUsers": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "non_aggregate_keys": [
+ "ServerId"
+ ],
+ "output_token": "NextToken",
+ "result_key": "Users"
+ },
+ "ListWorkflows": {
+ "input_token": "NextToken",
+ "limit_key": "MaxResults",
+ "output_token": "NextToken",
+ "result_key": "Workflows"
}
}
}
diff --git a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json
index de90c254b0..723ce33d35 100644
--- a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json
@@ -590,10 +590,17 @@
"shape":"WorkflowStepName",
"documentation":"<p>The name of the step, used as an identifier.</p>"
},
- "DestinationFileLocation":{"shape":"InputFileLocation"},
+ "DestinationFileLocation":{
+ "shape":"InputFileLocation",
+ "documentation":"<p>Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use <code>${Transfer:username}</code> in this field to parametrize the destination prefix by username.</p>"
+ },
"OverwriteExisting":{
"shape":"OverwriteExisting",
"documentation":"<p>A flag that indicates whether or not to overwrite an existing file of the same name. The default is <code>FALSE</code>.</p>"
+ },
+ "SourceFileLocation":{
+ "shape":"SourceFileLocation",
+ "documentation":"<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>Enter <code>${previous.file}</code> to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p> </li> </ul>"
}
},
"documentation":"<p>Each step type has its own <code>StepDetails</code> structure.</p>"
@@ -616,7 +623,7 @@
},
"HomeDirectoryMappings":{
"shape":"HomeDirectoryMappings",
- "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p> </note>"
+ "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p>"
},
"Policy":{
"shape":"Policy",
@@ -689,6 +696,14 @@
"shape":"Role",
"documentation":"<p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.</p>"
},
+ "PostAuthenticationLoginBanner":{
+ "shape":"PostAuthenticationLoginBanner",
+ "documentation":"<p>Specify a string to display when users connect to a server. This string is displayed after the user authenticates.</p> <note> <p>The SFTP protocol does not support post-authentication display banners.</p> </note>"
+ },
+ "PreAuthenticationLoginBanner":{
+ "shape":"PreAuthenticationLoginBanner",
+ "documentation":"<p>Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.</p> <p> <code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code> </p>"
+ },
"Protocols":{
"shape":"Protocols",
"documentation":"<p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> </ul> <note> <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to <code>SERVICE_MANAGED</code>.</p> </note>"
@@ -739,7 +754,7 @@
},
"HomeDirectoryMappings":{
"shape":"HomeDirectoryMappings",
- "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p> </note>"
+ "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p>"
},
"Policy":{
"shape":"Policy",
@@ -834,6 +849,10 @@
"TimeoutSeconds":{
"shape":"CustomStepTimeoutSeconds",
"documentation":"<p>Timeout, in seconds, for the step.</p>"
+ },
+ "SourceFileLocation":{
+ "shape":"SourceFileLocation",
+ "documentation":"<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>Enter <code>${previous.file}</code> to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p> </li> </ul>"
}
},
"documentation":"<p>Each step type has its own <code>StepDetails</code> structure.</p>"
@@ -911,6 +930,10 @@
"Name":{
"shape":"WorkflowStepName",
"documentation":"<p>The name of the step, used as an identifier.</p>"
+ },
+ "SourceFileLocation":{
+ "shape":"SourceFileLocation",
+ "documentation":"<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>Enter <code>${previous.file}</code> to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p> </li> </ul>"
}
},
"documentation":"<p>The name of the step, used to identify the delete step.</p>"
@@ -1245,6 +1268,14 @@
"shape":"Role",
"documentation":"<p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.</p>"
},
+ "PostAuthenticationLoginBanner":{
+ "shape":"PostAuthenticationLoginBanner",
+ "documentation":"<p>Specify a string to display when users connect to a server. This string is displayed after the user authenticates.</p> <note> <p>The SFTP protocol does not support post-authentication display banners.</p> </note>"
+ },
+ "PreAuthenticationLoginBanner":{
+ "shape":"PreAuthenticationLoginBanner",
+ "documentation":"<p>Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.</p> <p> <code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code> </p>"
+ },
"Protocols":{
"shape":"Protocols",
"documentation":"<p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p> <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> </ul>"
@@ -1388,9 +1419,9 @@
},
"EfsPath":{
"type":"string",
- "max":100,
+ "max":65536,
"min":1,
- "pattern":"^(\\/|(\\/(?!\\.)+[^$#<>;`|&?{}^*/\\n]+){1,4})$"
+ "pattern":"^[^\\x00]+$"
},
"EndpointDetails":{
"type":"structure",
@@ -1435,7 +1466,7 @@
"members":{
"Type":{
"shape":"ExecutionErrorType",
- "documentation":"<p>Specifies the error type: currently, the only valid value is <code>PERMISSION_DENIED</code>, which occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.</p>"
+ "documentation":"<p>Specifies the error type.</p> <ul> <li> <p> <code>ALREADY_EXISTS</code>: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.</p> </li> <li> <p> <code>BAD_REQUEST</code>: a general bad request: for example, a step that attempts to tag an EFS file returns <code>BAD_REQUEST</code>, as only S3 files can be tagged.</p> </li> <li> <p> <code>CUSTOM_STEP_FAILED</code>: occurs when the custom step provided a callback that indicates failure.</p> </li> <li> <p> <code>INTERNAL_SERVER_ERROR</code>: a catch-all error that can occur for a variety of reasons.</p> </li> <li> <p> <code>NOT_FOUND</code>: occurs when a requested entity, for example a source file for a copy step, does not exist.</p> </li> <li> <p> <code>PERMISSION_DENIED</code>: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.</p> </li> <li> <p> <code>TIMEOUT</code>: occurs when the execution times out.</p> <note> <p> You can set the <code>TimeoutSeconds</code> for a custom step, anywhere from 1 second to 1800 seconds (30 minutes). </p> </note> </li> <li> <p> <code>THROTTLED</code>: occurs if you exceed the new execution refill rate of one workflow per second.</p> </li> </ul>"
},
"Message":{
"shape":"ExecutionErrorMessage",
@@ -1447,7 +1478,16 @@
"ExecutionErrorMessage":{"type":"string"},
"ExecutionErrorType":{
"type":"string",
- "enum":["PERMISSION_DENIED"]
+ "enum":[
+ "PERMISSION_DENIED",
+ "CUSTOM_STEP_FAILED",
+ "THROTTLED",
+ "ALREADY_EXISTS",
+ "NOT_FOUND",
+ "BAD_REQUEST",
+ "TIMEOUT",
+ "INTERNAL_SERVER_ERROR"
+ ]
},
"ExecutionId":{
"type":"string",
@@ -1550,7 +1590,7 @@
"documentation":"<p>Represents the map target that is used in a <code>HomeDirectorymapEntry</code>.</p>"
}
},
- "documentation":"<p>Represents an object that contains entries and targets for <code>HomeDirectoryMappings</code>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p> </note>"
+ "documentation":"<p>Represents an object that contains entries and targets for <code>HomeDirectoryMappings</code>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p>"
},
"HomeDirectoryMappings":{
"type":"list",
@@ -2168,6 +2208,16 @@
},
"documentation":"<p>The full POSIX identity, including user ID (<code>Uid</code>), group ID (<code>Gid</code>), and any secondary groups IDs (<code>SecondaryGids</code>), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.</p>"
},
+ "PostAuthenticationLoginBanner":{
+ "type":"string",
+ "max":512,
+ "pattern":"[\\x09-\\x0D\\x20-\\x7E]*"
+ },
+ "PreAuthenticationLoginBanner":{
+ "type":"string",
+ "max":512,
+ "pattern":"[\\x09-\\x0D\\x20-\\x7E]*"
+ },
"Protocol":{
"type":"string",
"enum":[
@@ -2429,6 +2479,11 @@
"min":3,
"pattern":"^[\\w-]*$"
},
+ "SourceFileLocation":{
+ "type":"string",
+ "max":256,
+ "pattern":"^\\$\\{(\\w+.)+\\w+\\}$"
+ },
"SourceIp":{
"type":"string",
"max":32,
@@ -2571,6 +2626,10 @@
"Tags":{
"shape":"S3Tags",
"documentation":"<p>Array that contains from 1 to 10 key/value pairs.</p>"
+ },
+ "SourceFileLocation":{
+ "shape":"SourceFileLocation",
+ "documentation":"<p>Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.</p> <ul> <li> <p>Enter <code>${previous.file}</code> to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.</p> </li> <li> <p>Enter <code>${original.file}</code> to use the originally-uploaded file location as input for this step.</p> </li> </ul>"
}
},
"documentation":"<p>Each step type has its own <code>StepDetails</code> structure.</p> <p>The key/value pairs used to tag a file during the execution of a workflow step.</p>"
@@ -2631,7 +2690,7 @@
},
"Message":{
"shape":"Message",
- "documentation":"<p>A message that indicates whether the test was successful or not.</p>"
+ "documentation":"<p>A message that indicates whether the test was successful or not.</p> <note> <p>If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.</p> </note>"
},
"Url":{
"shape":"Url",
@@ -2689,7 +2748,7 @@
},
"HomeDirectoryMappings":{
"shape":"HomeDirectoryMappings",
- "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p> </note>"
+ "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to <code>/</code> and set <code>Target</code> to the <code>HomeDirectory</code> parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p>"
},
"Policy":{
"shape":"Policy",
@@ -2759,6 +2818,14 @@
"shape":"NullableRole",
"documentation":"<p>Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.</p>"
},
+ "PostAuthenticationLoginBanner":{
+ "shape":"PostAuthenticationLoginBanner",
+ "documentation":"<p>Specify a string to display when users connect to a server. This string is displayed after the user authenticates.</p> <note> <p>The SFTP protocol does not support post-authentication display banners.</p> </note>"
+ },
+ "PreAuthenticationLoginBanner":{
+ "shape":"PreAuthenticationLoginBanner",
+ "documentation":"<p>Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.</p> <p> <code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code> </p>"
+ },
"Protocols":{
"shape":"Protocols",
"documentation":"<p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p> <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH</p> </li> <li> <p>File Transfer Protocol Secure (FTPS): File transfer with TLS encryption</p> </li> <li> <p>File Transfer Protocol (FTP): Unencrypted file transfer</p> </li> </ul> <note> <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web ServicesCertificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.</p> <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p> <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to <code>SERVICE_MANAGED</code>.</p> </note>"
@@ -2773,7 +2840,7 @@
},
"WorkflowDetails":{
"shape":"WorkflowDetails",
- "documentation":"<p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p>"
+ "documentation":"<p>Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.</p> <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p> <p> <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'</code> </p>"
}
}
},
@@ -2804,7 +2871,7 @@
},
"HomeDirectoryMappings":{
"shape":"HomeDirectoryMappings",
- "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <note> <p>If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the <code>s3api</code> or <code>efsapi</code> call instead of <code>s3</code> or <code>efs</code> so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a <code>/</code> for it to be considered a folder.</p> </note>"
+ "documentation":"<p>Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in <code>Target</code>. This value can only be set when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p> <p> <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p> <p>In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value.</p> <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p> <p> <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code> </p>"
},
"Policy":{
"shape":"Policy",
@@ -2920,7 +2987,7 @@
"members":{
"OnUpload":{
"shape":"OnUploadWorkflowDetails",
- "documentation":"<p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p>"
+ "documentation":"<p>A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.</p> <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p> <p> <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'</code> </p>"
}
},
"documentation":"<p>Container for the <code>WorkflowDetail</code> data type. It is used by actions that trigger a workflow to begin execution.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/waiters-2.json b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/waiters-2.json
new file mode 100644
index 0000000000..871dc43081
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/waiters-2.json
@@ -0,0 +1,45 @@
+{
+ "version": 2,
+ "waiters": {
+ "ServerOffline": {
+ "acceptors": [
+ {
+ "argument": "Server.State",
+ "expected": "OFFLINE",
+ "matcher": "path",
+ "state": "success"
+ },
+ {
+ "argument": "Server.State",
+ "expected": "STOP_FAILED",
+ "matcher": "path",
+ "state": "failure"
+ }
+ ],
+ "delay": 30,
+ "maxAttempts": 120,
+ "operation": "DescribeServer",
+ "type": "api"
+ },
+ "ServerOnline": {
+ "acceptors": [
+ {
+ "argument": "Server.State",
+ "expected": "ONLINE",
+ "matcher": "path",
+ "state": "success"
+ },
+ {
+ "argument": "Server.State",
+ "expected": "START_FAILED",
+ "matcher": "path",
+ "state": "failure"
+ }
+ ],
+ "delay": 30,
+ "maxAttempts": 120,
+ "operation": "DescribeServer",
+ "type": "api"
+ }
+ }
+}
diff --git a/contrib/python/botocore/py3/botocore/data/translate/2017-07-01/service-2.json b/contrib/python/botocore/py3/botocore/data/translate/2017-07-01/service-2.json
index f4ed2144df..7e2d80c5dc 100644
--- a/contrib/python/botocore/py3/botocore/data/translate/2017-07-01/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/translate/2017-07-01/service-2.json
@@ -442,6 +442,13 @@
"type":"string",
"enum":["KMS"]
},
+ "Formality":{
+ "type":"string",
+ "enum":[
+ "FORMAL",
+ "INFORMAL"
+ ]
+ },
"GetParallelDataRequest":{
"type":"structure",
"required":["Name"],
@@ -1358,6 +1365,7 @@
"TranslationSettings":{
"type":"structure",
"members":{
+ "Formality":{"shape":"Formality"},
"Profanity":{
"shape":"Profanity",
"documentation":"<p>Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.</p> <p>To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.</p> <p>Amazon Translate does not detect profanity in all of its supported languages. For languages that support profanity detection, see <a href=\"https://docs.aws.amazon.com/translate/latest/dg/what-is.html#what-is-languages\">Supported Languages and Language Codes in the Amazon Translate Developer Guide</a>.</p>"
diff --git a/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json b/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json
index 8e8841140a..28f2dd5cad 100644
--- a/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json
+++ b/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json
@@ -314,7 +314,7 @@
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFInvalidOperationException"}
],
- "documentation":"<p>Generates a presigned download URL for the specified release of the mobile SDK.</p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. </p>"
+ "documentation":"<p>Generates a presigned download URL for the specified release of the mobile SDK.</p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html\">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>"
},
"GetIPSet":{
"name":"GetIPSet",
@@ -378,7 +378,7 @@
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFInvalidOperationException"}
],
- "documentation":"<p>Retrieves information for the specified mobile SDK release, including release notes and tags.</p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. </p>"
+ "documentation":"<p>Retrieves information for the specified mobile SDK release, including release notes and tags.</p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html\">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>"
},
"GetPermissionPolicy":{
"name":"GetPermissionPolicy",
@@ -579,7 +579,7 @@
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFInvalidOperationException"}
],
- "documentation":"<p>Retrieves a list of the available releases for the mobile SDK and the specified device platform. </p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. </p>"
+ "documentation":"<p>Retrieves a list of the available releases for the mobile SDK and the specified device platform. </p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html\">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>"
},
"ListRegexPatternSets":{
"name":"ListRegexPatternSets",
@@ -678,7 +678,7 @@
{"shape":"WAFLimitsExceededException"},
{"shape":"WAFLogDestinationPermissionIssueException"}
],
- "documentation":"<p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided.</p> <p>You can access information about all traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. For information about configuring logging destinations and the permissions that are required for each, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <note> <p>This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling <a>GetLoggingConfiguration</a>, update the settings as needed, and then provide the complete logging configuration specification to this call.</p> </note>"
+ "documentation":"<p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided. </p> <note> <p>You can define one logging destination per web ACL.</p> </note> <p>You can access information about the traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. For information about configuring logging destinations and the permissions that are required for each, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <p>For additional information about web ACL logging, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p> <note> <p>This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling <a>GetLoggingConfiguration</a>, update the settings as needed, and then provide the complete logging configuration specification to this call.</p> </note>"
},
"PutManagedRuleSetVersions":{
"name":"PutManagedRuleSetVersions",
@@ -1380,7 +1380,7 @@
},
"Addresses":{
"shape":"IPAddresses",
- "documentation":"<p>Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. </p> <p>Examples: </p> <ul> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
+ "documentation":"<p>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. </p> <p>Example address strings: </p> <ul> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>Example JSON <code>Addresses</code> specifications: </p> <ul> <li> <p>Empty array: <code>\"Addresses\": []</code> </p> </li> <li> <p>Array with one address: <code>\"Addresses\": [\"192.0.2.44/32\"]</code> </p> </li> <li> <p>Array with three addresses: <code>\"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]</code> </p> </li> <li> <p>INVALID specification: <code>\"Addresses\": [\"\"]</code> INVALID </p> </li> </ul>"
},
"Tags":{
"shape":"TagList",
@@ -2520,7 +2520,7 @@
},
"ApplicationIntegrationURL":{
"shape":"OutputUrl",
- "documentation":"<p>The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group <code>AWSManagedRulesATPRuleSet</code>. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html\">WAF application integration</a> in the <i>WAF Developer Guide</i>.</p>"
+ "documentation":"<p>The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group <code>AWSManagedRulesATPRuleSet</code>. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html\">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>"
}
}
},
@@ -2625,10 +2625,10 @@
},
"Addresses":{
"shape":"IPAddresses",
- "documentation":"<p>Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. </p> <p>Examples: </p> <ul> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
+ "documentation":"<p>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. </p> <p>Example address strings: </p> <ul> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>Example JSON <code>Addresses</code> specifications: </p> <ul> <li> <p>Empty array: <code>\"Addresses\": []</code> </p> </li> <li> <p>Array with one address: <code>\"Addresses\": [\"192.0.2.44/32\"]</code> </p> </li> <li> <p>Array with three addresses: <code>\"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]</code> </p> </li> <li> <p>INVALID specification: <code>\"Addresses\": [\"\"]</code> INVALID </p> </li> </ul>"
}
},
- "documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p> <p>WAF assigns an ARN to each <code>IPSet</code> that you create. To use an IP set in a rule, you provide the ARN to the <a>Rule</a> statement <a>IPSetReferenceStatement</a>. </p>"
+ "documentation":"<p>Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p> <p>WAF assigns an ARN to each <code>IPSet</code> that you create. To use an IP set in a rule, you provide the ARN to the <a>Rule</a> statement <a>IPSetReferenceStatement</a>. </p>"
},
"IPSetForwardedIPConfig":{
"type":"structure",
@@ -3217,7 +3217,7 @@
},
"LogDestinationConfigs":{
"shape":"LogDestinationConfigs",
- "documentation":"<p>The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.</p>"
+ "documentation":"<p>The logging destination configuration that you want to associate with the web ACL.</p> <note> <p>You can associate one logging destination to a web ACL.</p> </note>"
},
"RedactedFields":{
"shape":"RedactedFields",
@@ -3232,7 +3232,7 @@
"documentation":"<p>Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. </p>"
}
},
- "documentation":"<p>Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records. </p> <p>For information about configuring web ACL logging destinations, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p>"
+ "documentation":"<p>Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records. </p> <note> <p>You can define one logging destination per web ACL.</p> </note> <p>You can access information about the traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. For information about configuring logging destinations and the permissions that are required for each, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <p>For additional information about web ACL logging, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p>"
},
"LoggingConfigurations":{
"type":"list",
@@ -3267,7 +3267,7 @@
"members":{
"LoginPath":{
"shape":"LoginPathString",
- "documentation":"<p>The login endpoint for your application. For example <code>https://example.com/web/login</code>.</p>"
+ "documentation":"<p>The path of the login endpoint for your application. For example, for the URL <code>https://example.com/web/login</code>, you would provide the path <code>/web/login</code>.</p>"
},
"PayloadType":{
"shape":"PayloadType",
@@ -3498,7 +3498,7 @@
"documentation":"<p>Tags that are associated with the release. </p>"
}
},
- "documentation":"<p>Information for a release of the mobile SDK, including release notes and tags.</p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. </p>"
+ "documentation":"<p>Information for a release of the mobile SDK, including release notes and tags.</p> <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html\">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>"
},
"NextMarker":{
"type":"string",
@@ -4604,7 +4604,7 @@
},
"Addresses":{
"shape":"IPAddresses",
- "documentation":"<p>Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. </p> <p>Examples: </p> <ul> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p>"
+ "documentation":"<p>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. </p> <p>Example address strings: </p> <ul> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</p> </li> <li> <p>To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</p> </li> </ul> <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>Example JSON <code>Addresses</code> specifications: </p> <ul> <li> <p>Empty array: <code>\"Addresses\": []</code> </p> </li> <li> <p>Array with one address: <code>\"Addresses\": [\"192.0.2.44/32\"]</code> </p> </li> <li> <p>Array with three addresses: <code>\"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]</code> </p> </li> <li> <p>INVALID specification: <code>\"Addresses\": [\"\"]</code> INVALID </p> </li> </ul>"
},
"LockToken":{
"shape":"LockToken",
diff --git a/contrib/python/botocore/py3/botocore/discovery.py b/contrib/python/botocore/py3/botocore/discovery.py
index 68ee6bea68..33b412304e 100644
--- a/contrib/python/botocore/py3/botocore/discovery.py
+++ b/contrib/python/botocore/py3/botocore/discovery.py
@@ -10,12 +10,12 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-import time
import logging
+import time
import weakref
from botocore import xform_name
-from botocore.exceptions import BotoCoreError, HTTPClientError, ConnectionError
+from botocore.exceptions import BotoCoreError, ConnectionError, HTTPClientError
from botocore.model import OperationNotFoundError
from botocore.utils import CachedProperty
diff --git a/contrib/python/botocore/py3/botocore/docs/client.py b/contrib/python/botocore/py3/botocore/docs/client.py
index 1ed8e76cea..812f73d30c 100644
--- a/contrib/python/botocore/py3/botocore/docs/client.py
+++ b/contrib/python/botocore/py3/botocore/docs/client.py
@@ -10,15 +10,16 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-from botocore.docs.utils import get_official_service_name
-from botocore.docs.method import document_custom_method
-from botocore.docs.method import document_model_driven_method
-from botocore.docs.method import get_instance_public_methods
-from botocore.docs.sharedexample import document_shared_examples
+from botocore.compat import OrderedDict
from botocore.docs.example import ResponseExampleDocumenter
+from botocore.docs.method import (
+ document_custom_method,
+ document_model_driven_method,
+ get_instance_public_methods,
+)
from botocore.docs.params import ResponseParamsDocumenter
-from botocore.docs.utils import DocumentedShape
-from botocore.compat import OrderedDict
+from botocore.docs.sharedexample import document_shared_examples
+from botocore.docs.utils import DocumentedShape, get_official_service_name
def _allowlist_generate_presigned_url(method_name, service_name, **kwargs):
diff --git a/contrib/python/botocore/py3/botocore/docs/docstring.py b/contrib/python/botocore/py3/botocore/docs/docstring.py
index 33c68932e2..e0725fc452 100644
--- a/contrib/python/botocore/py3/botocore/docs/docstring.py
+++ b/contrib/python/botocore/py3/botocore/docs/docstring.py
@@ -10,10 +10,10 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
+from botocore.docs.bcdoc.restdoc import DocumentStructure
from botocore.docs.method import document_model_driven_method
-from botocore.docs.waiter import document_wait_method
from botocore.docs.paginator import document_paginate_method
-from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.waiter import document_wait_method
class LazyLoadedDocstring(str):
diff --git a/contrib/python/botocore/py3/botocore/docs/method.py b/contrib/python/botocore/py3/botocore/docs/method.py
index a314745285..93dc23baf5 100644
--- a/contrib/python/botocore/py3/botocore/docs/method.py
+++ b/contrib/python/botocore/py3/botocore/docs/method.py
@@ -12,11 +12,14 @@
# language governing permissions and limitations under the License.
import inspect
-from botocore.docs.params import RequestParamsDocumenter
-from botocore.docs.params import ResponseParamsDocumenter
-from botocore.docs.example import ResponseExampleDocumenter
-from botocore.docs.example import RequestExampleDocumenter
-
+from botocore.docs.example import (
+ RequestExampleDocumenter,
+ ResponseExampleDocumenter,
+)
+from botocore.docs.params import (
+ RequestParamsDocumenter,
+ ResponseParamsDocumenter,
+)
AWS_DOC_BASE = 'https://docs.aws.amazon.com/goto/WebAPI'
diff --git a/contrib/python/botocore/py3/botocore/docs/paginator.py b/contrib/python/botocore/py3/botocore/docs/paginator.py
index 03c17d6309..0a0b7b7189 100644
--- a/contrib/python/botocore/py3/botocore/docs/paginator.py
+++ b/contrib/python/botocore/py3/botocore/docs/paginator.py
@@ -12,9 +12,9 @@
# language governing permissions and limitations under the License.
from botocore import xform_name
from botocore.compat import OrderedDict
+from botocore.docs.method import document_model_driven_method
from botocore.docs.utils import DocumentedShape
from botocore.utils import get_service_module_name
-from botocore.docs.method import document_model_driven_method
class PaginatorDocumenter(object):
diff --git a/contrib/python/botocore/py3/botocore/docs/service.py b/contrib/python/botocore/py3/botocore/docs/service.py
index bfa343abcc..2f12520756 100644
--- a/contrib/python/botocore/py3/botocore/docs/service.py
+++ b/contrib/python/botocore/py3/botocore/docs/service.py
@@ -10,12 +10,11 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-from botocore.exceptions import DataNotFoundError
-from botocore.docs.client import ClientDocumenter
-from botocore.docs.client import ClientExceptionsDocumenter
-from botocore.docs.waiter import WaiterDocumenter
-from botocore.docs.paginator import PaginatorDocumenter
from botocore.docs.bcdoc.restdoc import DocumentStructure
+from botocore.docs.client import ClientDocumenter, ClientExceptionsDocumenter
+from botocore.docs.paginator import PaginatorDocumenter
+from botocore.docs.waiter import WaiterDocumenter
+from botocore.exceptions import DataNotFoundError
class ServiceDocumenter(object):
diff --git a/contrib/python/botocore/py3/botocore/docs/sharedexample.py b/contrib/python/botocore/py3/botocore/docs/sharedexample.py
index 1a31b6e481..39cdd41fa8 100644
--- a/contrib/python/botocore/py3/botocore/docs/sharedexample.py
+++ b/contrib/python/botocore/py3/botocore/docs/sharedexample.py
@@ -10,11 +10,12 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-import re
import numbers
-from botocore.utils import parse_timestamp
-from botocore.docs.utils import escape_controls
+import re
+
from botocore.compat import six
+from botocore.docs.utils import escape_controls
+from botocore.utils import parse_timestamp
class SharedExampleDocumenter(object):
diff --git a/contrib/python/botocore/py3/botocore/docs/waiter.py b/contrib/python/botocore/py3/botocore/docs/waiter.py
index a38049c2de..4aaca10bee 100644
--- a/contrib/python/botocore/py3/botocore/docs/waiter.py
+++ b/contrib/python/botocore/py3/botocore/docs/waiter.py
@@ -12,9 +12,9 @@
# language governing permissions and limitations under the License.
from botocore import xform_name
from botocore.compat import OrderedDict
+from botocore.docs.method import document_model_driven_method
from botocore.docs.utils import DocumentedShape
from botocore.utils import get_service_module_name
-from botocore.docs.method import document_model_driven_method
class WaiterDocumenter(object):
diff --git a/contrib/python/botocore/py3/botocore/endpoint.py b/contrib/python/botocore/py3/botocore/endpoint.py
index feaeb14ac6..790d228d38 100644
--- a/contrib/python/botocore/py3/botocore/endpoint.py
+++ b/contrib/python/botocore/py3/botocore/endpoint.py
@@ -13,25 +13,26 @@
# language governing permissions and limitations under the License.
import datetime
-import os
import logging
-import time
+import os
import threading
+import time
import uuid
-from botocore.compat import six
-
+from botocore import parsers
from botocore.awsrequest import create_request_object
from botocore.exceptions import HTTPClientError
+from botocore.history import get_global_history_recorder
+from botocore.hooks import first_non_none_response
+from botocore.httpchecksum import handle_checksum_body
from botocore.httpsession import URLLib3Session
+from botocore.response import StreamingBody
from botocore.utils import (
- is_valid_endpoint_url, is_valid_ipv6_endpoint_url, get_environ_proxies
+ get_environ_proxies,
+ is_valid_endpoint_url,
+ is_valid_ipv6_endpoint_url,
)
-from botocore.hooks import first_non_none_response
-from botocore.history import get_global_history_recorder
-from botocore.response import StreamingBody
-from botocore import parsers
-
+from botocore.compat import six
logger = logging.getLogger(__name__)
history_recorder = get_global_history_recorder()
@@ -212,7 +213,7 @@ class Endpoint(object):
# If an exception occurs then the success_response is None.
# If no exception occurs then exception is None.
success_response, exception = self._do_get_response(
- request, operation_model)
+ request, operation_model, context)
kwargs_to_emit = {
'response_dict': None,
'parsed_response': None,
@@ -230,7 +231,7 @@ class Endpoint(object):
service_id, operation_model.name), **kwargs_to_emit)
return success_response, exception
- def _do_get_response(self, request, operation_model):
+ def _do_get_response(self, request, operation_model, context):
try:
logger.debug("Sending http request: %s", request)
history_recorder.record('HTTP_REQUEST', {
@@ -254,6 +255,9 @@ class Endpoint(object):
return (None, e)
# This returns the http_response and the parsed_data.
response_dict = convert_to_response_dict(http_response, operation_model)
+ handle_checksum_body(
+ http_response, response_dict, context, operation_model,
+ )
http_response_record_dict = response_dict.copy()
http_response_record_dict['streaming'] = \
diff --git a/contrib/python/botocore/py3/botocore/eventstream.py b/contrib/python/botocore/py3/botocore/eventstream.py
index c41435643d..89eb5874a6 100644
--- a/contrib/python/botocore/py3/botocore/eventstream.py
+++ b/contrib/python/botocore/py3/botocore/eventstream.py
@@ -14,6 +14,7 @@
from binascii import crc32
from struct import unpack
+
from botocore.exceptions import EventStreamError
# byte length of the prelude (total_length + header_length + prelude_crc)
diff --git a/contrib/python/botocore/py3/botocore/exceptions.py b/contrib/python/botocore/py3/botocore/exceptions.py
index 32f568fabf..41be30146d 100644
--- a/contrib/python/botocore/py3/botocore/exceptions.py
+++ b/contrib/python/botocore/py3/botocore/exceptions.py
@@ -12,6 +12,7 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from __future__ import unicode_literals
+
from botocore.vendored import requests
from botocore.vendored.requests.packages import urllib3
@@ -709,3 +710,11 @@ class InvalidDefaultsMode(BotoCoreError):
'Client configured with invalid defaults mode: {mode}. '
'Valid defaults modes include: {valid_modes}.'
)
+
+
+class AwsChunkedWrapperError(BotoCoreError):
+ fmt = '{error_msg}'
+
+
+class FlexibleChecksumError(BotoCoreError):
+ fmt = '{error_msg}'
diff --git a/contrib/python/botocore/py3/botocore/handlers.py b/contrib/python/botocore/py3/botocore/handlers.py
index 7fb83f1dbe..a40973d8d8 100644
--- a/contrib/python/botocore/py3/botocore/handlers.py
+++ b/contrib/python/botocore/py3/botocore/handlers.py
@@ -16,36 +16,53 @@
This module contains builtin handlers for events emitted by botocore.
"""
-import os
import base64
-import logging
import copy
+import logging
+import os
import re
-import warnings
import uuid
+import warnings
-from botocore.compat import (
- unquote, json, six, unquote_str, ensure_bytes, get_md5,
- OrderedDict, urlsplit, urlunsplit, XMLParseError,
- ETree, quote,
-)
-from botocore.docs.utils import AutoPopulatedParam
-from botocore.docs.utils import HideParamFromOperations
-from botocore.docs.utils import AppendParamDocumentation
-from botocore.signers import add_generate_presigned_url
-from botocore.signers import add_generate_presigned_post
-from botocore.signers import add_generate_db_auth_token
-from botocore.exceptions import ParamValidationError
-from botocore.exceptions import AliasConflictParameterError
-from botocore.exceptions import UnsupportedTLSVersionWarning
-from botocore.utils import percent_encode, SAFE_CHARS
-from botocore.utils import switch_host_with_param
-from botocore.utils import conditionally_calculate_md5
-from botocore.utils import is_global_accesspoint
-
-from botocore import utils
import botocore
import botocore.auth
+from botocore import utils
+from botocore.compat import (
+ ETree,
+ OrderedDict,
+ XMLParseError,
+ ensure_bytes,
+ get_md5,
+ json,
+ quote,
+ six,
+ unquote,
+ unquote_str,
+ urlsplit,
+ urlunsplit,
+)
+from botocore.docs.utils import (
+ AppendParamDocumentation,
+ AutoPopulatedParam,
+ HideParamFromOperations,
+)
+from botocore.exceptions import (
+ AliasConflictParameterError,
+ ParamValidationError,
+ UnsupportedTLSVersionWarning,
+)
+from botocore.signers import (
+ add_generate_db_auth_token,
+ add_generate_presigned_post,
+ add_generate_presigned_url,
+)
+from botocore.utils import (
+ SAFE_CHARS,
+ conditionally_calculate_md5,
+ is_global_accesspoint,
+ percent_encode,
+ switch_host_with_param,
+)
# Keep these imported. There's pre-existing code that uses them.
from botocore import retryhandler # noqa
@@ -102,22 +119,12 @@ def escape_xml_payload(params, **kwargs):
# this operation \r and \n can only appear in the XML document if they were
# passed as part of the customer input.
body = params['body']
- replaced = False
if b'\r' in body:
- replaced = True
body = body.replace(b'\r', b'&#xD;')
if b'\n' in body:
- replaced = True
body = body.replace(b'\n', b'&#xA;')
- if not replaced:
- return
-
params['body'] = body
- if 'Content-MD5' in params['headers']:
- # The Content-MD5 is now wrong, so we'll need to recalculate it
- del params['headers']['Content-MD5']
- conditionally_calculate_md5(params, **kwargs)
def check_for_200_error(response, **kwargs):
diff --git a/contrib/python/botocore/py3/botocore/history.py b/contrib/python/botocore/py3/botocore/history.py
index f4c72dbe46..080b381cbb 100644
--- a/contrib/python/botocore/py3/botocore/history.py
+++ b/contrib/python/botocore/py3/botocore/history.py
@@ -12,7 +12,6 @@
# language governing permissions and limitations under the License.
import logging
-
HISTORY_RECORDER = None
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/hooks.py b/contrib/python/botocore/py3/botocore/hooks.py
index 1776199f80..5f88eccbae 100644
--- a/contrib/python/botocore/py3/botocore/hooks.py
+++ b/contrib/python/botocore/py3/botocore/hooks.py
@@ -13,6 +13,7 @@
import copy
import logging
from collections import deque, namedtuple
+
from botocore.compat import accepts_kwargs, six
from botocore.utils import EVENT_ALIASES
diff --git a/contrib/python/botocore/py3/botocore/httpchecksum.py b/contrib/python/botocore/py3/botocore/httpchecksum.py
new file mode 100644
index 0000000000..3c7970e1b2
--- /dev/null
+++ b/contrib/python/botocore/py3/botocore/httpchecksum.py
@@ -0,0 +1,453 @@
+# Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+""" The interfaces in this module are not intended for public use.
+
+This module defines interfaces for applying checksums to HTTP requests within
+the context of botocore. This involves both resolving the checksum to be used
+based on client configuration and environment, as well as application of the
+checksum to the request.
+"""
+import base64
+import io
+import logging
+from binascii import crc32
+from hashlib import sha1, sha256
+
+from botocore.compat import HAS_CRT
+from botocore.exceptions import AwsChunkedWrapperError, FlexibleChecksumError
+from botocore.response import StreamingBody
+from botocore.utils import (
+ conditionally_calculate_md5,
+ determine_content_length,
+)
+
+if HAS_CRT:
+ from awscrt import checksums as crt_checksums
+else:
+ crt_checksums = None
+
+logger = logging.getLogger(__name__)
+
+
+class BaseChecksum:
+ _CHUNK_SIZE = 1024 * 1024
+
+ def update(self, chunk):
+ pass
+
+ def digest(self):
+ pass
+
+ def b64digest(self):
+ bs = self.digest()
+ return base64.b64encode(bs).decode("ascii")
+
+ def _handle_fileobj(self, fileobj):
+ start_position = fileobj.tell()
+ for chunk in iter(lambda: fileobj.read(self._CHUNK_SIZE), b""):
+ self.update(chunk)
+ fileobj.seek(start_position)
+
+ def handle(self, body):
+ if isinstance(body, (bytes, bytearray)):
+ self.update(body)
+ else:
+ self._handle_fileobj(body)
+ return self.b64digest()
+
+
+class Crc32Checksum(BaseChecksum):
+ def __init__(self):
+ self._int_crc32 = 0
+
+ def update(self, chunk):
+ self._int_crc32 = crc32(chunk, self._int_crc32) & 0xFFFFFFFF
+
+ def digest(self):
+ return self._int_crc32.to_bytes(4, byteorder="big")
+
+
+class CrtCrc32Checksum(BaseChecksum):
+ # Note: This class is only used if the CRT is available
+ def __init__(self):
+ self._int_crc32 = 0
+
+ def update(self, chunk):
+ new_checksum = crt_checksums.crc32(chunk, self._int_crc32)
+ self._int_crc32 = new_checksum & 0xFFFFFFFF
+
+ def digest(self):
+ return self._int_crc32.to_bytes(4, byteorder="big")
+
+
+class CrtCrc32cChecksum(BaseChecksum):
+ # Note: This class is only used if the CRT is available
+ def __init__(self):
+ self._int_crc32c = 0
+
+ def update(self, chunk):
+ new_checksum = crt_checksums.crc32c(chunk, self._int_crc32c)
+ self._int_crc32c = new_checksum & 0xFFFFFFFF
+
+ def digest(self):
+ return self._int_crc32c.to_bytes(4, byteorder="big")
+
+
+class Sha1Checksum(BaseChecksum):
+ def __init__(self):
+ self._checksum = sha1()
+
+ def update(self, chunk):
+ self._checksum.update(chunk)
+
+ def digest(self):
+ return self._checksum.digest()
+
+
+class Sha256Checksum(BaseChecksum):
+ def __init__(self):
+ self._checksum = sha256()
+
+ def update(self, chunk):
+ self._checksum.update(chunk)
+
+ def digest(self):
+ return self._checksum.digest()
+
+
+class AwsChunkedWrapper:
+ _DEFAULT_CHUNK_SIZE = 1024 * 1024
+
+ def __init__(
+ self,
+ raw,
+ checksum_cls=None,
+ checksum_name="x-amz-checksum",
+ chunk_size=None,
+ ):
+ self._raw = raw
+ self._checksum_name = checksum_name
+ self._checksum_cls = checksum_cls
+ self._reset()
+
+ if chunk_size is None:
+ chunk_size = self._DEFAULT_CHUNK_SIZE
+ self._chunk_size = chunk_size
+
+ def _reset(self):
+ self._remaining = b""
+ self._complete = False
+ self._checksum = None
+ if self._checksum_cls:
+ self._checksum = self._checksum_cls()
+
+ def seek(self, offset, whence=0):
+ if offset != 0 or whence != 0:
+ raise AwsChunkedWrapperError(
+ error_msg="Can only seek to start of stream"
+ )
+ self._reset()
+ self._raw.seek(0)
+
+ def read(self, size=None):
+ # Normalize "read all" size values to None
+ if size is not None and size <= 0:
+ size = None
+
+ # If the underlying body is done and we have nothing left then
+ # end the stream
+ if self._complete and not self._remaining:
+ return b""
+
+ # While we're not done and want more bytes
+ want_more_bytes = size is None or size > len(self._remaining)
+ while not self._complete and want_more_bytes:
+ self._remaining += self._make_chunk()
+ want_more_bytes = size is None or size > len(self._remaining)
+
+ # If size was None, we want to return everything
+ if size is None:
+ size = len(self._remaining)
+
+ # Return a chunk up to the size asked for
+ to_return = self._remaining[:size]
+ self._remaining = self._remaining[size:]
+ return to_return
+
+ def _make_chunk(self):
+ # NOTE: Chunk size is not deterministic as read could return less. This
+ # means we cannot know the content length of the encoded aws-chunked
+ # stream ahead of time without ensuring a consistent chunk size
+ raw_chunk = self._raw.read(self._chunk_size)
+ hex_len = hex(len(raw_chunk))[2:].encode("ascii")
+ self._complete = not raw_chunk
+
+ if self._checksum:
+ self._checksum.update(raw_chunk)
+
+ if self._checksum and self._complete:
+ name = self._checksum_name.encode("ascii")
+ checksum = self._checksum.b64digest().encode("ascii")
+ return b"0\r\n%s:%s\r\n\r\n" % (name, checksum)
+
+ return b"%s\r\n%s\r\n" % (hex_len, raw_chunk)
+
+ def __iter__(self):
+ while not self._complete:
+ yield self._make_chunk()
+
+
+class StreamingChecksumBody(StreamingBody):
+ def __init__(self, raw_stream, content_length, checksum, expected):
+ super().__init__(raw_stream, content_length)
+ self._checksum = checksum
+ self._expected = expected
+
+ def read(self, amt=None):
+ chunk = super(StreamingChecksumBody, self).read(amt=amt)
+ self._checksum.update(chunk)
+ if amt is None or (not chunk and amt > 0):
+ self._validate_checksum()
+ return chunk
+
+ def _validate_checksum(self):
+ if self._checksum.digest() != base64.b64decode(self._expected):
+ error_msg = (
+ "Expected checksum %s did not match calculated checksum: %s"
+ % (self._expected, self._checksum.b64digest(),)
+ )
+ raise FlexibleChecksumError(error_msg=error_msg)
+
+
+def resolve_checksum_context(request, operation_model, params):
+ resolve_request_checksum_algorithm(request, operation_model, params)
+ resolve_response_checksum_algorithms(request, operation_model, params)
+
+
+def resolve_request_checksum_algorithm(
+ request, operation_model, params, supported_algorithms=None,
+):
+ http_checksum = operation_model.http_checksum
+ algorithm_member = http_checksum.get("requestAlgorithmMember")
+ if algorithm_member and algorithm_member in params:
+ # If the client has opted into using flexible checksums and the
+ # request supports it, use that instead of checksum required
+ if supported_algorithms is None:
+ supported_algorithms = _SUPPORTED_CHECKSUM_ALGORITHMS
+
+ algorithm_name = params[algorithm_member].lower()
+ if algorithm_name not in supported_algorithms:
+ raise FlexibleChecksumError(
+ error_msg="Unsupported checksum algorithm: %s" % algorithm_name
+ )
+
+ location_type = "header"
+ if operation_model.has_streaming_input:
+ # Operations with streaming input must support trailers.
+ if request["url"].startswith("https:"):
+ # We only support unsigned trailer checksums currently. As this
+ # disables payload signing we'll only use trailers over TLS.
+ location_type = "trailer"
+
+ algorithm = {
+ "algorithm": algorithm_name,
+ "in": location_type,
+ "name": "x-amz-checksum-%s" % algorithm_name,
+ }
+
+ if algorithm["name"] in request["headers"]:
+ # If the header is already set by the customer, skip calculation
+ return
+
+ checksum_context = request["context"].get("checksum", {})
+ checksum_context["request_algorithm"] = algorithm
+ request["context"]["checksum"] = checksum_context
+ elif operation_model.http_checksum_required or http_checksum.get(
+ "requestChecksumRequired"
+ ):
+ # Otherwise apply the old http checksum behavior via Content-MD5
+ checksum_context = request["context"].get("checksum", {})
+ checksum_context["request_algorithm"] = "conditional-md5"
+ request["context"]["checksum"] = checksum_context
+
+
+def apply_request_checksum(request):
+ checksum_context = request.get("context", {}).get("checksum", {})
+ algorithm = checksum_context.get("request_algorithm")
+
+ if not algorithm:
+ return
+
+ if algorithm == "conditional-md5":
+ # Special case to handle the http checksum required trait
+ conditionally_calculate_md5(request)
+ elif algorithm["in"] == "header":
+ _apply_request_header_checksum(request)
+ elif algorithm["in"] == "trailer":
+ _apply_request_trailer_checksum(request)
+ else:
+ raise FlexibleChecksumError(
+ error_msg="Unknown checksum variant: %s" % algorithm["in"]
+ )
+
+
+def _apply_request_header_checksum(request):
+ checksum_context = request.get("context", {}).get("checksum", {})
+ algorithm = checksum_context.get("request_algorithm")
+ location_name = algorithm["name"]
+ if location_name in request["headers"]:
+ # If the header is already set by the customer, skip calculation
+ return
+ checksum_cls = _CHECKSUM_CLS.get(algorithm["algorithm"])
+ digest = checksum_cls().handle(request["body"])
+ request["headers"][location_name] = digest
+
+
+def _apply_request_trailer_checksum(request):
+ checksum_context = request.get("context", {}).get("checksum", {})
+ algorithm = checksum_context.get("request_algorithm")
+ location_name = algorithm["name"]
+ checksum_cls = _CHECKSUM_CLS.get(algorithm["algorithm"])
+
+ headers = request["headers"]
+ body = request["body"]
+
+ if location_name in headers:
+ # If the header is already set by the customer, skip calculation
+ return
+
+ headers["Transfer-Encoding"] = "chunked"
+ headers["Content-Encoding"] = "aws-chunked"
+ headers["X-Amz-Trailer"] = location_name
+
+ content_length = determine_content_length(body)
+ if content_length is not None:
+ # Send the decoded content length if we can determine it. Some
+ # services such as S3 may require the decoded content length
+ headers["X-Amz-Decoded-Content-Length"] = str(content_length)
+
+ if isinstance(body, (bytes, bytearray)):
+ body = io.BytesIO(body)
+
+ request["body"] = AwsChunkedWrapper(
+ body, checksum_cls=checksum_cls, checksum_name=location_name,
+ )
+
+
+def resolve_response_checksum_algorithms(
+ request, operation_model, params, supported_algorithms=None
+):
+ http_checksum = operation_model.http_checksum
+ mode_member = http_checksum.get("requestValidationModeMember")
+ if mode_member and mode_member in params:
+ if supported_algorithms is None:
+ supported_algorithms = _SUPPORTED_CHECKSUM_ALGORITHMS
+ response_algorithms = set(
+ a.lower() for a in http_checksum.get("responseAlgorithms", [])
+ )
+
+ usable_algorithms = []
+ for algorithm in _ALGORITHMS_PRIORITY_LIST:
+ if algorithm not in response_algorithms:
+ continue
+ if algorithm in supported_algorithms:
+ usable_algorithms.append(algorithm)
+
+ checksum_context = request["context"].get("checksum", {})
+ checksum_context["response_algorithms"] = usable_algorithms
+ request["context"]["checksum"] = checksum_context
+
+
+def handle_checksum_body(http_response, response, context, operation_model):
+ headers = response["headers"]
+ checksum_context = context.get("checksum", {})
+ algorithms = checksum_context.get("response_algorithms")
+
+ if not algorithms:
+ return
+
+ for algorithm in algorithms:
+ header_name = "x-amz-checksum-%s" % algorithm
+ # If the header is not found, check the next algorithm
+ if header_name not in headers:
+ continue
+
+ # If a - is in the checksum this is not valid Base64. S3 returns
+ # checksums that include a -# suffix to indicate a checksum derived
+ # from the hash of all part checksums. We cannot wrap this response
+ if "-" in headers[header_name]:
+ continue
+
+ if operation_model.has_streaming_output:
+ response["body"] = _handle_streaming_response(
+ http_response, response, algorithm
+ )
+ else:
+ response["body"] = _handle_bytes_response(
+ http_response, response, algorithm
+ )
+
+ # Expose metadata that the checksum check actually occured
+ checksum_context = response["context"].get("checksum", {})
+ checksum_context["response_algorithm"] = algorithm
+ response["context"]["checksum"] = checksum_context
+ return
+
+ logger.info(
+ f'Skipping checksum validation. Response did not contain one of the '
+ f'following algorithms: {algorithms}.'
+ )
+
+
+def _handle_streaming_response(http_response, response, algorithm):
+ checksum_cls = _CHECKSUM_CLS.get(algorithm)
+ header_name = "x-amz-checksum-%s" % algorithm
+ return StreamingChecksumBody(
+ http_response.raw,
+ response["headers"].get("content-length"),
+ checksum_cls(),
+ response["headers"][header_name],
+ )
+
+
+def _handle_bytes_response(http_response, response, algorithm):
+ body = http_response.content
+ header_name = "x-amz-checksum-%s" % algorithm
+ checksum_cls = _CHECKSUM_CLS.get(algorithm)
+ checksum = checksum_cls()
+ checksum.update(body)
+ expected = response["headers"][header_name]
+ if checksum.digest() != base64.b64decode(expected):
+ error_msg = (
+ "Expected checksum %s did not match calculated checksum: %s"
+ % (expected, checksum.b64digest(),)
+ )
+ raise FlexibleChecksumError(error_msg=error_msg)
+ return body
+
+
+_CHECKSUM_CLS = {
+ "crc32": Crc32Checksum,
+ "sha1": Sha1Checksum,
+ "sha256": Sha256Checksum,
+}
+
+if HAS_CRT:
+ # Use CRT checksum implementations if available
+ _CHECKSUM_CLS.update(
+ {"crc32": CrtCrc32Checksum, "crc32c": CrtCrc32cChecksum}
+ )
+
+_SUPPORTED_CHECKSUM_ALGORITHMS = list(_CHECKSUM_CLS.keys())
+_ALGORITHMS_PRIORITY_LIST = ['crc32c', 'crc32', 'sha1', 'sha256']
diff --git a/contrib/python/botocore/py3/botocore/httpsession.py b/contrib/python/botocore/py3/botocore/httpsession.py
index 278adc15d9..caa327ed96 100644
--- a/contrib/python/botocore/py3/botocore/httpsession.py
+++ b/contrib/python/botocore/py3/botocore/httpsession.py
@@ -1,27 +1,33 @@
-import os.path
-import os
import logging
+import os
+import os.path
import socket
-from base64 import b64encode
import sys
+from base64 import b64encode
-from urllib3 import PoolManager, proxy_from_url, Timeout
+from urllib3 import PoolManager, Timeout, proxy_from_url
+from urllib3.exceptions import (
+ ConnectTimeoutError as URLLib3ConnectTimeoutError,
+)
+from urllib3.exceptions import NewConnectionError, ProtocolError, ProxyError
+from urllib3.exceptions import ReadTimeoutError as URLLib3ReadTimeoutError
+from urllib3.exceptions import SSLError as URLLib3SSLError
from urllib3.util.retry import Retry
from urllib3.util.ssl_ import (
- ssl, OP_NO_SSLv2, OP_NO_SSLv3, OP_NO_COMPRESSION,
- PROTOCOL_TLS, DEFAULT_CIPHERS,
+ DEFAULT_CIPHERS,
+ OP_NO_COMPRESSION,
+ PROTOCOL_TLS,
+ OP_NO_SSLv2,
+ OP_NO_SSLv3,
+ ssl,
)
-from urllib3.exceptions import SSLError as URLLib3SSLError
-from urllib3.exceptions import ReadTimeoutError as URLLib3ReadTimeoutError
-from urllib3.exceptions import ConnectTimeoutError as URLLib3ConnectTimeoutError
-from urllib3.exceptions import NewConnectionError, ProtocolError, ProxyError
try:
- from urllib3.util.ssl_ import PROTOCOL_TLS_CLIENT, OP_NO_TICKET
+ from urllib3.util.ssl_ import OP_NO_TICKET, PROTOCOL_TLS_CLIENT
except ImportError:
# Fallback directly to ssl for version of urllib3 before 1.26.
# They are available in the standard library starting in Python 3.6.
- from ssl import PROTOCOL_TLS_CLIENT, OP_NO_TICKET
+ from ssl import OP_NO_TICKET, PROTOCOL_TLS_CLIENT
try:
# Always import the original SSLContext, even if it has been patched
@@ -30,13 +36,18 @@ except ImportError:
from urllib3.util.ssl_ import SSLContext
import botocore.awsrequest
-from six.moves.urllib_parse import unquote
-from botocore.compat import filter_ssl_warnings, urlparse
+from botocore.compat import ensure_bytes, filter_ssl_warnings, urlparse
from botocore.exceptions import (
- ConnectionClosedError, EndpointConnectionError, HTTPClientError,
- ReadTimeoutError, ProxyConnectionError, ConnectTimeoutError, SSLError,
- InvalidProxiesConfigError
+ ConnectionClosedError,
+ ConnectTimeoutError,
+ EndpointConnectionError,
+ HTTPClientError,
+ InvalidProxiesConfigError,
+ ProxyConnectionError,
+ ReadTimeoutError,
+ SSLError,
)
+from six.moves.urllib_parse import unquote
filter_ssl_warnings()
logger = logging.getLogger(__name__)
@@ -381,7 +392,9 @@ class URLLib3Session(object):
return self._path_url(url)
def _chunked(self, headers):
- return headers.get('Transfer-Encoding', '') == 'chunked'
+ transfer_encoding = headers.get('Transfer-Encoding', b'')
+ transfer_encoding = ensure_bytes(transfer_encoding)
+ return transfer_encoding.lower() == b'chunked'
def send(self, request):
try:
diff --git a/contrib/python/botocore/py3/botocore/loaders.py b/contrib/python/botocore/py3/botocore/loaders.py
index 2ab4dca0d9..566f29650a 100644
--- a/contrib/python/botocore/py3/botocore/loaders.py
+++ b/contrib/python/botocore/py3/botocore/loaders.py
@@ -102,19 +102,16 @@ for the sdk. For instance, additional operation parameters might be added here
which don't represent the actual service api.
"""
import collections
-import os
import logging
+import os
from botocore import BOTOCORE_ROOT
-from botocore.compat import json
-from botocore.compat import six
-from botocore.compat import OrderedDict
+from botocore.compat import OrderedDict, json, six
from botocore.exceptions import DataNotFoundError, UnknownServiceError
from botocore.utils import deep_merge
from library.python import resource
-
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/model.py b/contrib/python/botocore/py3/botocore/model.py
index b9641dfb0e..fa1e8fe815 100644
--- a/contrib/python/botocore/py3/botocore/model.py
+++ b/contrib/python/botocore/py3/botocore/model.py
@@ -13,11 +13,12 @@
"""Abstractions to interact with service models."""
from collections import defaultdict
-from botocore.utils import (CachedProperty, instance_cache,
- hyphenize_service_id)
from botocore.compat import OrderedDict
-from botocore.exceptions import MissingServiceIdError
-from botocore.exceptions import UndefinedModelAttributeError
+from botocore.exceptions import (
+ MissingServiceIdError,
+ UndefinedModelAttributeError,
+)
+from botocore.utils import CachedProperty, hyphenize_service_id, instance_cache
NOT_SET = object()
@@ -54,7 +55,7 @@ class Shape(object):
'xmlNamespace', 'resultWrapper', 'xmlAttribute',
'eventstream', 'event', 'eventheader', 'eventpayload',
'jsonvalue', 'timestampFormat', 'hostLabel']
- METADATA_ATTRS = ['required', 'min', 'max', 'sensitive', 'enum',
+ METADATA_ATTRS = ['required', 'min', 'max', 'pattern', 'sensitive', 'enum',
'idempotencyToken', 'error', 'exception',
'endpointdiscoveryid', 'retryable', 'document', 'union']
MAP_TYPE = OrderedDict
@@ -134,6 +135,7 @@ class Shape(object):
* min
* max
+ * pattern
* enum
* sensitive
* required
@@ -547,6 +549,10 @@ class OperationModel(object):
return self._operation_model.get('httpChecksumRequired', False)
@CachedProperty
+ def http_checksum(self):
+ return self._operation_model.get('httpChecksum', {})
+
+ @CachedProperty
def has_event_stream_input(self):
return self.get_event_stream_input() is not None
diff --git a/contrib/python/botocore/py3/botocore/monitoring.py b/contrib/python/botocore/py3/botocore/monitoring.py
index 1ae1ca067f..0a01669af0 100644
--- a/contrib/python/botocore/py3/botocore/monitoring.py
+++ b/contrib/python/botocore/py3/botocore/monitoring.py
@@ -15,10 +15,9 @@ import logging
import re
import time
-from botocore.compat import ensure_unicode, ensure_bytes, urlparse
+from botocore.compat import ensure_bytes, ensure_unicode, urlparse
from botocore.retryhandler import EXCEPTION_MAP as RETRYABLE_EXCEPTIONS
-
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/paginate.py b/contrib/python/botocore/py3/botocore/paginate.py
index 6dd39f2981..ded0d5e24f 100644
--- a/contrib/python/botocore/py3/botocore/paginate.py
+++ b/contrib/python/botocore/py3/botocore/paginate.py
@@ -11,18 +11,16 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
+import base64
+import json
+import logging
from itertools import tee
-from botocore.compat import six
-
import jmespath
-import json
-import base64
-import logging
-from botocore.exceptions import PaginationError
-from botocore.compat import zip
-from botocore.utils import set_value_from_jmespath, merge_dicts
+from botocore.compat import six, zip
+from botocore.exceptions import PaginationError
+from botocore.utils import merge_dicts, set_value_from_jmespath
log = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/parsers.py b/contrib/python/botocore/py3/botocore/parsers.py
index c030be63d8..02c913fae1 100644
--- a/contrib/python/botocore/py3/botocore/parsers.py
+++ b/contrib/python/botocore/py3/botocore/parsers.py
@@ -114,16 +114,19 @@ Each call to ``parse()`` returns a dict has this form::
}
"""
-import re
import base64
import json
import logging
+import re
-from botocore.compat import six, ETree, XMLParseError
+from botocore.compat import ETree, XMLParseError, six
from botocore.eventstream import EventStream, NoInitialResponseError
-
-from botocore.utils import parse_timestamp, merge_dicts, \
- is_json_value_header, lowercase_dict
+from botocore.utils import (
+ is_json_value_header,
+ lowercase_dict,
+ merge_dicts,
+ parse_timestamp,
+)
LOG = logging.getLogger(__name__)
@@ -259,8 +262,15 @@ class ResponseParser(object):
headers = response['headers']
response_metadata['HTTPHeaders'] = lowercase_dict(headers)
parsed['ResponseMetadata'] = response_metadata
+ self._add_checksum_response_metadata(response, response_metadata)
return parsed
+ def _add_checksum_response_metadata(self, response, response_metadata):
+ checksum_context = response.get('context', {}).get('checksum', {})
+ algorithm = checksum_context.get('response_algorithm')
+ if algorithm:
+ response_metadata['ChecksumAlgorithm'] = algorithm
+
def _is_modeled_error_shape(self, shape):
return shape is not None and shape.metadata.get('exception', False)
@@ -975,6 +985,11 @@ class RestJSONParser(BaseRestParser, BaseJSONParser):
error['Error']['Code'] = body.get(
'code', body.get('Code', ''))
+ def _handle_integer(self, shape, value):
+ return int(value)
+
+ _handle_long = _handle_integer
+
class RestXMLParser(BaseRestParser, BaseXMLResponseParser):
diff --git a/contrib/python/botocore/py3/botocore/regions.py b/contrib/python/botocore/py3/botocore/regions.py
index 59daa54504..1aac6feb9f 100644
--- a/contrib/python/botocore/py3/botocore/regions.py
+++ b/contrib/python/botocore/py3/botocore/regions.py
@@ -20,7 +20,9 @@ import logging
import re
from botocore.exceptions import (
- NoRegionError, UnknownRegionError, EndpointVariantError
+ EndpointVariantError,
+ NoRegionError,
+ UnknownRegionError,
)
LOG = logging.getLogger(__name__)
@@ -298,6 +300,7 @@ class EndpointResolver(BaseEndpointResolver):
service_name, endpoint_name
))
raise EndpointVariantError(tags=tags, error_msg=error_msg)
+ self._merge_keys(endpoint_data, result)
else:
result = endpoint_data
diff --git a/contrib/python/botocore/py3/botocore/response.py b/contrib/python/botocore/py3/botocore/response.py
index b7abaaec75..b74805cbe2 100644
--- a/contrib/python/botocore/py3/botocore/response.py
+++ b/contrib/python/botocore/py3/botocore/response.py
@@ -15,13 +15,16 @@
import logging
from io import IOBase
+from urllib3.exceptions import ProtocolError as URLLib3ProtocolError
+from urllib3.exceptions import ReadTimeoutError as URLLib3ReadTimeoutError
+
+from botocore import parsers
from botocore.compat import set_socket_timeout
from botocore.exceptions import (
- IncompleteReadError, ReadTimeoutError, ResponseStreamingError
+ IncompleteReadError,
+ ReadTimeoutError,
+ ResponseStreamingError,
)
-from urllib3.exceptions import ReadTimeoutError as URLLib3ReadTimeoutError
-from urllib3.exceptions import ProtocolError as URLLib3ProtocolError
-from botocore import parsers
# Keep these imported. There's pre-existing code that uses them.
from botocore import ScalarTypes # noqa
diff --git a/contrib/python/botocore/py3/botocore/retries/adaptive.py b/contrib/python/botocore/py3/botocore/retries/adaptive.py
index 1870147a08..67ab5e1ef9 100644
--- a/contrib/python/botocore/py3/botocore/retries/adaptive.py
+++ b/contrib/python/botocore/py3/botocore/retries/adaptive.py
@@ -1,11 +1,8 @@
-import math
import logging
+import math
import threading
-from botocore.retries import bucket
-from botocore.retries import throttling
-from botocore.retries import standard
-
+from botocore.retries import bucket, standard, throttling
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/retries/bucket.py b/contrib/python/botocore/py3/botocore/retries/bucket.py
index 1ddc663bb1..99ae5879b6 100644
--- a/contrib/python/botocore/py3/botocore/retries/bucket.py
+++ b/contrib/python/botocore/py3/botocore/retries/bucket.py
@@ -1,6 +1,6 @@
"""This module implements token buckets used for client side throttling."""
-import time
import threading
+import time
from botocore.exceptions import CapacityNotAvailableError
diff --git a/contrib/python/botocore/py3/botocore/retries/special.py b/contrib/python/botocore/py3/botocore/retries/special.py
index 71a40e0648..1928780d49 100644
--- a/contrib/python/botocore/py3/botocore/retries/special.py
+++ b/contrib/python/botocore/py3/botocore/retries/special.py
@@ -7,8 +7,8 @@ module. Ideally we should be able to remove this module.
"""
import logging
from binascii import crc32
-from botocore.retries.base import BaseRetryableChecker
+from botocore.retries.base import BaseRetryableChecker
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/retries/standard.py b/contrib/python/botocore/py3/botocore/retries/standard.py
index 96c70e7a95..e6a4a81a9b 100644
--- a/contrib/python/botocore/py3/botocore/retries/standard.py
+++ b/contrib/python/botocore/py3/botocore/retries/standard.py
@@ -23,14 +23,17 @@ This allows us to define an API that has minimal coupling to the event
based API used by botocore.
"""
-import random
import logging
+import random
-from botocore.exceptions import ConnectionError, HTTPClientError
-from botocore.exceptions import ReadTimeoutError, ConnectTimeoutError
-from botocore.retries import quota
-from botocore.retries import special
-from botocore.retries.base import BaseRetryBackoff, BaseRetryableChecker
+from botocore.exceptions import (
+ ConnectionError,
+ ConnectTimeoutError,
+ HTTPClientError,
+ ReadTimeoutError,
+)
+from botocore.retries import quota, special
+from botocore.retries.base import BaseRetryableChecker, BaseRetryBackoff
DEFAULT_MAX_ATTEMPTS = 3
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/retryhandler.py b/contrib/python/botocore/py3/botocore/retryhandler.py
index 1b1066297e..b411322759 100644
--- a/contrib/python/botocore/py3/botocore/retryhandler.py
+++ b/contrib/python/botocore/py3/botocore/retryhandler.py
@@ -12,17 +12,19 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-import random
import functools
import logging
+import random
from binascii import crc32
from botocore.exceptions import (
- ChecksumError, EndpointConnectionError, ReadTimeoutError,
- ConnectionError, ConnectionClosedError,
+ ChecksumError,
+ ConnectionClosedError,
+ ConnectionError,
+ EndpointConnectionError,
+ ReadTimeoutError,
)
-
logger = logging.getLogger(__name__)
# The only supported error for now is GENERAL_CONNECTION_ERROR
# which maps to requests generic ConnectionError. If we're able
diff --git a/contrib/python/botocore/py3/botocore/serialize.py b/contrib/python/botocore/py3/botocore/serialize.py
index ffad473915..f3bd723a7c 100644
--- a/contrib/python/botocore/py3/botocore/serialize.py
+++ b/contrib/python/botocore/py3/botocore/serialize.py
@@ -37,22 +37,20 @@ The input to the serializers should be text (str/unicode), not bytes,
with the exception of blob types. Those are assumed to be binary,
and if a str/unicode type is passed in, it will be encoded as utf-8.
"""
-import re
import base64
import calendar
import datetime
+import re
from xml.etree import ElementTree
-from botocore.compat import six
-
-from botocore.compat import json, formatdate
-from botocore.utils import parse_to_aware_datetime
-from botocore.utils import percent_encode
-from botocore.utils import is_json_value_header
-from botocore.utils import conditionally_calculate_md5
-from botocore.utils import has_header
from botocore import validate
-
+from botocore.compat import formatdate, json, six
+from botocore.utils import (
+ has_header,
+ is_json_value_header,
+ parse_to_aware_datetime,
+ percent_encode,
+)
# From the spec, the default timestamp format if not specified is iso8601.
DEFAULT_TIMESTAMP_FORMAT = 'iso8601'
@@ -186,12 +184,6 @@ class Serializer(object):
return host_prefix_expression.format(**format_kwargs)
- def _prepare_additional_traits(self, request, operation_model):
- """Determine if additional traits are required for given model"""
- if operation_model.http_checksum_required:
- conditionally_calculate_md5(request)
- return request
-
class QuerySerializer(Serializer):
@@ -218,9 +210,6 @@ class QuerySerializer(Serializer):
if host_prefix is not None:
serialized['host_prefix'] = host_prefix
- serialized = self._prepare_additional_traits(
- serialized, operation_model
- )
return serialized
def _serialize(self, serialized, value, shape, prefix=''):
@@ -354,9 +343,6 @@ class JSONSerializer(Serializer):
if host_prefix is not None:
serialized['host_prefix'] = host_prefix
- serialized = self._prepare_additional_traits(
- serialized, operation_model
- )
return serialized
def _serialize(self, serialized, value, shape, key=None):
@@ -478,9 +464,6 @@ class BaseRestSerializer(Serializer):
if host_prefix is not None:
serialized['host_prefix'] = host_prefix
- serialized = self._prepare_additional_traits(
- serialized, operation_model
- )
return serialized
def _render_uri_template(self, uri_template, params):
diff --git a/contrib/python/botocore/py3/botocore/session.py b/contrib/python/botocore/py3/botocore/session.py
index 0a23344916..7abc7aeb5b 100644
--- a/contrib/python/botocore/py3/botocore/session.py
+++ b/contrib/python/botocore/py3/botocore/session.py
@@ -23,36 +23,50 @@ import platform
import socket
import warnings
-from botocore import __version__
-from botocore import UNSIGNED
+import botocore.client
import botocore.configloader
import botocore.credentials
-import botocore.client
-from botocore.configprovider import ConfigValueStore
-from botocore.configprovider import ConfigChainFactory
-from botocore.configprovider import create_botocore_default_config_mapping
-from botocore.configprovider import BOTOCORE_DEFAUT_SESSION_VARIABLES
-from botocore.configprovider import DefaultConfigResolver
-from botocore.configprovider import SmartDefaultsConfigStoreFactory
+from botocore import (
+ UNSIGNED,
+ __version__,
+ handlers,
+ monitoring,
+ paginate,
+ retryhandler,
+ translate,
+ waiter,
+)
+from botocore.compat import HAS_CRT, MutableMapping
+from botocore.configprovider import (
+ BOTOCORE_DEFAUT_SESSION_VARIABLES,
+ ConfigChainFactory,
+ ConfigValueStore,
+ DefaultConfigResolver,
+ SmartDefaultsConfigStoreFactory,
+ create_botocore_default_config_mapping,
+)
+from botocore.errorfactory import ClientExceptionsFactory
from botocore.exceptions import (
- ConfigNotFound, ProfileNotFound, UnknownServiceError, InvalidDefaultsMode,
+ ConfigNotFound,
+ InvalidDefaultsMode,
PartialCredentialsError,
+ ProfileNotFound,
+ UnknownServiceError,
+)
+from botocore.hooks import (
+ EventAliaser,
+ HierarchicalEmitter,
+ first_non_none_response,
)
-from botocore.errorfactory import ClientExceptionsFactory
-from botocore import handlers
-from botocore.hooks import HierarchicalEmitter, first_non_none_response
-from botocore.hooks import EventAliaser
from botocore.loaders import create_loader
+from botocore.model import ServiceModel
from botocore.parsers import ResponseParserFactory
from botocore.regions import EndpointResolver
-from botocore.model import ServiceModel
-from botocore import monitoring
-from botocore import paginate
-from botocore import waiter
-from botocore import retryhandler, translate
-from botocore.utils import EVENT_ALIASES, validate_region_name, IMDSRegionProvider
-from botocore.compat import MutableMapping, HAS_CRT
-
+from botocore.utils import (
+ EVENT_ALIASES,
+ IMDSRegionProvider,
+ validate_region_name,
+)
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/botocore/signers.py b/contrib/python/botocore/py3/botocore/signers.py
index d50e81ea1e..4fb47433f0 100644
--- a/contrib/python/botocore/py3/botocore/signers.py
+++ b/contrib/python/botocore/py3/botocore/signers.py
@@ -10,18 +10,20 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
+import base64
import datetime
-import weakref
import json
-import base64
+import weakref
import botocore
import botocore.auth
-from botocore.compat import six, OrderedDict
from botocore.awsrequest import create_request_object, prepare_request_dict
-from botocore.exceptions import UnknownSignatureVersionError
-from botocore.exceptions import UnknownClientMethodError
-from botocore.exceptions import UnsupportedSignatureVersionError
+from botocore.compat import OrderedDict, six
+from botocore.exceptions import (
+ UnknownClientMethodError,
+ UnknownSignatureVersionError,
+ UnsupportedSignatureVersionError,
+)
from botocore.utils import datetime2timestamp
# Keep these imported. There's pre-existing code that uses them.
diff --git a/contrib/python/botocore/py3/botocore/stub.py b/contrib/python/botocore/py3/botocore/stub.py
index f35ac1c407..60bdcde041 100644
--- a/contrib/python/botocore/py3/botocore/stub.py
+++ b/contrib/python/botocore/py3/botocore/stub.py
@@ -14,10 +14,14 @@ import copy
from collections import deque
from pprint import pformat
-from botocore.validate import validate_parameters
-from botocore.exceptions import ParamValidationError, \
- StubResponseError, StubAssertionError, UnStubbedResponseError
from botocore.awsrequest import AWSResponse
+from botocore.exceptions import (
+ ParamValidationError,
+ StubAssertionError,
+ StubResponseError,
+ UnStubbedResponseError,
+)
+from botocore.validate import validate_parameters
class _ANY(object):
@@ -237,7 +241,7 @@ class Stubber(object):
http_response = AWSResponse(None, 200, {}, None)
operation_name = self.client.meta.method_to_api_mapping.get(method)
- self._validate_response(operation_name, service_response)
+ self._validate_operation_response(operation_name, service_response)
# Add the service_response to the queue for returning responses
response = {
@@ -250,7 +254,7 @@ class Stubber(object):
def add_client_error(self, method, service_error_code='',
service_message='', http_status_code=400,
service_error_meta=None, expected_params=None,
- response_meta=None):
+ response_meta=None, modeled_fields=None):
"""
Adds a ``ClientError`` to the response queue.
@@ -283,6 +287,12 @@ class Stubber(object):
response's ResponseMetadata
:type response_meta: dict
+ :param modeled_fields: Additional keys to be added to the response
+ based on fields that are modeled for the particular error code.
+ These keys will be validated against the particular error shape
+ designated by the error code.
+ :type modeled_fields: dict
+
"""
http_response = AWSResponse(None, http_status_code, {}, None)
@@ -303,6 +313,12 @@ class Stubber(object):
if response_meta is not None:
parsed_response['ResponseMetadata'].update(response_meta)
+ if modeled_fields is not None:
+ service_model = self.client.meta.service_model
+ shape = service_model.shape_for_error_code(service_error_code)
+ self._validate_response(shape, modeled_fields)
+ parsed_response.update(modeled_fields)
+
operation_name = self.client.meta.method_to_api_mapping.get(method)
# Note that we do not allow for expected_params while
# adding errors into the queue yet.
@@ -374,7 +390,7 @@ class Stubber(object):
if context and context.get('is_presign_request'):
return True
- def _validate_response(self, operation_name, service_response):
+ def _validate_operation_response(self, operation_name, service_response):
service_model = self.client.meta.service_model
operation_model = service_model.operation_model(operation_name)
output_shape = operation_model.output_shape
@@ -386,8 +402,11 @@ class Stubber(object):
response = copy.copy(service_response)
del response['ResponseMetadata']
- if output_shape is not None:
- validate_parameters(response, output_shape)
+ self._validate_response(output_shape, response)
+
+ def _validate_response(self, shape, response):
+ if shape is not None:
+ validate_parameters(response, shape)
elif response:
# If the output shape is None, that means the response should be
# empty apart from ResponseMetadata
diff --git a/contrib/python/botocore/py3/botocore/utils.py b/contrib/python/botocore/py3/botocore/utils.py
index 1c82020209..e177b0a6d6 100644
--- a/contrib/python/botocore/py3/botocore/utils.py
+++ b/contrib/python/botocore/py3/botocore/utils.py
@@ -11,42 +11,66 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import base64
-import re
-import time
-import logging
-import datetime
-import hashlib
import binascii
+import cgi
+import datetime
import functools
-import weakref
-import random
+import hashlib
+import io
+import logging
import os
+import random
+import re
import socket
-import cgi
+import time
+import weakref
import dateutil.parser
from dateutil.tz import tzutc
+from urllib3.exceptions import LocationParseError
import botocore
import botocore.awsrequest
import botocore.httpsession
from botocore.compat import (
- json, quote, zip_longest, urlsplit, urlunsplit, OrderedDict,
- six, urlparse, get_tzinfo_options, get_md5, MD5_AVAILABLE,
- HAS_CRT
+ HAS_CRT,
+ MD5_AVAILABLE,
+ OrderedDict,
+ get_md5,
+ get_tzinfo_options,
+ json,
+ quote,
+ six,
+ urlparse,
+ urlsplit,
+ urlunsplit,
+ zip_longest,
)
-from six.moves.urllib.request import getproxies, proxy_bypass
from botocore.exceptions import (
- InvalidExpressionError, ConfigNotFound, InvalidDNSNameError, ClientError,
- MetadataRetrievalError, EndpointConnectionError, ReadTimeoutError,
- ConnectionClosedError, ConnectTimeoutError, UnsupportedS3ArnError,
- UnsupportedS3AccesspointConfigurationError, SSOTokenLoadError,
- InvalidRegionError, InvalidIMDSEndpointError, InvalidIMDSEndpointModeError,
- UnsupportedOutpostResourceError, UnsupportedS3ControlConfigurationError,
- UnsupportedS3ControlArnError, InvalidHostLabelError, HTTPClientError,
- UnsupportedS3ConfigurationError, MissingDependencyException
+ ClientError,
+ ConfigNotFound,
+ ConnectionClosedError,
+ ConnectTimeoutError,
+ EndpointConnectionError,
+ HTTPClientError,
+ InvalidDNSNameError,
+ InvalidExpressionError,
+ InvalidHostLabelError,
+ InvalidIMDSEndpointError,
+ InvalidIMDSEndpointModeError,
+ InvalidRegionError,
+ MetadataRetrievalError,
+ MissingDependencyException,
+ ReadTimeoutError,
+ SSOTokenLoadError,
+ UnsupportedOutpostResourceError,
+ UnsupportedS3AccesspointConfigurationError,
+ UnsupportedS3ArnError,
+ UnsupportedS3ConfigurationError,
+ UnsupportedS3ControlArnError,
+ UnsupportedS3ControlConfigurationError,
)
-from urllib3.exceptions import LocationParseError
+from six.moves.urllib.request import getproxies, proxy_bypass
logger = logging.getLogger(__name__)
DEFAULT_METADATA_SERVICE_TIMEOUT = 1
@@ -178,6 +202,12 @@ IPV6_ADDRZ_RE = re.compile("^" + IPV6_ADDRZ_PAT + "$")
# These are the characters that are stripped by post-bpo-43882 urlparse().
UNSAFE_URL_CHARS = frozenset('\t\r\n')
+# This pattern can be used to detect if a header is a flexible checksum header
+CHECKSUM_HEADER_PATTERN = re.compile(
+ r'^X-Amz-Checksum-([a-z0-9]*)$',
+ flags=re.IGNORECASE,
+)
+
def ensure_boolean(val):
"""Ensures a boolean value if a string or boolean is provided
@@ -2525,6 +2555,35 @@ def should_bypass_proxies(url):
return False
+def determine_content_length(body):
+ # No body, content length of 0
+ if not body:
+ return 0
+
+ # Try asking the body for it's length
+ try:
+ return len(body)
+ except (AttributeError, TypeError):
+ pass
+
+ # Try getting the length from a seekable stream
+ if hasattr(body, 'seek') and hasattr(body, 'tell'):
+ try:
+ orig_pos = body.tell()
+ body.seek(0, 2)
+ end_file_pos = body.tell()
+ body.seek(orig_pos)
+ return end_file_pos - orig_pos
+ except io.UnsupportedOperation:
+ # in case when body is, for example, io.BufferedIOBase object
+ # it has "seek" method which throws "UnsupportedOperation"
+ # exception in such case we want to fall back to "chunked"
+ # encoding
+ pass
+ # Failed to determine the length
+ return None
+
+
def get_encoding_from_headers(headers, default='ISO-8859-1'):
"""Returns encodings from given HTTP Header Dict.
@@ -2572,6 +2631,16 @@ def conditionally_calculate_md5(params, **kwargs):
"""Only add a Content-MD5 if the system supports it."""
headers = params['headers']
body = params['body']
+ checksum_context = params.get('context', {}).get('checksum', {})
+ checksum_algorithm = checksum_context.get('request_algorithm')
+ if checksum_algorithm and checksum_algorithm != 'conditional-md5':
+ # Skip for requests that will have a flexible checksum applied
+ return
+ # If a header matching the x-amz-checksum-* pattern is present, we
+ # assume a checksum has already been provided and an md5 is not needed
+ for header in headers:
+ if CHECKSUM_HEADER_PATTERN.match(header):
+ return
if MD5_AVAILABLE and body is not None and 'Content-MD5' not in headers:
md5_digest = calculate_md5(body, **kwargs)
params['headers']['Content-MD5'] = md5_digest
diff --git a/contrib/python/botocore/py3/botocore/validate.py b/contrib/python/botocore/py3/botocore/validate.py
index 727b2f99f8..8e03b8e2ce 100644
--- a/contrib/python/botocore/py3/botocore/validate.py
+++ b/contrib/python/botocore/py3/botocore/validate.py
@@ -13,14 +13,13 @@ Validation Errors
"""
-from botocore.compat import six
import decimal
import json
from datetime import datetime
-from botocore.utils import parse_to_aware_datetime
-from botocore.utils import is_json_value_header
+from botocore.compat import six
from botocore.exceptions import ParamValidationError
+from botocore.utils import is_json_value_header, parse_to_aware_datetime
def validate_parameters(params, shape):
diff --git a/contrib/python/botocore/py3/botocore/waiter.py b/contrib/python/botocore/py3/botocore/waiter.py
index edd1b60aac..5e1dd634de 100644
--- a/contrib/python/botocore/py3/botocore/waiter.py
+++ b/contrib/python/botocore/py3/botocore/waiter.py
@@ -10,15 +10,16 @@
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
-import jmespath
import logging
import time
-from botocore.utils import get_service_module_name
+import jmespath
+
from botocore.docs.docstring import WaiterDocstring
-from .exceptions import WaiterError, ClientError, WaiterConfigError
-from . import xform_name
+from botocore.utils import get_service_module_name
+from . import xform_name
+from .exceptions import ClientError, WaiterConfigError, WaiterError
logger = logging.getLogger(__name__)
diff --git a/contrib/python/botocore/py3/patches/01-unvendor-six.patch b/contrib/python/botocore/py3/patches/01-unvendor-six.patch
index ee061c6184..44753b669d 100644
--- a/contrib/python/botocore/py3/patches/01-unvendor-six.patch
+++ b/contrib/python/botocore/py3/patches/01-unvendor-six.patch
@@ -20,34 +20,34 @@
pass
--- contrib/python/botocore/py3/botocore/endpoint.py (index)
+++ contrib/python/botocore/py3/botocore/endpoint.py (working tree)
-@@ -19,7 +19,7 @@ import logging
- import threading
- import uuid
-
+@@ -32,7 +32,7 @@ import logging
+ is_valid_endpoint_url,
+ is_valid_ipv6_endpoint_url,
+ )
-from botocore.vendored import six
+from botocore.compat import six
- from botocore.awsrequest import create_request_object
- from botocore.exceptions import HTTPClientError
+ logger = logging.getLogger(__name__)
+ history_recorder = get_global_history_recorder()
--- contrib/python/botocore/py3/botocore/httpsession.py (index)
+++ contrib/python/botocore/py3/botocore/httpsession.py (working tree)
-@@ -30,7 +30,7 @@ except ImportError:
- from urllib3.util.ssl_ import SSLContext
-
- import botocore.awsrequest
+@@ -47,7 +47,7 @@ except ImportError:
+ ReadTimeoutError,
+ SSLError,
+ )
-from botocore.vendored.six.moves.urllib_parse import unquote
+from six.moves.urllib_parse import unquote
- from botocore.compat import filter_ssl_warnings, urlparse
- from botocore.exceptions import (
- ConnectionClosedError, EndpointConnectionError, HTTPClientError,
+
+ filter_ssl_warnings()
+ logger = logging.getLogger(__name__)
--- contrib/python/botocore/py3/botocore/utils.py (index)
+++ contrib/python/botocore/py3/botocore/utils.py (working tree)
-@@ -35,7 +35,7 @@ from botocore.compat import (
- six, urlparse, get_tzinfo_options, get_md5, MD5_AVAILABLE,
- HAS_CRT
+@@ -70,7 +70,7 @@ from botocore.compat import (
+ UnsupportedS3ControlArnError,
+ UnsupportedS3ControlConfigurationError,
)
-from botocore.vendored.six.moves.urllib.request import getproxies, proxy_bypass
+from six.moves.urllib.request import getproxies, proxy_bypass
- from botocore.exceptions import (
- InvalidExpressionError, ConfigNotFound, InvalidDNSNameError, ClientError,
- MetadataRetrievalError, EndpointConnectionError, ReadTimeoutError,
+
+ logger = logging.getLogger(__name__)
+ DEFAULT_METADATA_SERVICE_TIMEOUT = 1
diff --git a/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch b/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch
index aeb1912f76..efc83bdb96 100644
--- a/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch
+++ b/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch
@@ -1,6 +1,6 @@
--- contrib/python/botocore/py3/botocore/data/endpoints.json (index)
+++ contrib/python/botocore/py3/botocore/data/endpoints.json (working tree)
-@@ -18009,6 +18009,46 @@
+@@ -18343,6 +18343,46 @@
}
}
}
@@ -61,7 +61,7 @@
# Used to specify anonymous (unsigned) request signature
--- contrib/python/botocore/py3/botocore/configprovider.py (index)
+++ contrib/python/botocore/py3/botocore/configprovider.py (working tree)
-@@ -50,7 +50,7 @@ logger = logging.getLogger(__name__)
+@@ -49,7 +49,7 @@ logger = logging.getLogger(__name__)
BOTOCORE_DEFAUT_SESSION_VARIABLES = {
# logical: config_file, env_var, default_value, conversion_func
'profile': (None, ['AWS_DEFAULT_PROFILE', 'AWS_PROFILE'], None, None),
@@ -72,27 +72,26 @@
'ca_bundle': ('ca_bundle', 'AWS_CA_BUNDLE', None, None),
--- contrib/python/botocore/py3/botocore/loaders.py (index)
+++ contrib/python/botocore/py3/botocore/loaders.py (working tree)
-@@ -101,15 +101,19 @@ information that doesn't quite fit in the original models, but is still needed
+@@ -101,14 +101,17 @@ information that doesn't quite fit in the original models, but is still needed
for the sdk. For instance, additional operation parameters might be added here
which don't represent the actual service api.
"""
+import collections
- import os
import logging
+ import os
from botocore import BOTOCORE_ROOT
- from botocore.compat import json
-+from botocore.compat import six
- from botocore.compat import OrderedDict
+-from botocore.compat import OrderedDict, json
++from botocore.compat import OrderedDict, json, six
from botocore.exceptions import DataNotFoundError, UnknownServiceError
from botocore.utils import deep_merge
+from library.python import resource
+
-
logger = logging.getLogger(__name__)
-@@ -176,6 +180,51 @@ class JSONFileLoader(object):
+
+@@ -174,6 +177,51 @@ class JSONFileLoader(object):
return json.loads(payload, object_pairs_hook=OrderedDict)
@@ -144,7 +143,7 @@
def create_loader(search_path_string=None):
"""Create a Loader class.
-@@ -209,7 +258,7 @@ class Loader(object):
+@@ -207,7 +255,7 @@ class Loader(object):
convenience method over ``load_data`` and ``determine_latest_version``.
"""
@@ -153,7 +152,7 @@
# The included models in botocore/data/ that we ship with botocore.
BUILTIN_DATA_PATH = os.path.join(BOTOCORE_ROOT, 'data')
# For convenience we automatically add ~/.aws/models to the data path.
-@@ -285,6 +334,11 @@ class Loader(object):
+@@ -283,6 +331,11 @@ class Loader(object):
if self.file_loader.exists(full_load_path):
services.add(service_name)
break
@@ -165,7 +164,7 @@
return sorted(services)
@instance_cache
-@@ -336,6 +390,11 @@ class Loader(object):
+@@ -334,6 +387,11 @@ class Loader(object):
# to the type_name passed in.
if self.file_loader.exists(full_path):
known_api_versions.add(dirname)
@@ -177,7 +176,7 @@
if not known_api_versions:
raise DataNotFoundError(data_path=service_name)
return sorted(known_api_versions)
-@@ -421,6 +480,12 @@ class Loader(object):
+@@ -419,6 +477,12 @@ class Loader(object):
found = self.file_loader.load_file(possible_path)
if found is not None:
return found
diff --git a/contrib/python/botocore/py3/patches/03-extended-listings.patch b/contrib/python/botocore/py3/patches/03-extended-listings.patch
index be84207f22..f40ec23c95 100644
--- a/contrib/python/botocore/py3/patches/03-extended-listings.patch
+++ b/contrib/python/botocore/py3/patches/03-extended-listings.patch
@@ -154,7 +154,7 @@ date: 2021-10-27T00:34:16+03:00
"members":{
--- contrib/python/botocore/py3/botocore/handlers.py (73e85ed9c4be248886f10db6b7d83f27d446916c)
+++ contrib/python/botocore/py3/botocore/handlers.py (cc02b99f18408f40978b56abfd8e5e9b2c2492d7)
-@@ -756,6 +756,27 @@ def decode_list_object_v2(parsed, context, **kwargs):
+@@ -763,6 +763,27 @@ def decode_list_object_v2(parsed, context, **kwargs):
)
@@ -182,7 +182,7 @@ date: 2021-10-27T00:34:16+03:00
def decode_list_object_versions(parsed, context, **kwargs):
# From the documentation: If you specify encoding-type request parameter,
# Amazon S3 includes this element in the response, and returns encoded key
-@@ -1052,6 +1073,7 @@ BUILTIN_HANDLERS = [
+@@ -1059,6 +1080,7 @@ BUILTIN_HANDLERS = [
('before-parameter-build.glacier', inject_account_id),
('after-call.s3.ListObjects', decode_list_object),
('after-call.s3.ListObjectsV2', decode_list_object_v2),