New upstream version 1.15.46+repack

This commit is contained in:
TANIGUCHI Takaki 2020-04-25 13:11:54 +09:00
parent 5762630096
commit 7a9bc8907a
155 changed files with 26586 additions and 2302 deletions

View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.15.26
Version: 1.15.46
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.15.26
Version: 1.15.46
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

View file

@ -49,6 +49,7 @@ botocore/data/_retry.json
botocore/data/endpoints.json
botocore/data/accessanalyzer/2019-11-01/paginators-1.json
botocore/data/accessanalyzer/2019-11-01/service-2.json
botocore/data/acm-pca/2017-08-22/examples-1.json
botocore/data/acm-pca/2017-08-22/paginators-1.json
botocore/data/acm-pca/2017-08-22/service-2.json
botocore/data/acm-pca/2017-08-22/waiters-2.json
@ -56,6 +57,7 @@ botocore/data/acm/2015-12-08/examples-1.json
botocore/data/acm/2015-12-08/paginators-1.json
botocore/data/acm/2015-12-08/service-2.json
botocore/data/acm/2015-12-08/waiters-2.json
botocore/data/alexaforbusiness/2017-11-09/examples-1.json
botocore/data/alexaforbusiness/2017-11-09/paginators-1.json
botocore/data/alexaforbusiness/2017-11-09/service-2.json
botocore/data/amplify/2017-07-25/paginators-1.json
@ -82,10 +84,13 @@ botocore/data/appstream/2016-12-01/examples-1.json
botocore/data/appstream/2016-12-01/paginators-1.json
botocore/data/appstream/2016-12-01/service-2.json
botocore/data/appstream/2016-12-01/waiters-2.json
botocore/data/appsync/2017-07-25/examples-1.json
botocore/data/appsync/2017-07-25/paginators-1.json
botocore/data/appsync/2017-07-25/service-2.json
botocore/data/athena/2017-05-18/examples-1.json
botocore/data/athena/2017-05-18/paginators-1.json
botocore/data/athena/2017-05-18/service-2.json
botocore/data/autoscaling-plans/2018-01-06/examples-1.json
botocore/data/autoscaling-plans/2018-01-06/paginators-1.json
botocore/data/autoscaling-plans/2018-01-06/service-2.json
botocore/data/autoscaling/2011-01-01/examples-1.json
@ -99,14 +104,17 @@ botocore/data/batch/2016-08-10/service-2.json
botocore/data/budgets/2016-10-20/examples-1.json
botocore/data/budgets/2016-10-20/paginators-1.json
botocore/data/budgets/2016-10-20/service-2.json
botocore/data/ce/2017-10-25/examples-1.json
botocore/data/ce/2017-10-25/paginators-1.json
botocore/data/ce/2017-10-25/service-2.json
botocore/data/chime/2018-05-01/paginators-1.json
botocore/data/chime/2018-05-01/service-2.json
botocore/data/cloud9/2017-09-23/examples-1.json
botocore/data/cloud9/2017-09-23/paginators-1.json
botocore/data/cloud9/2017-09-23/service-2.json
botocore/data/clouddirectory/2016-05-10/paginators-1.json
botocore/data/clouddirectory/2016-05-10/service-2.json
botocore/data/clouddirectory/2017-01-11/examples-1.json
botocore/data/clouddirectory/2017-01-11/paginators-1.json
botocore/data/clouddirectory/2017-01-11/service-2.json
botocore/data/cloudformation/2010-05-15/examples-1.json
@ -176,6 +184,7 @@ botocore/data/cloudfront/2019-03-26/waiters-2.json
botocore/data/cloudhsm/2014-05-30/examples-1.json
botocore/data/cloudhsm/2014-05-30/paginators-1.json
botocore/data/cloudhsm/2014-05-30/service-2.json
botocore/data/cloudhsmv2/2017-04-28/examples-1.json
botocore/data/cloudhsmv2/2017-04-28/paginators-1.json
botocore/data/cloudhsmv2/2017-04-28/service-2.json
botocore/data/cloudsearch/2011-02-01/service-2.json
@ -211,6 +220,7 @@ botocore/data/codestar-connections/2019-12-01/paginators-1.json
botocore/data/codestar-connections/2019-12-01/service-2.json
botocore/data/codestar-notifications/2019-10-15/paginators-1.json
botocore/data/codestar-notifications/2019-10-15/service-2.json
botocore/data/codestar/2017-04-19/examples-1.json
botocore/data/codestar/2017-04-19/paginators-1.json
botocore/data/codestar/2017-04-19/service-2.json
botocore/data/cognito-identity/2014-06-30/examples-1.json
@ -220,6 +230,7 @@ botocore/data/cognito-idp/2016-04-18/examples-1.json
botocore/data/cognito-idp/2016-04-18/paginators-1.json
botocore/data/cognito-idp/2016-04-18/service-2.json
botocore/data/cognito-sync/2014-06-30/service-2.json
botocore/data/comprehend/2017-11-27/examples-1.json
botocore/data/comprehend/2017-11-27/paginators-1.json
botocore/data/comprehend/2017-11-27/service-2.json
botocore/data/comprehendmedical/2018-10-30/paginators-1.json
@ -229,6 +240,7 @@ botocore/data/compute-optimizer/2019-11-01/service-2.json
botocore/data/config/2014-11-12/examples-1.json
botocore/data/config/2014-11-12/paginators-1.json
botocore/data/config/2014-11-12/service-2.json
botocore/data/connect/2017-08-08/examples-1.json
botocore/data/connect/2017-08-08/paginators-1.json
botocore/data/connect/2017-08-08/service-2.json
botocore/data/connectparticipant/2018-09-07/paginators-1.json
@ -242,6 +254,7 @@ botocore/data/datapipeline/2012-10-29/paginators-1.json
botocore/data/datapipeline/2012-10-29/service-2.json
botocore/data/datasync/2018-11-09/paginators-1.json
botocore/data/datasync/2018-11-09/service-2.json
botocore/data/dax/2017-04-19/examples-1.json
botocore/data/dax/2017-04-19/paginators-1.json
botocore/data/dax/2017-04-19/service-2.json
botocore/data/detective/2018-10-26/paginators-1.json
@ -255,6 +268,7 @@ botocore/data/directconnect/2012-10-25/service-2.json
botocore/data/discovery/2015-11-01/examples-1.json
botocore/data/discovery/2015-11-01/paginators-1.json
botocore/data/discovery/2015-11-01/service-2.json
botocore/data/dlm/2018-01-12/examples-1.json
botocore/data/dlm/2018-01-12/paginators-1.json
botocore/data/dlm/2018-01-12/service-2.json
botocore/data/dms/2016-01-01/examples-1.json
@ -315,6 +329,7 @@ botocore/data/ecs/2014-11-13/waiters-2.json
botocore/data/efs/2015-02-01/examples-1.json
botocore/data/efs/2015-02-01/paginators-1.json
botocore/data/efs/2015-02-01/service-2.json
botocore/data/eks/2017-11-01/examples-1.json
botocore/data/eks/2017-11-01/paginators-1.json
botocore/data/eks/2017-11-01/service-2.json
botocore/data/eks/2017-11-01/service-2.sdk-extras.json
@ -324,6 +339,7 @@ botocore/data/elastic-inference/2017-07-25/service-2.json
botocore/data/elasticache/2014-09-30/paginators-1.json
botocore/data/elasticache/2014-09-30/service-2.json
botocore/data/elasticache/2014-09-30/waiters-2.json
botocore/data/elasticache/2015-02-02/examples-1.json
botocore/data/elasticache/2015-02-02/paginators-1.json
botocore/data/elasticache/2015-02-02/service-2.json
botocore/data/elasticache/2015-02-02/waiters-2.json
@ -346,6 +362,7 @@ botocore/data/emr/2009-03-31/examples-1.json
botocore/data/emr/2009-03-31/paginators-1.json
botocore/data/emr/2009-03-31/service-2.json
botocore/data/emr/2009-03-31/waiters-2.json
botocore/data/es/2015-01-01/examples-1.json
botocore/data/es/2015-01-01/paginators-1.json
botocore/data/es/2015-01-01/service-2.json
botocore/data/events/2014-02-03/service-2.json
@ -355,6 +372,7 @@ botocore/data/events/2015-10-07/service-2.json
botocore/data/firehose/2015-08-04/examples-1.json
botocore/data/firehose/2015-08-04/paginators-1.json
botocore/data/firehose/2015-08-04/service-2.json
botocore/data/fms/2018-01-01/examples-1.json
botocore/data/fms/2018-01-01/paginators-1.json
botocore/data/fms/2018-01-01/service-2.json
botocore/data/forecast/2018-06-26/paginators-1.json
@ -374,6 +392,7 @@ botocore/data/glacier/2012-06-01/service-2.json
botocore/data/glacier/2012-06-01/waiters-2.json
botocore/data/globalaccelerator/2018-08-08/paginators-1.json
botocore/data/globalaccelerator/2018-08-08/service-2.json
botocore/data/glue/2017-03-31/examples-1.json
botocore/data/glue/2017-03-31/paginators-1.json
botocore/data/glue/2017-03-31/service-2.json
botocore/data/greengrass/2017-06-07/paginators-1.json
@ -398,6 +417,7 @@ botocore/data/inspector/2016-02-16/examples-1.json
botocore/data/inspector/2016-02-16/paginators-1.json
botocore/data/inspector/2016-02-16/service-2.json
botocore/data/iot-data/2015-05-28/service-2.json
botocore/data/iot-jobs-data/2017-09-29/examples-1.json
botocore/data/iot-jobs-data/2017-09-29/paginators-1.json
botocore/data/iot-jobs-data/2017-09-29/service-2.json
botocore/data/iot/2015-05-28/examples-1.json
@ -405,8 +425,10 @@ botocore/data/iot/2015-05-28/paginators-1.json
botocore/data/iot/2015-05-28/service-2.json
botocore/data/iot1click-devices/2018-05-14/paginators-1.json
botocore/data/iot1click-devices/2018-05-14/service-2.json
botocore/data/iot1click-projects/2018-05-14/examples-1.json
botocore/data/iot1click-projects/2018-05-14/paginators-1.json
botocore/data/iot1click-projects/2018-05-14/service-2.json
botocore/data/iotanalytics/2017-11-27/examples-1.json
botocore/data/iotanalytics/2017-11-27/paginators-1.json
botocore/data/iotanalytics/2017-11-27/service-2.json
botocore/data/iotevents-data/2018-10-23/paginators-1.json
@ -421,8 +443,10 @@ botocore/data/kafka/2018-11-14/paginators-1.json
botocore/data/kafka/2018-11-14/service-2.json
botocore/data/kendra/2019-02-03/paginators-1.json
botocore/data/kendra/2019-02-03/service-2.json
botocore/data/kinesis-video-archived-media/2017-09-30/examples-1.json
botocore/data/kinesis-video-archived-media/2017-09-30/paginators-1.json
botocore/data/kinesis-video-archived-media/2017-09-30/service-2.json
botocore/data/kinesis-video-media/2017-09-30/examples-1.json
botocore/data/kinesis-video-media/2017-09-30/paginators-1.json
botocore/data/kinesis-video-media/2017-09-30/service-2.json
botocore/data/kinesis-video-signaling/2019-12-04/paginators-1.json
@ -436,6 +460,7 @@ botocore/data/kinesisanalytics/2015-08-14/paginators-1.json
botocore/data/kinesisanalytics/2015-08-14/service-2.json
botocore/data/kinesisanalyticsv2/2018-05-23/paginators-1.json
botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json
botocore/data/kinesisvideo/2017-09-30/examples-1.json
botocore/data/kinesisvideo/2017-09-30/paginators-1.json
botocore/data/kinesisvideo/2017-09-30/service-2.json
botocore/data/kms/2014-11-01/examples-1.json
@ -448,8 +473,10 @@ botocore/data/lambda/2015-03-31/examples-1.json
botocore/data/lambda/2015-03-31/paginators-1.json
botocore/data/lambda/2015-03-31/service-2.json
botocore/data/lambda/2015-03-31/waiters-2.json
botocore/data/lex-models/2017-04-19/examples-1.json
botocore/data/lex-models/2017-04-19/paginators-1.json
botocore/data/lex-models/2017-04-19/service-2.json
botocore/data/lex-runtime/2016-11-28/examples-1.json
botocore/data/lex-runtime/2016-11-28/paginators-1.json
botocore/data/lex-runtime/2016-11-28/service-2.json
botocore/data/license-manager/2018-08-01/paginators-1.json
@ -464,12 +491,14 @@ botocore/data/machinelearning/2014-12-12/examples-1.json
botocore/data/machinelearning/2014-12-12/paginators-1.json
botocore/data/machinelearning/2014-12-12/service-2.json
botocore/data/machinelearning/2014-12-12/waiters-2.json
botocore/data/macie/2017-12-19/examples-1.json
botocore/data/macie/2017-12-19/paginators-1.json
botocore/data/macie/2017-12-19/service-2.json
botocore/data/managedblockchain/2018-09-24/paginators-1.json
botocore/data/managedblockchain/2018-09-24/service-2.json
botocore/data/marketplace-catalog/2018-09-17/paginators-1.json
botocore/data/marketplace-catalog/2018-09-17/service-2.json
botocore/data/marketplace-entitlement/2017-01-11/examples-1.json
botocore/data/marketplace-entitlement/2017-01-11/paginators-1.json
botocore/data/marketplace-entitlement/2017-01-11/service-2.json
botocore/data/marketplacecommerceanalytics/2015-07-01/examples-1.json
@ -486,8 +515,10 @@ botocore/data/mediapackage-vod/2018-11-07/paginators-1.json
botocore/data/mediapackage-vod/2018-11-07/service-2.json
botocore/data/mediapackage/2017-10-12/paginators-1.json
botocore/data/mediapackage/2017-10-12/service-2.json
botocore/data/mediastore-data/2017-09-01/examples-1.json
botocore/data/mediastore-data/2017-09-01/paginators-1.json
botocore/data/mediastore-data/2017-09-01/service-2.json
botocore/data/mediastore/2017-09-01/examples-1.json
botocore/data/mediastore/2017-09-01/paginators-1.json
botocore/data/mediastore/2017-09-01/service-2.json
botocore/data/mediatailor/2018-04-23/paginators-1.json
@ -495,16 +526,20 @@ botocore/data/mediatailor/2018-04-23/service-2.json
botocore/data/meteringmarketplace/2016-01-14/examples-1.json
botocore/data/meteringmarketplace/2016-01-14/paginators-1.json
botocore/data/meteringmarketplace/2016-01-14/service-2.json
botocore/data/mgh/2017-05-31/examples-1.json
botocore/data/mgh/2017-05-31/paginators-1.json
botocore/data/mgh/2017-05-31/service-2.json
botocore/data/migrationhub-config/2019-06-30/paginators-1.json
botocore/data/migrationhub-config/2019-06-30/service-2.json
botocore/data/mobile/2017-07-01/examples-1.json
botocore/data/mobile/2017-07-01/paginators-1.json
botocore/data/mobile/2017-07-01/service-2.json
botocore/data/mq/2017-11-27/paginators-1.json
botocore/data/mq/2017-11-27/service-2.json
botocore/data/mturk/2017-01-17/examples-1.json
botocore/data/mturk/2017-01-17/paginators-1.json
botocore/data/mturk/2017-01-17/service-2.json
botocore/data/neptune/2014-10-31/examples-1.json
botocore/data/neptune/2014-10-31/paginators-1.json
botocore/data/neptune/2014-10-31/service-2.json
botocore/data/neptune/2014-10-31/service-2.sdk-extras.json
@ -519,6 +554,7 @@ botocore/data/opsworkscm/2016-11-01/examples-1.json
botocore/data/opsworkscm/2016-11-01/paginators-1.json
botocore/data/opsworkscm/2016-11-01/service-2.json
botocore/data/opsworkscm/2016-11-01/waiters-2.json
botocore/data/organizations/2016-11-28/examples-1.json
botocore/data/organizations/2016-11-28/paginators-1.json
botocore/data/organizations/2016-11-28/service-2.json
botocore/data/outposts/2019-12-03/paginators-1.json
@ -529,6 +565,7 @@ botocore/data/personalize-runtime/2018-05-22/paginators-1.json
botocore/data/personalize-runtime/2018-05-22/service-2.json
botocore/data/personalize/2018-05-22/paginators-1.json
botocore/data/personalize/2018-05-22/service-2.json
botocore/data/pi/2018-02-27/examples-1.json
botocore/data/pi/2018-02-27/paginators-1.json
botocore/data/pi/2018-02-27/service-2.json
botocore/data/pinpoint-email/2018-07-26/paginators-1.json
@ -539,6 +576,7 @@ botocore/data/pinpoint/2016-12-01/service-2.json
botocore/data/polly/2016-06-10/examples-1.json
botocore/data/polly/2016-06-10/paginators-1.json
botocore/data/polly/2016-06-10/service-2.json
botocore/data/pricing/2017-10-15/examples-1.json
botocore/data/pricing/2017-10-15/paginators-1.json
botocore/data/pricing/2017-10-15/service-2.json
botocore/data/qldb-session/2019-07-11/paginators-1.json
@ -567,8 +605,10 @@ botocore/data/rekognition/2016-06-27/examples-1.json
botocore/data/rekognition/2016-06-27/paginators-1.json
botocore/data/rekognition/2016-06-27/service-2.json
botocore/data/rekognition/2016-06-27/waiters-2.json
botocore/data/resource-groups/2017-11-27/examples-1.json
botocore/data/resource-groups/2017-11-27/paginators-1.json
botocore/data/resource-groups/2017-11-27/service-2.json
botocore/data/resourcegroupstaggingapi/2017-01-26/examples-1.json
botocore/data/resourcegroupstaggingapi/2017-01-26/paginators-1.json
botocore/data/resourcegroupstaggingapi/2017-01-26/service-2.json
botocore/data/robomaker/2018-06-29/paginators-1.json
@ -577,6 +617,7 @@ botocore/data/route53/2013-04-01/examples-1.json
botocore/data/route53/2013-04-01/paginators-1.json
botocore/data/route53/2013-04-01/service-2.json
botocore/data/route53/2013-04-01/waiters-2.json
botocore/data/route53domains/2014-05-15/examples-1.json
botocore/data/route53domains/2014-05-15/paginators-1.json
botocore/data/route53domains/2014-05-15/service-2.json
botocore/data/route53resolver/2018-04-01/paginators-1.json
@ -589,8 +630,10 @@ botocore/data/s3control/2018-08-20/paginators-1.json
botocore/data/s3control/2018-08-20/service-2.json
botocore/data/sagemaker-a2i-runtime/2019-11-07/paginators-1.json
botocore/data/sagemaker-a2i-runtime/2019-11-07/service-2.json
botocore/data/sagemaker-runtime/2017-05-13/examples-1.json
botocore/data/sagemaker-runtime/2017-05-13/paginators-1.json
botocore/data/sagemaker-runtime/2017-05-13/service-2.json
botocore/data/sagemaker/2017-07-24/examples-1.json
botocore/data/sagemaker/2017-07-24/paginators-1.json
botocore/data/sagemaker/2017-07-24/service-2.json
botocore/data/sagemaker/2017-07-24/waiters-2.json
@ -601,6 +644,7 @@ botocore/data/schemas/2019-12-02/service-2.json
botocore/data/schemas/2019-12-02/waiters-2.json
botocore/data/sdb/2009-04-15/paginators-1.json
botocore/data/sdb/2009-04-15/service-2.json
botocore/data/secretsmanager/2017-10-17/examples-1.json
botocore/data/secretsmanager/2017-10-17/paginators-1.json
botocore/data/secretsmanager/2017-10-17/service-2.json
botocore/data/secretsmanager/2017-10-17/service-2.sdk-extras.json
@ -613,6 +657,7 @@ botocore/data/service-quotas/2019-06-24/service-2.json
botocore/data/servicecatalog/2015-12-10/examples-1.json
botocore/data/servicecatalog/2015-12-10/paginators-1.json
botocore/data/servicecatalog/2015-12-10/service-2.json
botocore/data/servicediscovery/2017-03-14/examples-1.json
botocore/data/servicediscovery/2017-03-14/paginators-1.json
botocore/data/servicediscovery/2017-03-14/service-2.json
botocore/data/ses/2010-12-01/examples-1.json
@ -624,6 +669,7 @@ botocore/data/sesv2/2019-09-27/service-2.json
botocore/data/shield/2016-06-02/examples-1.json
botocore/data/shield/2016-06-02/paginators-1.json
botocore/data/shield/2016-06-02/service-2.json
botocore/data/signer/2017-08-25/examples-1.json
botocore/data/signer/2017-08-25/paginators-1.json
botocore/data/signer/2017-08-25/service-2.json
botocore/data/signer/2017-08-25/waiters-2.json
@ -659,14 +705,19 @@ botocore/data/sts/2011-06-15/service-2.json
botocore/data/support/2013-04-15/examples-1.json
botocore/data/support/2013-04-15/paginators-1.json
botocore/data/support/2013-04-15/service-2.json
botocore/data/swf/2012-01-25/examples-1.json
botocore/data/swf/2012-01-25/paginators-1.json
botocore/data/swf/2012-01-25/service-2.json
botocore/data/synthetics/2017-10-11/paginators-1.json
botocore/data/synthetics/2017-10-11/service-2.json
botocore/data/textract/2018-06-27/paginators-1.json
botocore/data/textract/2018-06-27/service-2.json
botocore/data/transcribe/2017-10-26/examples-1.json
botocore/data/transcribe/2017-10-26/paginators-1.json
botocore/data/transcribe/2017-10-26/service-2.json
botocore/data/transfer/2018-11-05/paginators-1.json
botocore/data/transfer/2018-11-05/service-2.json
botocore/data/translate/2017-07-01/examples-1.json
botocore/data/translate/2017-07-01/paginators-1.json
botocore/data/translate/2017-07-01/service-2.json
botocore/data/waf-regional/2016-11-28/examples-1.json
@ -677,10 +728,12 @@ botocore/data/waf/2015-08-24/paginators-1.json
botocore/data/waf/2015-08-24/service-2.json
botocore/data/wafv2/2019-07-29/paginators-1.json
botocore/data/wafv2/2019-07-29/service-2.json
botocore/data/workdocs/2016-05-01/examples-1.json
botocore/data/workdocs/2016-05-01/paginators-1.json
botocore/data/workdocs/2016-05-01/service-2.json
botocore/data/worklink/2018-09-25/paginators-1.json
botocore/data/worklink/2018-09-25/service-2.json
botocore/data/workmail/2017-10-01/examples-1.json
botocore/data/workmail/2017-10-01/paginators-1.json
botocore/data/workmail/2017-10-01/service-2.json
botocore/data/workmailmessageflow/2019-05-01/paginators-1.json
@ -817,6 +870,7 @@ tests/functional/test_events.py
tests/functional/test_h2_required.py
tests/functional/test_history.py
tests/functional/test_iot_data.py
tests/functional/test_kinesis.py
tests/functional/test_lex.py
tests/functional/test_loaders.py
tests/functional/test_machinelearning.py
@ -881,7 +935,6 @@ tests/integration/test_ec2.py
tests/integration/test_elastictranscoder.py
tests/integration/test_emr.py
tests/integration/test_glacier.py
tests/integration/test_kinesis.py
tests/integration/test_loaders.py
tests/integration/test_rds.py
tests/integration/test_route53.py

View file

@ -16,7 +16,7 @@ import os
import re
import logging
__version__ = '1.15.26'
__version__ = '1.15.46'
class NullHandler(logging.Handler):

View file

@ -365,6 +365,7 @@
"createdAt",
"isPublic",
"resourceArn",
"resourceOwnerAccount",
"resourceType",
"updatedAt"
],
@ -393,6 +394,10 @@
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource that was analyzed.</p>"
},
"resourceOwnerAccount":{
"shape":"String",
"documentation":"<p>The AWS account ID that owns the resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the resource that was analyzed.</p>"
@ -416,6 +421,7 @@
"type":"structure",
"required":[
"resourceArn",
"resourceOwnerAccount",
"resourceType"
],
"members":{
@ -423,6 +429,10 @@
"shape":"ResourceArn",
"documentation":"<p>The ARN of the analyzed resource.</p>"
},
"resourceOwnerAccount":{
"shape":"String",
"documentation":"<p>The AWS account ID that owns the resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource that was analyzed.</p>"
@ -438,12 +448,22 @@
"type":"string",
"pattern":"^[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}$"
},
"AnalyzerStatus":{
"type":"string",
"enum":[
"ACTIVE",
"CREATING",
"DISABLED",
"FAILED"
]
},
"AnalyzerSummary":{
"type":"structure",
"required":[
"arn",
"createdAt",
"name",
"status",
"type"
],
"members":{
@ -467,6 +487,14 @@
"shape":"Name",
"documentation":"<p>The name of the analyzer.</p>"
},
"status":{
"shape":"AnalyzerStatus",
"documentation":"<p>The status of the analyzer. An <code>Active</code> analyzer successfully monitors supported resources and generates new findings. The analyzer is <code>Disabled</code> when a user action, such as removing trusted access for IAM Access Analyzer from AWS Organizations, causes the analyzer to stop generating new findings. The status is <code>Creating</code> when the analyzer creation is in progress and <code>Failed</code> when the analyzer creation has failed. </p>"
},
"statusReason":{
"shape":"StatusReason",
"documentation":"<p>The <code>statusReason</code> provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.</p>"
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>The tags added to the analyzer.</p>"
@ -702,6 +730,7 @@
"condition",
"createdAt",
"id",
"resourceOwnerAccount",
"resourceType",
"status",
"updatedAt"
@ -743,6 +772,10 @@
"shape":"String",
"documentation":"<p>The resource that an external principal has access to.</p>"
},
"resourceOwnerAccount":{
"shape":"String",
"documentation":"<p>The AWS account ID that owns the resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the resource reported in the finding.</p>"
@ -785,6 +818,7 @@
"condition",
"createdAt",
"id",
"resourceOwnerAccount",
"resourceType",
"status",
"updatedAt"
@ -826,6 +860,10 @@
"shape":"String",
"documentation":"<p>The resource that the external principal has access to.</p>"
},
"resourceOwnerAccount":{
"shape":"String",
"documentation":"<p>The AWS account ID that owns the resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the resource that the external principal has access to.</p>"
@ -1206,6 +1244,15 @@
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"ReasonCode":{
"type":"string",
"enum":[
"AWS_SERVICE_ACCESS_DISABLED",
"DELEGATED_ADMINISTRATOR_DEREGISTERED",
"ORGANIZATION_DELETED",
"SERVICE_LINKED_ROLE_CREATION_FAILED"
]
},
"ResourceArn":{
"type":"string",
"pattern":"arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$"
@ -1307,6 +1354,17 @@
},
"documentation":"<p>Starts a scan of the policies applied to the specified resource.</p>"
},
"StatusReason":{
"type":"structure",
"required":["code"],
"members":{
"code":{
"shape":"ReasonCode",
"documentation":"<p>The reason code for the current status of the analyzer.</p>"
}
},
"documentation":"<p>Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.</p>"
},
"String":{"type":"string"},
"TagKeys":{
"type":"list",
@ -1369,7 +1427,10 @@
"Token":{"type":"string"},
"Type":{
"type":"string",
"enum":["ACCOUNT"]
"enum":[
"ACCOUNT",
"ORGANIZATION"
]
},
"UntagResourceRequest":{
"type":"structure",

View file

@ -0,0 +1,5 @@
{
"version":"1.0",
"examples":{
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -1995,7 +1995,7 @@
},
"destinationArn":{
"shape":"String",
"documentation":"<p>The ARN of the CloudWatch Logs log group to receive access logs.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with <code>amazon-apigateway-</code>.</p>"
}
},
"documentation":"<p>Access log settings, including the access log format and access log destination ARN.</p>"
@ -2364,7 +2364,7 @@
},
"generateDistinctId":{
"shape":"Boolean",
"documentation":"<p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value.</p>"
"documentation":"<p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.</p>"
},
"value":{
"shape":"String",
@ -2461,7 +2461,7 @@
},
"stage":{
"shape":"String",
"documentation":"<p>The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.</p>"
"documentation":"<p>The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.</p>"
}
},
"documentation":"<p>Requests API Gateway to create a new <a>BasePathMapping</a> resource.</p>"
@ -2877,7 +2877,7 @@
},
"targetArns":{
"shape":"ListOfString",
"documentation":"<p>[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.</p>"
"documentation":"<p>[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.</p>"
},
"tags":{
"shape":"MapOfStringToString",
@ -4693,7 +4693,7 @@
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</p>",
"documentation":"<p>[Required] The ARN of a resource that can be tagged.</p>",
"location":"uri",
"locationName":"resource_arn"
},
@ -5321,7 +5321,7 @@
},
"loggingLevel":{
"shape":"String",
"documentation":"<p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>.</p>"
"documentation":"<p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>"
},
"dataTraceEnabled":{
"shape":"Boolean",
@ -6162,7 +6162,7 @@
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</p>",
"documentation":"<p>[Required] The ARN of a resource that can be tagged.</p>",
"location":"uri",
"locationName":"resource_arn"
},
@ -6408,7 +6408,7 @@
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.</p>",
"documentation":"<p>[Required] The ARN of a resource that can be tagged.</p>",
"location":"uri",
"locationName":"resource_arn"
},
@ -7090,7 +7090,7 @@
},
"targetArns":{
"shape":"ListOfString",
"documentation":"<p>The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.</p>"
"documentation":"<p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.</p>"
},
"status":{
"shape":"VpcLinkStatus",
@ -7105,7 +7105,7 @@
"documentation":"<p>The collection of tags. Each tag element is associated with a given resource.</p>"
}
},
"documentation":"<p>A API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integration has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p> </div>"
"documentation":"<p>An API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integration has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p> </div>"
},
"VpcLinkStatus":{
"type":"string",

View file

@ -667,6 +667,31 @@
} ],
"documentation" : "<p>Deletes a VPC link.</p>"
},
"ExportApi" : {
"name" : "ExportApi",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/exports/{specification}",
"responseCode" : 200
},
"input" : {
"shape" : "ExportApiRequest"
},
"output" : {
"shape" : "ExportApiResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ]
},
"GetApi" : {
"name" : "GetApi",
"http" : {
@ -2735,7 +2760,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -2763,9 +2788,9 @@
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfigInput",
@ -2823,7 +2848,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -2851,9 +2876,9 @@
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfigInput",
@ -2920,7 +2945,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -2948,9 +2973,9 @@
"documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfig",
@ -4215,6 +4240,63 @@
"documentation" : "<p>Represents an endpoint type.</p>",
"enum" : [ "REGIONAL", "EDGE" ]
},
"ExportApiRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ExportVersion" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "exportVersion",
"documentation" : "<p>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</p>"
},
"IncludeExtensions" : {
"shape" : "__boolean",
"location" : "querystring",
"locationName" : "includeExtensions",
"documentation" : "<p>Specifies whether to include <a href=\"https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html\">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</p>"
},
"OutputType" : {
"shape" : "__string",
"enum" : ["YAML", "JSON"],
"location" : "querystring",
"locationName" : "outputType",
"documentation" : "<p>The output type of the exported definition file. Valid values are JSON and YAML.</p>"
},
"Specification" : {
"shape" : "__string",
"enum" : ["OAS30"],
"location" : "uri",
"locationName" : "specification",
"documentation" : "<p>The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.</p>"
},
"StageName" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "stageName",
"documentation" : "<p>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</p>"
}
},
"required" : [ "Specification", "OutputType", "ApiId" ]
},
"ExportApiResponse" : {
"type" : "structure",
"members" : {
"body":{
"shape":"ExportedApi"
}
},
"payload":"body"
},
"ExportedApi":{
"type":"blob",
"documentation" : "<p>Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.</p>"
},
"GetApiMappingRequest" : {
"type" : "structure",
"members" : {
@ -4758,7 +4840,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -4786,9 +4868,9 @@
"documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfig",
@ -5558,7 +5640,7 @@
"shape" : "__string",
"location" : "querystring",
"locationName" : "basepath",
"documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"
"documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"
},
"Body" : {
"shape" : "__string",
@ -5569,7 +5651,7 @@
"shape" : "__boolean",
"location" : "querystring",
"locationName" : "failOnWarnings",
"documentation" : "<p>Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.</p>"
"documentation" : "<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>"
}
},
"documentation" : "<p></p>",
@ -5656,11 +5738,11 @@
"min" : 0,
"max" : 3600
},
"IntegerWithLengthBetween50And29000" : {
"IntegerWithLengthBetween50And30000" : {
"type" : "integer",
"documentation" : "<p>An integer with a value between [50-29000].</p>",
"documentation" : "<p>An integer with a value between [50-30000].</p>",
"min" : 50,
"max" : 29000
"max" : 30000
},
"IntegerWithLengthBetweenMinus1And86400" : {
"type" : "integer",
@ -5724,7 +5806,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -5752,9 +5834,9 @@
"documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfig",
@ -6003,7 +6085,7 @@
"shape" : "__string",
"location" : "querystring",
"locationName" : "basepath",
"documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"
"documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"
},
"Body" : {
"shape" : "__string",
@ -6014,7 +6096,7 @@
"shape" : "__boolean",
"location" : "querystring",
"locationName" : "failOnWarnings",
"documentation" : "<p>Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.</p>"
"documentation" : "<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>"
}
},
"documentation" : "<p></p>",
@ -7176,7 +7258,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -7204,9 +7286,9 @@
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfigInput",
@ -7269,7 +7351,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -7297,9 +7379,9 @@
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfigInput",
@ -7366,7 +7448,7 @@
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
@ -7394,9 +7476,9 @@
"documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"shape" : "IntegerWithLengthBetween50And30000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>"
},
"TlsConfig" : {
"shape" : "TlsConfig",

View file

@ -889,6 +889,10 @@
"shape":"DeploymentState",
"documentation":"<p>The state of the deployment.</p>"
},
"EventLog":{
"shape":"DeploymentEvents",
"documentation":"<p>A list containing all events related to a deployment. The most recent events are displayed first.</p>"
},
"PercentageComplete":{
"shape":"Percentage",
"documentation":"<p>The percentage of targets for which the deployment is available.</p>"
@ -903,6 +907,43 @@
}
}
},
"DeploymentEvent":{
"type":"structure",
"members":{
"EventType":{
"shape":"DeploymentEventType",
"documentation":"<p>The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.</p>"
},
"TriggeredBy":{
"shape":"TriggeredBy",
"documentation":"<p>The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.</p>"
},
"OccurredAt":{
"shape":"Iso8601DateTime",
"documentation":"<p>The date and time the event occurred.</p>"
}
},
"documentation":"<p>An object that describes a deployment event.</p>"
},
"DeploymentEventType":{
"type":"string",
"enum":[
"PERCENTAGE_UPDATED",
"ROLLBACK_STARTED",
"ROLLBACK_COMPLETED",
"BAKE_TIME_STARTED",
"DEPLOYMENT_STARTED",
"DEPLOYMENT_COMPLETED"
]
},
"DeploymentEvents":{
"type":"list",
"member":{"shape":"DeploymentEvent"}
},
"DeploymentList":{
"type":"list",
"member":{"shape":"DeploymentSummary"}
@ -1594,6 +1635,15 @@
"type":"string",
"max":256
},
"TriggeredBy":{
"type":"string",
"enum":[
"USER",
"APPCONFIG",
"CLOUDWATCH_ALARM",
"INTERNAL_ERROR"
]
},
"UntagResourceRequest":{
"type":"structure",
"required":[

View file

@ -27,7 +27,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Deletes the specified scaling policy for an Application Auto Scaling scalable target.</p> <p>Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#delete-step-scaling-policy\">Delete a Step Scaling Policy</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html#delete-target-tracking-policy\">Delete a Target Tracking Scaling Policy</a> in the <i>Application Auto Scaling User Guide</i>.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
"documentation":"<p>Deletes the specified scaling policy for an Application Auto Scaling scalable target.</p> <p>Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#delete-step-scaling-policy\">Delete a Step Scaling Policy</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html#delete-target-tracking-policy\">Delete a Target Tracking Scaling Policy</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"DeleteScheduledAction":{
"name":"DeleteScheduledAction",
@ -59,7 +59,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Deregisters an Application Auto Scaling scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. </p>"
"documentation":"<p>Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html\">DescribeScalableTargets</a>. </p> <note> <p>Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.</p> </note>"
},
"DescribeScalableTargets":{
"name":"DescribeScalableTargets",
@ -75,7 +75,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Gets information about the scalable targets in the specified namespace.</p> <p>You can filter the results using <code>ResourceIds</code> and <code>ScalableDimension</code>.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
"documentation":"<p>Gets information about the scalable targets in the specified namespace.</p> <p>You can filter the results using <code>ResourceIds</code> and <code>ScalableDimension</code>.</p>"
},
"DescribeScalingActivities":{
"name":"DescribeScalingActivities",
@ -91,7 +91,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using <code>ResourceId</code> and <code>ScalableDimension</code>.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>"
"documentation":"<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using <code>ResourceId</code> and <code>ScalableDimension</code>.</p>"
},
"DescribeScalingPolicies":{
"name":"DescribeScalingPolicies",
@ -108,7 +108,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Describes the Application Auto Scaling scaling policies for the specified service namespace.</p> <p>You can filter the results using <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code>.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>"
"documentation":"<p>Describes the Application Auto Scaling scaling policies for the specified service namespace.</p> <p>You can filter the results using <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"DescribeScheduledActions":{
"name":"DescribeScheduledActions",
@ -124,7 +124,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Describes the Application Auto Scaling scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>To create a scheduled action or update an existing one, see <a>PutScheduledAction</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>"
"documentation":"<p>Describes the Application Auto Scaling scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html\">Scheduled Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
@ -142,7 +142,7 @@
{"shape":"FailedResourceAccessException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates or updates a policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.</p> <p>You can view the scaling policies for a service namespace using <a>DescribeScalingPolicies</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p> <p>Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. </p> <p>Learn more about how to work with scaling policies in the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
"documentation":"<p>Creates or updates a scaling policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.</p> <p>Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies</a> in the <i>Application Auto Scaling User Guide</i>.</p> <note> <p>If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.</p> </note>"
},
"PutScheduledAction":{
"name":"PutScheduledAction",
@ -159,7 +159,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates or updates a scheduled action for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using <a>RegisterScalableTarget</a>. </p> <p>To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.</p> <p>You can view the scheduled actions using <a>DescribeScheduledActions</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p> <p>Learn more about how to work with scheduled actions in the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
"documentation":"<p>Creates or updates a scheduled action for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.</p> <p>When start and end times are specified with a recurring schedule using a cron expression or rates, they form the boundaries of when the recurring action starts and stops.</p> <p>To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html\">Scheduled Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p> <note> <p>If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.</p> </note>"
},
"RegisterScalableTarget":{
"name":"RegisterScalableTarget",
@ -175,7 +175,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace. </p> <p>When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling will not scale capacity to values that are outside of this range. </p> <p>To update a scalable target, specify the parameter that you want to change as well as the following parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. </p> <p>After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use <a>DescribeScalableTargets</a>. You can also view the scaling policies for a service namespace by using <a>DescribeScalableTargets</a>. </p> <p>If you no longer need a scalable target, you can deregister it by using <a>DeregisterScalableTarget</a>.</p>"
"documentation":"<p>Registers or updates a scalable target. </p> <p>A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace. </p> <p>When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.</p> <p>After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html\">DescribeScalableTargets</a>. You can also view the scaling policies for a service namespace by using <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html\">DescribeScalableTargets</a>. If you no longer need a scalable target, you can deregister it by using <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DeregisterScalableTarget.html\">DeregisterScalableTarget</a>.</p> <p>To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request. </p>"
}
},
"shapes":{
@ -247,7 +247,7 @@
"documentation":"<p>The unit of the metric.</p>"
}
},
"documentation":"<p>Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.</p> <p>To create your customized metric specification:</p> <ul> <li> <p>Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publish Custom Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> </li> <li> <p>Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases. </p> </li> </ul> <p>For more information about CloudWatch, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch Concepts</a>. </p>"
"documentation":"<p>Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.</p> <p>For information about the available metrics for a service, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html\">AWS Services That Publish CloudWatch Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>To create your customized metric specification:</p> <ul> <li> <p>Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publish Custom Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> </li> <li> <p>Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases. </p> </li> </ul> <p>For more information about CloudWatch, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch Concepts</a>. </p>"
},
"DeleteScalingPolicyRequest":{
"type":"structure",
@ -264,15 +264,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
}
}
},
@ -292,7 +292,7 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ScheduledActionName":{
"shape":"ResourceIdMaxLen1600",
@ -300,11 +300,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
}
}
},
@ -323,15 +323,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
}
}
},
@ -346,15 +346,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceIds":{
"shape":"ResourceIdsMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -385,15 +385,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -428,15 +428,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -471,15 +471,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -600,7 +600,9 @@
"ECSServiceAverageMemoryUtilization",
"AppStreamAverageCapacityUtilization",
"ComprehendInferenceUtilization",
"LambdaProvisionedConcurrencyUtilization"
"LambdaProvisionedConcurrencyUtilization",
"CassandraReadCapacityUtilization",
"CassandraWriteCapacityUtilization"
]
},
"MetricUnit":{"type":"string"},
@ -639,7 +641,7 @@
"documentation":"<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Spot Fleet request or ECS service.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
}
},
"documentation":"<p>Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.</p>"
"documentation":"<p>Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.</p> <p>Only the AWS services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html\">Building Dashboards with CloudWatch</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"PutScalingPolicyRequest":{
"type":"structure",
@ -656,19 +658,19 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"PolicyType":{
"shape":"PolicyType",
"documentation":"<p>The policy type. This parameter is required if you are creating a scaling policy.</p> <p>The following policy types are supported: </p> <p> <code>TargetTrackingScaling</code>—Not supported for Amazon EMR</p> <p> <code>StepScaling</code>—Not supported for DynamoDB, Amazon Comprehend, or AWS Lambda</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The policy type. This parameter is required if you are creating a scaling policy.</p> <p>The following policy types are supported: </p> <p> <code>TargetTrackingScaling</code>—Not supported for Amazon EMR</p> <p> <code>StepScaling</code>—Not supported for DynamoDB, Amazon Comprehend, Lambda, or Amazon Keyspaces for Apache Cassandra.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"StepScalingPolicyConfiguration":{
"shape":"StepScalingPolicyConfiguration",
@ -705,35 +707,35 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"Schedule":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - \"<code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code>\"</p> </li> <li> <p>Rate expressions - \"<code>rate(<i>value</i> <i>unit</i>)</code>\"</p> </li> <li> <p>Cron expressions - \"<code>cron(<i>fields</i>)</code>\"</p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>"
"documentation":"<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - \"<code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code>\"</p> </li> <li> <p>Rate expressions - \"<code>rate(<i>value</i> <i>unit</i>)</code>\"</p> </li> <li> <p>Cron expressions - \"<code>cron(<i>fields</i>)</code>\"</p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> <p>For examples of using these expressions, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html\">Scheduled Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"ScheduledActionName":{
"shape":"ScheduledActionName",
"documentation":"<p>The name of the scheduled action.</p>"
"documentation":"<p>The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target. </p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"StartTime":{
"shape":"TimestampType",
"documentation":"<p>The date and time for the scheduled action to start.</p>"
"documentation":"<p>The date and time for this scheduled action to start.</p>"
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The date and time for the scheduled action to end.</p>"
"documentation":"<p>The date and time for the recurring schedule to end.</p>"
},
"ScalableTargetAction":{
"shape":"ScalableTargetAction",
"documentation":"<p>The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>"
"documentation":"<p>The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>"
}
}
},
@ -752,27 +754,27 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>. </p>"
"documentation":"<p>The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use <code>custom-resource</code> instead.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"MinCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The minimum value to scale to in response to a scale-in event. <code>MinCapacity</code> is required to register a scalable target.</p>"
"documentation":"<p>The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. </p> <p>This parameter is required if you are registering a scalable target. For Lambda provisioned concurrency, the minimum value allowed is 0. For all other resources, the minimum value allowed is 1.</p>"
},
"MaxCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The maximum value to scale to in response to a scale-out event. <code>MaxCapacity</code> is required to register a scalable target.</p>"
"documentation":"<p>The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. </p> <p>This parameter is required if you are registering a scalable target.</p>"
},
"RoleARN":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For Amazon EMR, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>"
"documentation":"<p>This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. </p> <p>If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles\">Application Auto Scaling IAM Roles</a>.</p>"
},
"SuspendedState":{
"shape":"SuspendedState",
@ -820,7 +822,9 @@
"sagemaker:variant:DesiredInstanceCount",
"custom-resource:ResourceType:Property",
"comprehend:document-classifier-endpoint:DesiredInferenceUnits",
"lambda:function:ProvisionedConcurrency"
"lambda:function:ProvisionedConcurrency",
"cassandra:table:ReadCapacityUnits",
"cassandra:table:WriteCapacityUnits"
]
},
"ScalableTarget":{
@ -837,15 +841,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource, or a <code>custom-resource</code>.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"MinCapacity":{
"shape":"ResourceCapacity",
@ -872,7 +876,7 @@
"members":{
"MinCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The minimum capacity.</p>"
"documentation":"<p>The minimum capacity.</p> <p>For Lambda provisioned concurrency, the minimum value allowed is 0. For all other resources, the minimum value allowed is 1.</p>"
},
"MaxCapacity":{
"shape":"ResourceCapacity",
@ -908,15 +912,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource, or a <code>custom-resource</code>.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"Description":{
"shape":"XmlString",
@ -987,15 +991,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource, or a <code>custom-resource</code>.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"PolicyType":{
"shape":"PolicyType",
@ -1042,19 +1046,19 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource, or a <code>custom-resource</code>.</p>"
},
"Schedule":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - \"<code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code>\"</p> </li> <li> <p>Rate expressions - \"<code>rate(<i>value</i> <i>unit</i>)</code>\"</p> </li> <li> <p>Cron expressions - \"<code>cron(<i>fields</i>)</code>\"</p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>"
"documentation":"<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - \"<code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code>\"</p> </li> <li> <p>Rate expressions - \"<code>rate(<i>value</i> <i>unit</i>)</code>\"</p> </li> <li> <p>Cron expressions - \"<code>cron(<i>fields</i>)</code>\"</p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> <p>For examples of using these expressions, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html\">Scheduled Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the index name. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variant - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> <li> <p>Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: <code>arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE</code>.</p> </li> <li> <p>Lambda provisioned concurrency - The resource type is <code>function</code> and the unique identifier is the function name with a function version or alias name suffix that is not <code>$LATEST</code>. Example: <code>function:my-function:prod</code> or <code>function:my-function:1</code>.</p> </li> <li> <p>Amazon Keyspaces table - The resource type is <code>table</code> and the unique identifier is the table name. Example: <code>keyspace/mykeyspace/table/mytable</code>.</p> </li> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> </ul>"
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> <li> <p> <code>comprehend:document-classifier-endpoint:DesiredInferenceUnits</code> - The number of inference units for an Amazon Comprehend document classification endpoint.</p> </li> <li> <p> <code>lambda:function:ProvisionedConcurrency</code> - The provisioned concurrency for a Lambda function.</p> </li> <li> <p> <code>cassandra:table:ReadCapacityUnits</code> - The provisioned read capacity for an Amazon Keyspaces table.</p> </li> <li> <p> <code>cassandra:table:WriteCapacityUnits</code> - The provisioned write capacity for an Amazon Keyspaces table.</p> </li> </ul>"
},
"StartTime":{
"shape":"TimestampType",
@ -1066,7 +1070,7 @@
},
"ScalableTargetAction":{
"shape":"ScalableTargetAction",
"documentation":"<p>The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>"
"documentation":"<p>The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>"
},
"CreationTime":{
"shape":"TimestampType",
@ -1097,7 +1101,8 @@
"sagemaker",
"custom-resource",
"comprehend",
"lambda"
"lambda",
"cassandra"
]
},
"StepAdjustment":{
@ -1114,10 +1119,10 @@
},
"ScalingAdjustment":{
"shape":"ScalingAdjustment",
"documentation":"<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.</p>"
"documentation":"<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. </p>"
}
},
"documentation":"<p>Represents a step adjustment for a <a>StepScalingPolicyConfiguration</a>. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. </p> <p>For the following examples, suppose that you have an alarm with a breach threshold of 50:</p> <ul> <li> <p>To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.</p> </li> <li> <p>To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.</p> </li> </ul> <p>There are a few rules for the step adjustments for your step policy:</p> <ul> <li> <p>The ranges of your step adjustments can't overlap or have a gap.</p> </li> <li> <p>At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.</p> </li> <li> <p>At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.</p> </li> <li> <p>The upper and lower bound can't be null in the same step adjustment.</p> </li> </ul>"
"documentation":"<p>Represents a step adjustment for a <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html\">StepScalingPolicyConfiguration</a>. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. </p> <p>For the following examples, suppose that you have an alarm with a breach threshold of 50:</p> <ul> <li> <p>To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.</p> </li> <li> <p>To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.</p> </li> </ul> <p>There are a few rules for the step adjustments for your step policy:</p> <ul> <li> <p>The ranges of your step adjustments can't overlap or have a gap.</p> </li> <li> <p>At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.</p> </li> <li> <p>At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.</p> </li> <li> <p>The upper and lower bound can't be null in the same step adjustment.</p> </li> </ul>"
},
"StepAdjustments":{
"type":"list",
@ -1128,19 +1133,19 @@
"members":{
"AdjustmentType":{
"shape":"AdjustmentType",
"documentation":"<p>Specifies whether the <code>ScalingAdjustment</code> value in a <a>StepAdjustment</a> is an absolute number or a percentage of the current capacity. </p>"
"documentation":"<p>Specifies whether the <code>ScalingAdjustment</code> value in a <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html\">StepAdjustment</a> is an absolute number or a percentage of the current capacity. </p> <p> <code>AdjustmentType</code> is required if you are adding a new step scaling policy configuration.</p>"
},
"StepAdjustments":{
"shape":"StepAdjustments",
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p>"
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p> <p>At least one step adjustment is required if you are adding a new step scaling policy configuration.</p>"
},
"MinAdjustmentMagnitude":{
"shape":"MinAdjustmentMagnitude",
"documentation":"<p>The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is <code>PercentChangeInCapacity</code>, the scaling policy changes the scalable dimension of the scalable target by this amount.</p> <p>For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a <code>MinAdjustmentMagnitude</code> of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a <code>MinAdjustmentMagnitude</code> of 2, Application Auto Scaling scales out the service by 2 tasks.</p>"
"documentation":"<p>The minimum value to scale by when scaling by percentages. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a <code>MinAdjustmentMagnitude</code> of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a <code>MinAdjustmentMagnitude</code> of 2, Application Auto Scaling scales out the service by 2 tasks.</p> <p>Valid only if the adjustment type is <code>PercentChangeInCapacity</code>. </p>"
},
"Cooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out action are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p> <p>Application Auto Scaling provides a default value of 300 for the following scalable targets:</p> <ul> <li> <p>ECS services</p> </li> <li> <p>Spot Fleet requests</p> </li> <li> <p>EMR clusters</p> </li> <li> <p>AppStream 2.0 fleets</p> </li> <li> <p>Aurora DB clusters</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources</p> </li> </ul> <p>For all other scalable targets, the default value is 0:</p> <ul> <li> <p>DynamoDB tables</p> </li> <li> <p>DynamoDB global secondary indexes</p> </li> <li> <p>Amazon Comprehend document classification endpoints</p> </li> <li> <p>Lambda provisioned concurrency</p> </li> <li> <p>Amazon Keyspaces tables</p> </li> </ul>"
},
"MetricAggregationType":{
"shape":"MetricAggregationType",
@ -1185,15 +1190,15 @@
},
"ScaleOutCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>"
"documentation":"<p>The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p> <p>Application Auto Scaling provides a default value of 300 for the following scalable targets:</p> <ul> <li> <p>ECS services</p> </li> <li> <p>Spot Fleet requests</p> </li> <li> <p>EMR clusters</p> </li> <li> <p>AppStream 2.0 fleets</p> </li> <li> <p>Aurora DB clusters</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources</p> </li> </ul> <p>For all other scalable targets, the default value is 0:</p> <ul> <li> <p>DynamoDB tables</p> </li> <li> <p>DynamoDB global secondary indexes</p> </li> <li> <p>Amazon Comprehend document classification endpoints</p> </li> <li> <p>Lambda provisioned concurrency</p> </li> <li> <p>Amazon Keyspaces tables</p> </li> </ul>"
},
"ScaleInCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
"documentation":"<p>The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p> <p>Application Auto Scaling provides a default value of 300 for the following scalable targets:</p> <ul> <li> <p>ECS services</p> </li> <li> <p>Spot Fleet requests</p> </li> <li> <p>EMR clusters</p> </li> <li> <p>AppStream 2.0 fleets</p> </li> <li> <p>Aurora DB clusters</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources</p> </li> </ul> <p>For all other scalable targets, the default value is 0:</p> <ul> <li> <p>DynamoDB tables</p> </li> <li> <p>DynamoDB global secondary indexes</p> </li> <li> <p>Amazon Comprehend document classification endpoints</p> </li> <li> <p>Lambda provisioned concurrency</p> </li> <li> <p>Amazon Keyspaces tables</p> </li> </ul>"
},
"DisableScaleIn":{
"shape":"DisableScaleIn",
"documentation":"<p>Indicates whether scale in by the target tracking scaling policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is <code>false</code>.</p>"
"documentation":"<p>Indicates whether scale in by the target tracking scaling policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is <code>false</code>.</p>"
}
},
"documentation":"<p>Represents a target tracking scaling policy configuration to use with Application Auto Scaling.</p>"
@ -1212,5 +1217,5 @@
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
},
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for the following resources:</p> <ul> <li> <p>Amazon ECS services</p> </li> <li> <p>Amazon EC2 Spot Fleet requests</p> </li> <li> <p>Amazon EMR clusters</p> </li> <li> <p>Amazon AppStream 2.0 fleets</p> </li> <li> <p>Amazon DynamoDB tables and global secondary indexes throughput capacity</p> </li> <li> <p>Amazon Aurora Replicas</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources provided by your own applications or services</p> </li> <li> <p>Amazon Comprehend document classification endpoints</p> </li> <li> <p>AWS Lambda function provisioned concurrency</p> </li> </ul> <p> <b>API Summary</b> </p> <p>The Application Auto Scaling service API includes three key sets of actions: </p> <ul> <li> <p>Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.</p> </li> <li> <p>Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.</p> </li> <li> <p>Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the <a>RegisterScalableTarget</a> action for any Application Auto Scaling scalable target. You can suspend and resume, individually or in combination, scale-out activities triggered by a scaling policy, scale-in activities triggered by a scaling policy, and scheduled scaling. </p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for the following resources:</p> <ul> <li> <p>Amazon ECS services</p> </li> <li> <p>Amazon EC2 Spot Fleet requests</p> </li> <li> <p>Amazon EMR clusters</p> </li> <li> <p>Amazon AppStream 2.0 fleets</p> </li> <li> <p>Amazon DynamoDB tables and global secondary indexes throughput capacity</p> </li> <li> <p>Amazon Aurora Replicas</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources provided by your own applications or services</p> </li> <li> <p>Amazon Comprehend document classification endpoints</p> </li> <li> <p>AWS Lambda function provisioned concurrency</p> </li> <li> <p>Amazon Keyspaces for Apache Cassandra tables</p> </li> </ul> <p> <b>API Summary</b> </p> <p>The Application Auto Scaling service API includes three key sets of actions: </p> <ul> <li> <p>Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.</p> </li> <li> <p>Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.</p> </li> <li> <p>Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the <a href=\"https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html\">RegisterScalableTarget</a> API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.</p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
}

View file

@ -477,6 +477,10 @@
"shape":"OpsCenterEnabled",
"documentation":"<p> Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application. </p>"
},
"CWEMonitorEnabled":{
"shape":"CWEMonitorEnabled",
"documentation":"<p> Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as <code>instance terminated</code>, <code>failed deployment</code>, and others. </p>"
},
"Remarks":{
"shape":"Remarks",
"documentation":"<p>The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:</p> <ul> <li> <p>“Configuring application, detected 1 Errors, 3 Warnings”</p> </li> <li> <p>“Configuring application, detected 1 Unconfigured Components”</p> </li> </ul>"
@ -496,6 +500,22 @@
"documentation":"<p>The request is not understood by the server.</p>",
"exception":true
},
"CWEMonitorEnabled":{"type":"boolean"},
"CloudWatchEventDetailType":{"type":"string"},
"CloudWatchEventId":{"type":"string"},
"CloudWatchEventSource":{
"type":"string",
"enum":[
"EC2",
"CODE_DEPLOY",
"HEALTH"
]
},
"CodeDeployApplication":{"type":"string"},
"CodeDeployDeploymentGroup":{"type":"string"},
"CodeDeployDeploymentId":{"type":"string"},
"CodeDeployInstanceGroupId":{"type":"string"},
"CodeDeployState":{"type":"string"},
"ComponentConfiguration":{
"type":"string",
"max":10000,
@ -568,6 +588,10 @@
"shape":"OpsCenterEnabled",
"documentation":"<p> When set to <code>true</code>, creates opsItems for any problems detected on an application. </p>"
},
"CWEMonitorEnabled":{
"shape":"CWEMonitorEnabled",
"documentation":"<p> Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as <code>instance terminated</code>, <code>failed deployment</code>, and others. </p>"
},
"OpsItemSNSTopicArn":{
"shape":"OpsItemSNSTopicArn",
"documentation":"<p> The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem. </p>"
@ -926,6 +950,7 @@
}
}
},
"Ec2State":{"type":"string"},
"EndTime":{"type":"timestamp"},
"ErrorMsg":{"type":"string"},
"ExceptionMessage":{"type":"string"},
@ -947,6 +972,11 @@
"NOT_USEFUL"
]
},
"HealthEventArn":{"type":"string"},
"HealthEventDescription":{"type":"string"},
"HealthEventTypeCategory":{"type":"string"},
"HealthEventTypeCode":{"type":"string"},
"HealthService":{"type":"string"},
"Insights":{"type":"string"},
"InternalServerException":{
"type":"structure",
@ -1309,6 +1339,90 @@
"Value":{
"shape":"Value",
"documentation":"<p>The value of the source observation metric.</p>"
},
"CloudWatchEventId":{
"shape":"CloudWatchEventId",
"documentation":"<p> The ID of the CloudWatch Event-based observation related to the detected problem. </p>"
},
"CloudWatchEventSource":{
"shape":"CloudWatchEventSource",
"documentation":"<p> The source of the CloudWatch Event. </p>"
},
"CloudWatchEventDetailType":{
"shape":"CloudWatchEventDetailType",
"documentation":"<p> The detail type of the CloudWatch Event-based observation, for example, <code>EC2 Instance State-change Notification</code>. </p>"
},
"HealthEventArn":{
"shape":"HealthEventArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the AWS Health Event-based observation.</p>"
},
"HealthService":{
"shape":"HealthService",
"documentation":"<p> The service to which the AWS Health Event belongs, such as EC2. </p>"
},
"HealthEventTypeCode":{
"shape":"HealthEventTypeCode",
"documentation":"<p> The type of the AWS Health event, for example, <code>AWS_EC2_POWER_CONNECTIVITY_ISSUE</code>. </p>"
},
"HealthEventTypeCategory":{
"shape":"HealthEventTypeCategory",
"documentation":"<p> The category of the AWS Health event, such as <code>issue</code>. </p>"
},
"HealthEventDescription":{
"shape":"HealthEventDescription",
"documentation":"<p> The description of the AWS Health event provided by the service, such as Amazon EC2. </p>"
},
"CodeDeployDeploymentId":{
"shape":"CodeDeployDeploymentId",
"documentation":"<p> The deployment ID of the CodeDeploy-based observation related to the detected problem. </p>"
},
"CodeDeployDeploymentGroup":{
"shape":"CodeDeployDeploymentGroup",
"documentation":"<p> The deployment group to which the CodeDeploy deployment belongs. </p>"
},
"CodeDeployState":{
"shape":"CodeDeployState",
"documentation":"<p> The status of the CodeDeploy deployment, for example <code>SUCCESS</code> or <code> FAILURE</code>. </p>"
},
"CodeDeployApplication":{
"shape":"CodeDeployApplication",
"documentation":"<p> The CodeDeploy application to which the deployment belongs. </p>"
},
"CodeDeployInstanceGroupId":{
"shape":"CodeDeployInstanceGroupId",
"documentation":"<p> The instance group to which the CodeDeploy instance belongs. </p>"
},
"Ec2State":{
"shape":"Ec2State",
"documentation":"<p> The state of the instance, such as <code>STOPPING</code> or <code>TERMINATING</code>. </p>"
},
"XRayFaultPercent":{
"shape":"XRayFaultPercent",
"documentation":"<p> The X-Ray request fault percentage for this node. </p>"
},
"XRayThrottlePercent":{
"shape":"XRayThrottlePercent",
"documentation":"<p> The X-Ray request throttle percentage for this node. </p>"
},
"XRayErrorPercent":{
"shape":"XRayErrorPercent",
"documentation":"<p> The X-Ray request error percentage for this node. </p>"
},
"XRayRequestCount":{
"shape":"XRayRequestCount",
"documentation":"<p> The X-Ray request count for this node. </p>"
},
"XRayRequestAverageLatency":{
"shape":"XRayRequestAverageLatency",
"documentation":"<p> The X-Ray node request average latency for this node. </p>"
},
"XRayNodeName":{
"shape":"XRayNodeName",
"documentation":"<p> The name of the X-Ray node. </p>"
},
"XRayNodeType":{
"shape":"XRayNodeType",
"documentation":"<p> The type of the X-Ray node. </p>"
}
},
"documentation":"<p>Describes an anomaly or error with the application.</p>"
@ -1579,6 +1693,10 @@
"shape":"OpsCenterEnabled",
"documentation":"<p> When set to <code>true</code>, creates opsItems for any problems detected on an application. </p>"
},
"CWEMonitorEnabled":{
"shape":"CWEMonitorEnabled",
"documentation":"<p> Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as <code>instance terminated</code>, <code>failed deployment</code>, and others. </p>"
},
"OpsItemSNSTopicArn":{
"shape":"OpsItemSNSTopicArn",
"documentation":"<p> The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.</p>"
@ -1713,7 +1831,14 @@
"documentation":"<p>The parameter is not valid.</p>",
"exception":true
},
"Value":{"type":"double"}
"Value":{"type":"double"},
"XRayErrorPercent":{"type":"integer"},
"XRayFaultPercent":{"type":"integer"},
"XRayNodeName":{"type":"string"},
"XRayNodeType":{"type":"string"},
"XRayRequestAverageLatency":{"type":"long"},
"XRayRequestCount":{"type":"integer"},
"XRayThrottlePercent":{"type":"integer"}
},
"documentation":"<fullname>Amazon CloudWatch Application Insights for .NET and SQL Server</fullname> <p> Amazon CloudWatch Application Insights for .NET and SQL Server is a service that helps you detect common problems with your .NET and SQL Server-based applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.</p> <p>After you onboard your application, CloudWatch Application Insights for .NET and SQL Server identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors. </p>"
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -167,7 +167,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
"documentation":"<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
},
"ListQueryExecutions":{
"name":"ListQueryExecutions",
@ -181,7 +181,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
"documentation":"<p>Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -694,7 +694,7 @@
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup from which the named queries are being returned.</p>"
"documentation":"<p>The name of the workgroup from which the named queries are returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.</p>"
}
}
},
@ -724,7 +724,7 @@
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup from which queries are being returned.</p>"
"documentation":"<p>The name of the workgroup from which queries are returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.</p>"
}
}
},
@ -908,7 +908,7 @@
},
"Statistics":{
"shape":"QueryExecutionStatistics",
"documentation":"<p>The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.</p>"
"documentation":"<p>Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
@ -987,7 +987,7 @@
"members":{
"State":{
"shape":"QueryExecutionState",
"documentation":"<p>The state of query execution. <code>QUEUED</code> state is listed but is not used by Athena and is reserved for future use. <code>RUNNING</code> indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. <code>SUCCEEDED</code> indicates that the query completed without errors. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that a user input interrupted query execution. </p>"
"documentation":"<p>The state of query execution. <code>QUEUED</code> indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. <code>RUNNING</code> indicates that the query is in execution phase. <code>SUCCEEDED</code> indicates that the query completed without errors. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that a user input interrupted query execution. </p>"
},
"StateChangeReason":{
"shape":"String",

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -410,7 +410,8 @@
"HealthStatus": "Healthy",
"InstanceId": "i-4ba0837f",
"LaunchConfigurationName": "my-launch-config",
"LifecycleState": "InService"
"LifecycleState": "InService",
"ProtectedFromScaleIn": false
}
],
"LaunchConfigurationName": "my-launch-config",

View file

@ -124,7 +124,7 @@
}
],
"jobQueueName": "LowPriority",
"priority": 10,
"priority": 1,
"state": "ENABLED"
},
"output": {
@ -154,7 +154,7 @@
}
],
"jobQueueName": "HighPriority",
"priority": 1,
"priority": 10,
"state": "ENABLED"
},
"output": {

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -26,7 +26,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Creates a new Cost Category with the requested name and rules.</p>"
"documentation":"<p>Creates a new Cost Category with the requested name and rules.</p>"
},
"DeleteCostCategoryDefinition":{
"name":"DeleteCostCategoryDefinition",
@ -40,7 +40,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.</p>"
"documentation":"<p>Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.</p>"
},
"DescribeCostCategoryDefinition":{
"name":"DescribeCostCategoryDefinition",
@ -54,7 +54,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.</p> <p>You have the option to use <code>EffectiveOn</code> to return a Cost Category that is active on a specific date. If there is no <code>EffectiveOn</code> specified, youll see a Cost Category that is effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
"documentation":"<p>Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.</p> <p>You have the option to use <code>EffectiveOn</code> to return a Cost Category that is active on a specific date. If there is no <code>EffectiveOn</code> specified, youll see a Cost Category that is effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
},
"GetCostAndUsage":{
"name":"GetCostAndUsage",
@ -71,7 +71,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
],
"documentation":"<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>"
"documentation":"<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>"
},
"GetCostAndUsageWithResources":{
"name":"GetCostAndUsageWithResources",
@ -88,7 +88,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
],
"documentation":"<p>Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> operation. Master accounts in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud Compute service only.</p> <note> <p>This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html\">Controlling Access for Cost Explorer</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </note>"
"documentation":"<p>Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> operation. Master accounts in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud Compute service only.</p> <note> <p>This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html\">Controlling Access for Cost Explorer</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </note>"
},
"GetCostForecast":{
"name":"GetCostForecast",
@ -134,7 +134,7 @@
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>"
"documentation":"<p>Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>"
},
"GetReservationPurchaseRecommendation":{
"name":"GetReservationPurchaseRecommendation",
@ -193,7 +193,7 @@
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organizations master account can see the coverage of the associated member accounts. For any time period, you can filter data for Savings Plans usage with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>SERVICE</code> </p> </li> <li> <p> <code>INSTANCE_FAMILY</code> </p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation.</p>"
"documentation":"<p>Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organizations master account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>SERVICE</code> </p> </li> <li> <p> <code>INSTANCE_FAMILY</code> </p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation.</p>"
},
"GetSavingsPlansPurchaseRecommendation":{
"name":"GetSavingsPlansPurchaseRecommendation",
@ -207,7 +207,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves your request parameters, Savings Plan Recommendations Summary and Details.</p>"
"documentation":"<p>Retrieves your request parameters, Savings Plan Recommendations Summary and Details. </p>"
},
"GetSavingsPlansUtilization":{
"name":"GetSavingsPlansUtilization",
@ -281,7 +281,7 @@
"errors":[
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Returns the name, ARN 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, youll see Cost Categories that are effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
"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, youll 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>"
},
"UpdateCostCategoryDefinition":{
"name":"UpdateCostCategoryDefinition",
@ -296,7 +296,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current months expenses and future expenses. This wont change categorization for the previous months.</p>"
"documentation":"<p>Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current months expenses and future expenses. This wont change categorization for the previous months.</p>"
}
},
"shapes":{
@ -367,7 +367,12 @@
"documentation":"<p> Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>The structure of Cost Categories. This includes detailed metadata and the set of rules for the <code>CostCategory</code> object.</p>"
"documentation":"<p>The structure of Cost Categories. This includes detailed metadata and the set of rules for the <code>CostCategory</code> object.</p>"
},
"CostCategoryMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"CostCategoryName":{
"type":"string",
@ -381,7 +386,7 @@
"members":{
"CostCategoryArn":{
"shape":"Arn",
"documentation":"<p> The unique identifier for your Cost Category Reference. </p>"
"documentation":"<p> The unique identifier for your Cost Category. </p>"
},
"Name":{"shape":"CostCategoryName"},
"EffectiveStart":{
@ -391,9 +396,13 @@
"EffectiveEnd":{
"shape":"ZonedDateTime",
"documentation":"<p> The Cost Category's effective end date.</p>"
},
"NumberOfRules":{
"shape":"NonNegativeInteger",
"documentation":"<p> The number of rules associated with a specific Cost Category. </p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>A reference to a Cost Category containing only enough information to identify the Cost Category.</p> <p>You can use this information to retrieve the full Cost Category information using <code>DescribeCostCategory</code>.</p>"
"documentation":"<p>A reference to a Cost Category containing only enough information to identify the Cost Category.</p> <p>You can use this information to retrieve the full Cost Category information using <code>DescribeCostCategory</code>.</p>"
},
"CostCategoryReferencesList":{
"type":"list",
@ -409,10 +418,10 @@
"Value":{"shape":"CostCategoryValue"},
"Rule":{
"shape":"Expression",
"documentation":"<p>An <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is <code>LINKED_ACCOUNT</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend you create a separate rule instead.</p>"
"documentation":"<p>An <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported are <code>LINKED_ACCOUNT</code>, <code>SERVICE_CODE</code>, <code>RECORD_TYPE</code>, and <code>LINKED_ACCOUNT_NAME</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend that you create a separate rule instead.</p> <p> <code>RECORD_TYPE</code> is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html#cost-categories-terms\">Term Comparisons</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.</p>"
"documentation":"<p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.</p>"
},
"CostCategoryRuleVersion":{
"type":"string",
@ -441,7 +450,7 @@
"documentation":"<p>The specific value of the Cost Category.</p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>The values that are available for Cost Categories.</p>"
"documentation":"<p>The Cost Categories values used for filtering the costs.</p>"
},
"Coverage":{
"type":"structure",
@ -484,10 +493,10 @@
"members":{
"OnDemandCost":{
"shape":"OnDemandCost",
"documentation":"<p>How much an On-Demand instance cost.</p>"
"documentation":"<p>How much an On-Demand Instance costs.</p>"
}
},
"documentation":"<p>How much it cost to run an instance.</p>"
"documentation":"<p>How much it costs to run an instance.</p>"
},
"CoverageHours":{
"type":"structure",
@ -551,7 +560,7 @@
"RuleVersion":{"shape":"CostCategoryRuleVersion"},
"Rules":{
"shape":"CostCategoryRulesList",
"documentation":"<p> <code>CreateCostCategoryDefinition</code> supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is <code>LINKED_ACCOUNT</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend you create a separate rule instead.</p> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
"documentation":"<p>The Cost Category rules used to categorize costs. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html\">CostCategoryRule</a>.</p>"
}
}
},
@ -689,10 +698,12 @@
"AZ",
"INSTANCE_TYPE",
"LINKED_ACCOUNT",
"LINKED_ACCOUNT_NAME",
"OPERATION",
"PURCHASE_TYPE",
"REGION",
"SERVICE",
"SERVICE_CODE",
"USAGE_TYPE",
"USAGE_TYPE_GROUP",
"RECORD_TYPE",
@ -724,7 +735,11 @@
},
"Values":{
"shape":"Values",
"documentation":"<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p> <p>Valid values for the <code>SERVICE</code> dimension are <code>Amazon Elastic Compute Cloud - Compute</code>, <code>Amazon Elasticsearch Service</code>, <code>Amazon ElastiCache</code>, <code>Amazon Redshift</code>, and <code>Amazon Relational Database Service</code>.</p>"
"documentation":"<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>"
},
"MatchOptions":{
"shape":"MatchOptions",
"documentation":"<p>The match options that you can use to filter your results. <code>MatchOptions</code> is only applicable for actions related to Cost Category. The default values for <code>MatchOptions</code> is <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p>"
}
},
"documentation":"<p>The metadata that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>"
@ -939,7 +954,7 @@
},
"CostCategories":{
"shape":"CostCategoryValues",
"documentation":"<p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> <p>The specific <code>CostCategory</code> used for <code>Expression</code>.</p>"
"documentation":"<p>The filter based on <code>CostCategory</code> values.</p>"
}
},
"documentation":"<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>REGION==us-east-1 OR REGION==us-west-1</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul> <note> <p>For <code>GetRightsizingRecommendation</code> action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to <code>LINKED_ACCOUNT</code>, <code>REGION</code>, or <code>RIGHTSIZING_TYPE</code>.</p> </note>"
@ -975,7 +990,12 @@
"member":{"shape":"ForecastResult"}
},
"GenericBoolean":{"type":"boolean"},
"GenericString":{"type":"string"},
"GenericString":{
"type":"string",
"max":1024,
"min":0,
"pattern":"[\\S\\s]*"
},
"GetCostAndUsageRequest":{
"type":"structure",
"required":["TimePeriod"],
@ -990,11 +1010,11 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters AWS 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=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>"
"documentation":"<p>Filters AWS 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>"
},
"Metrics":{
"shape":"MetricNames",
"documentation":"<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>NetAmortizedCost</code>, <code>NetUnblendedCost</code>, <code>NormalizedUsageAmount</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>. </p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
"documentation":"<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>NetAmortizedCost</code>, <code>NetUnblendedCost</code>, <code>NormalizedUsageAmount</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>. </p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
},
"GroupBy":{
"shape":"GroupDefinitions",
@ -1037,11 +1057,11 @@
},
"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=\"http://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>.</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>.</p>"
},
"Metrics":{
"shape":"MetricNames",
"documentation":"<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>NetAmortizedCost</code>, <code>NetUnblendedCost</code>, <code>NormalizedUsageAmount</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>. </p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate <code>usageQuantity</code> across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsageWithResources</code> requests.</p>"
"documentation":"<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>NetAmortizedCost</code>, <code>NetUnblendedCost</code>, <code>NormalizedUsageAmount</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>. </p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate <code>usageQuantity</code> across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsageWithResources</code> requests.</p>"
},
"GroupBy":{
"shape":"GroupDefinitions",
@ -1084,7 +1104,7 @@
},
"Metric":{
"shape":"Metric",
"documentation":"<p>Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values for a <code>GetCostForecast</code> call are the following:</p> <ul> <li> <p>AMORTIZED_COST</p> </li> <li> <p>BLENDED_COST</p> </li> <li> <p>NET_AMORTIZED_COST</p> </li> <li> <p>NET_UNBLENDED_COST</p> </li> <li> <p>UNBLENDED_COST</p> </li> </ul>"
"documentation":"<p>Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values for a <code>GetCostForecast</code> call are the following:</p> <ul> <li> <p>AMORTIZED_COST</p> </li> <li> <p>BLENDED_COST</p> </li> <li> <p>NET_AMORTIZED_COST</p> </li> <li> <p>NET_UNBLENDED_COST</p> </li> <li> <p>UNBLENDED_COST</p> </li> </ul>"
},
"Granularity":{
"shape":"Granularity",
@ -1186,7 +1206,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p> <p>If you don't provide a <code>SERVICE</code> filter, Cost Explorer defaults to EC2.</p>"
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p> <p>If you don't provide a <code>SERVICE</code> filter, Cost Explorer defaults to EC2.</p> <p>Cost category is also supported.</p>"
},
"Metrics":{
"shape":"MetricNames",
@ -1231,7 +1251,7 @@
},
"AccountScope":{
"shape":"AccountScope",
"documentation":"<p>The account scope that you want recommendations for. <code>PAYER</code> means that AWS includes the master account and any member accounts when it calculates its recommendations. <code>LINKED</code> means that AWS includes only member accounts when it calculates its recommendations.</p> <p>Valid values are <code>PAYER</code> and <code>LINKED</code>.</p>"
"documentation":"<p>The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for individual linked accounts only.</p>"
},
"LookbackPeriodInDays":{
"shape":"LookbackPeriodInDays",
@ -1294,7 +1314,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
@ -1325,6 +1345,10 @@
"required":["Service"],
"members":{
"Filter":{"shape":"Expression"},
"Configuration":{
"shape":"RightsizingRecommendationConfiguration",
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether. </p>"
},
"Service":{
"shape":"GenericString",
"documentation":"<p>The specific service that you want recommendations for. The only valid value for <code>GetRightsizingRecommendation</code> is \"<code>AmazonEC2</code>\".</p>"
@ -1357,6 +1381,10 @@
"NextPageToken":{
"shape":"NextPageToken",
"documentation":"<p>The token to retrieve the next set of results.</p>"
},
"Configuration":{
"shape":"RightsizingRecommendationConfiguration",
"documentation":"<p>Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether. </p>"
}
}
},
@ -1378,7 +1406,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>SERVICE</code> </p> </li> <li> <p> <code>INSTANCE_FAMILY</code> </p> </li> </ul> <p> <code>GetSavingsPlansCoverage</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.</p>"
"documentation":"<p>Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>SERVICE</code> </p> </li> <li> <p> <code>INSTANCE_FAMILY</code> </p> </li> </ul> <p> <code>GetSavingsPlansCoverage</code> uses the same <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.</p> <p>Cost category is also supported.</p>"
},
"Metrics":{
"shape":"MetricNames",
@ -1430,6 +1458,10 @@
"shape":"PaymentOption",
"documentation":"<p>The payment option used to generate these recommendations.</p>"
},
"AccountScope":{
"shape":"AccountScope",
"documentation":"<p>The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for individual linked accounts only.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
"documentation":"<p>The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.</p>"
@ -1441,6 +1473,10 @@
"LookbackPeriodInDays":{
"shape":"LookbackPeriodInDays",
"documentation":"<p>The lookback period used to generate the recommendation.</p>"
},
"Filter":{
"shape":"Expression",
"documentation":"<p>You can filter your recommendations by Account ID with the <code>LINKED_ACCOUNT</code> dimension. To filter your recommendations by Account ID, specify <code>Key</code> as <code>LINKED_ACCOUNT</code> and <code>Value</code> as the comma-separated Acount ID(s) for which you want to see Savings Plans purchase recommendations.</p> <p>For GetSavingsPlansPurchaseRecommendation, the <code>Filter</code> does not include <code>CostCategories</code> or <code>Tags</code>. It only includes <code>Dimensions</code>. With <code>Dimensions</code>, <code>Key</code> must be <code>LINKED_ACCOUNT</code> and <code>Value</code> can be a single Account ID or multiple comma-separated Account IDs for which you want to see Savings Plans Purchase Recommendations. <code>AND</code> and <code>OR</code> operators are not supported.</p>"
}
}
},
@ -1471,7 +1507,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>SAVINGS_PLAN_ARN</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>PAYMENT_OPTION</code> </p> </li> <li> <p> <code>INSTANCE_TYPE_FAMILY</code> </p> </li> </ul> <p> <code>GetSavingsPlansUtilizationDetails</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension.</p>"
"documentation":"<p>Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>SAVINGS_PLAN_ARN</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>PAYMENT_OPTION</code> </p> </li> <li> <p> <code>INSTANCE_TYPE_FAMILY</code> </p> </li> </ul> <p> <code>GetSavingsPlansUtilizationDetails</code> uses the same <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension.</p>"
},
"NextToken":{
"shape":"NextPageToken",
@ -1520,7 +1556,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>SAVINGS_PLAN_ARN</code> </p> </li> <li> <p> <code>SAVINGS_PLANS_TYPE</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>PAYMENT_OPTION</code> </p> </li> <li> <p> <code>INSTANCE_TYPE_FAMILY</code> </p> </li> </ul> <p> <code>GetSavingsPlansUtilization</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension.</p>"
"documentation":"<p>Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:</p> <ul> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>SAVINGS_PLAN_ARN</code> </p> </li> <li> <p> <code>SAVINGS_PLANS_TYPE</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>PAYMENT_OPTION</code> </p> </li> <li> <p> <code>INSTANCE_TYPE_FAMILY</code> </p> </li> </ul> <p> <code>GetSavingsPlansUtilization</code> uses the same <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension.</p>"
}
}
},
@ -1665,7 +1701,12 @@
},
"documentation":"<p>Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.</p>"
},
"GroupDefinitionKey":{"type":"string"},
"GroupDefinitionKey":{
"type":"string",
"max":1024,
"min":0,
"pattern":"[\\S\\s]*"
},
"GroupDefinitionType":{
"type":"string",
"enum":[
@ -1738,7 +1779,12 @@
},
"NextToken":{
"shape":"NextPageToken",
"documentation":"<p> The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. </p> <p>You can use this information to retrieve the full Cost Category information using <code>DescribeCostCategory</code>.</p>"
"documentation":"<p> The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. </p>"
},
"MaxResults":{
"shape":"CostCategoryMaxResults",
"documentation":"<p> The number of entries a paginated response contains. </p>",
"box":true
}
}
},
@ -1763,6 +1809,21 @@
"SIXTY_DAYS"
]
},
"MatchOption":{
"type":"string",
"enum":[
"EQUALS",
"STARTS_WITH",
"ENDS_WITH",
"CONTAINS",
"CASE_SENSITIVE",
"CASE_INSENSITIVE"
]
},
"MatchOptions":{
"type":"list",
"member":{"shape":"MatchOption"}
},
"MaxResults":{
"type":"integer",
"min":1
@ -1780,7 +1841,12 @@
]
},
"MetricAmount":{"type":"string"},
"MetricName":{"type":"string"},
"MetricName":{
"type":"string",
"max":1024,
"min":0,
"pattern":"[\\S\\s]*"
},
"MetricNames":{
"type":"list",
"member":{"shape":"MetricName"}
@ -1816,7 +1882,12 @@
"documentation":"<p> Details on the modification recommendation.</p>"
},
"NetRISavings":{"type":"string"},
"NextPageToken":{"type":"string"},
"NextPageToken":{
"type":"string",
"max":8192,
"min":0,
"pattern":"[\\S\\s]*"
},
"NonNegativeInteger":{
"type":"integer",
"min":0
@ -1893,6 +1964,13 @@
},
"documentation":"<p>Details about the Amazon RDS instances that AWS recommends that you purchase.</p>"
},
"RecommendationTarget":{
"type":"string",
"enum":[
"SAME_INSTANCE_FAMILY",
"CROSS_INSTANCE_FAMILY"
]
},
"RedshiftInstanceDetails":{
"type":"structure",
"members":{
@ -2138,10 +2216,10 @@
},
"GenerationTimestamp":{
"shape":"GenericString",
"documentation":"<p>The time stamp for when AWS made this recommendation.</p>"
"documentation":"<p>The timestamp for when AWS made this recommendation.</p>"
}
},
"documentation":"<p>Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.</p>"
"documentation":"<p>Information about this specific recommendation, such as the timestamp for when AWS made a specific recommendation.</p>"
},
"ReservationPurchaseRecommendationSummary":{
"type":"structure",
@ -2273,6 +2351,24 @@
},
"documentation":"<p>Recommendations to rightsize resources.</p>"
},
"RightsizingRecommendationConfiguration":{
"type":"structure",
"required":[
"RecommendationTarget",
"BenefitsConsidered"
],
"members":{
"RecommendationTarget":{
"shape":"RecommendationTarget",
"documentation":"<p> The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is <code>SAME_INSTANCE_FAMILY</code>. </p>"
},
"BenefitsConsidered":{
"shape":"GenericBoolean",
"documentation":"<p> The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is <code>TRUE</code>. </p>"
}
},
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether. </p>"
},
"RightsizingRecommendationList":{
"type":"list",
"member":{"shape":"RightsizingRecommendation"}
@ -2375,7 +2471,7 @@
},
"CoveragePercentage":{
"shape":"GenericString",
"documentation":"<p>The percentage of your existing Savings Planscovered usage, divided by all of your eligible Savings Plans usage in an account(or set of accounts).</p>"
"documentation":"<p>The percentage of your existing Savings Plans covered usage, divided by all of your eligible Savings Plans usage in an account(or set of accounts).</p>"
}
},
"documentation":"<p>Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and total Savings Plans costs for an account.</p>"
@ -2405,6 +2501,10 @@
"SavingsPlansPurchaseRecommendation":{
"type":"structure",
"members":{
"AccountScope":{
"shape":"AccountScope",
"documentation":"<p>The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the payer account and linked accounts if the value is set to <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for individual linked accounts only.</p>"
},
"SavingsPlansType":{
"shape":"SupportedSavingsPlansType",
"documentation":"<p>The requested Savings Plans recommendation type.</p>"
@ -2423,7 +2523,7 @@
},
"SavingsPlansPurchaseRecommendationDetails":{
"shape":"SavingsPlansPurchaseRecommendationDetailList",
"documentation":"<p>Details for the Savings Plans we recommend you to purchase to cover existing, Savings Plans eligible workloads.</p>"
"documentation":"<p>Details for the Savings Plans we recommend that you purchase to cover existing Savings Plans eligible workloads.</p>"
},
"SavingsPlansPurchaseRecommendationSummary":{
"shape":"SavingsPlansPurchaseRecommendationSummary",
@ -2682,7 +2782,12 @@
"type":"list",
"member":{"shape":"SavingsPlansUtilizationByTime"}
},
"SearchString":{"type":"string"},
"SearchString":{
"type":"string",
"max":1024,
"min":0,
"pattern":"[\\S\\s]*"
},
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
@ -2708,7 +2813,12 @@
"EC2_INSTANCE_SP"
]
},
"TagKey":{"type":"string"},
"TagKey":{
"type":"string",
"max":1024,
"min":0,
"pattern":"[\\S\\s]*"
},
"TagList":{
"type":"list",
"member":{"shape":"Entity"}
@ -2723,6 +2833,10 @@
"Values":{
"shape":"Values",
"documentation":"<p>The specific value of the tag.</p>"
},
"MatchOptions":{
"shape":"MatchOptions",
"documentation":"<p>The match options that you can use to filter your results. <code>MatchOptions</code> is only applicable for only applicable for actions related to Cost Category. The default values for <code>MatchOptions</code> is <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.</p>"
}
},
"documentation":"<p>The values that are available for a tag.</p>"
@ -2817,7 +2931,7 @@
"RuleVersion":{"shape":"CostCategoryRuleVersion"},
"Rules":{
"shape":"CostCategoryRulesList",
"documentation":"<p> <code>UpdateCostCategoryDefinition</code> supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is <code>LINKED_ACCOUNT</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend you create a separate rule instead.</p> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
"documentation":"<p>The <code>Expression</code> object used to categorize costs. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html\">CostCategoryRule </a>. </p>"
}
}
},
@ -2858,13 +2972,20 @@
"type":"list",
"member":{"shape":"UtilizationByTime"}
},
"Value":{"type":"string"},
"Value":{
"type":"string",
"max":1024,
"min":0,
"pattern":"[\\S\\s]*"
},
"Values":{
"type":"list",
"member":{"shape":"Value"}
},
"YearMonthDay":{
"type":"string",
"max":40,
"min":0,
"pattern":"(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?"
},
"ZonedDateTime":{
@ -2875,5 +2996,5 @@
"pattern":"^\\d{4}-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d(([+-]\\d\\d:\\d\\d)|Z)$"
}
},
"documentation":"<p>The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p> <code>https://ce.us-east-1.amazonaws.com</code> </p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>"
"documentation":"<p>The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p> <code>https://ce.us-east-1.amazonaws.com</code> </p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"http://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>"
}

View file

@ -337,6 +337,26 @@
],
"documentation":"<p>Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.</p>"
},
"CreateProxySession":{
"name":"CreateProxySession",
"http":{
"method":"POST",
"requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions",
"responseCode":201
},
"input":{"shape":"CreateProxySessionRequest"},
"output":{"shape":"CreateProxySessionResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.</p>"
},
"CreateRoom":{
"name":"CreateRoom",
"http":{
@ -539,6 +559,25 @@
],
"documentation":"<p>Moves the specified phone number into the <b>Deletion queue</b>. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.</p> <p>Deleted phone numbers remain in the <b>Deletion queue</b> for 7 days before they are deleted permanently.</p>"
},
"DeleteProxySession":{
"name":"DeleteProxySession",
"http":{
"method":"DELETE",
"requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}",
"responseCode":204
},
"input":{"shape":"DeleteProxySessionRequest"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Deletes the specified proxy session from the specified Amazon Chime Voice Connector.</p>"
},
"DeleteRoom":{
"name":"DeleteRoom",
"http":{
@ -636,6 +675,25 @@
],
"documentation":"<p>Deletes the origination settings for the specified Amazon Chime Voice Connector.</p>"
},
"DeleteVoiceConnectorProxy":{
"name":"DeleteVoiceConnectorProxy",
"http":{
"method":"DELETE",
"requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy",
"responseCode":204
},
"input":{"shape":"DeleteVoiceConnectorProxyRequest"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Deletes the proxy configuration from the specified Amazon Chime Voice Connector.</p>"
},
"DeleteVoiceConnectorStreamingConfiguration":{
"name":"DeleteVoiceConnectorStreamingConfiguration",
"http":{
@ -966,6 +1024,26 @@
],
"documentation":"<p>Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.</p>"
},
"GetProxySession":{
"name":"GetProxySession",
"http":{
"method":"GET",
"requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}",
"responseCode":200
},
"input":{"shape":"GetProxySessionRequest"},
"output":{"shape":"GetProxySessionResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Gets the specified proxy session details for the specified Amazon Chime Voice Connector.</p>"
},
"GetRoom":{
"name":"GetRoom",
"http":{
@ -1106,6 +1184,26 @@
],
"documentation":"<p>Retrieves origination setting details for the specified Amazon Chime Voice Connector.</p>"
},
"GetVoiceConnectorProxy":{
"name":"GetVoiceConnectorProxy",
"http":{
"method":"GET",
"requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy",
"responseCode":200
},
"input":{"shape":"GetVoiceConnectorProxyRequest"},
"output":{"shape":"GetVoiceConnectorProxyResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Gets the proxy configuration details for the specified Amazon Chime Voice Connector.</p>"
},
"GetVoiceConnectorStreamingConfiguration":{
"name":"GetVoiceConnectorStreamingConfiguration",
"http":{
@ -1205,6 +1303,26 @@
],
"documentation":"<p>Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.</p>"
},
"ListAttendeeTags":{
"name":"ListAttendeeTags",
"http":{
"method":"GET",
"requestUri":"/meetings/{meetingId}/attendees/{attendeeId}/tags",
"responseCode":200
},
"input":{"shape":"ListAttendeeTagsRequest"},
"output":{"shape":"ListAttendeeTagsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"ThrottledClientException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists the tags applied to an Amazon Chime SDK attendee resource.</p>"
},
"ListAttendees":{
"name":"ListAttendees",
"http":{
@ -1245,6 +1363,26 @@
],
"documentation":"<p>Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.</p>"
},
"ListMeetingTags":{
"name":"ListMeetingTags",
"http":{
"method":"GET",
"requestUri":"/meetings/{meetingId}/tags",
"responseCode":200
},
"input":{"shape":"ListMeetingTagsRequest"},
"output":{"shape":"ListMeetingTagsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"ThrottledClientException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists the tags applied to an Amazon Chime SDK meeting resource.</p>"
},
"ListMeetings":{
"name":"ListMeetings",
"http":{
@ -1301,6 +1439,26 @@
],
"documentation":"<p>Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.</p>"
},
"ListProxySessions":{
"name":"ListProxySessions",
"http":{
"method":"GET",
"requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions",
"responseCode":200
},
"input":{"shape":"ListProxySessionsRequest"},
"output":{"shape":"ListProxySessionsResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists the proxy sessions for the specified Amazon Chime Voice Connector.</p>"
},
"ListRoomMemberships":{
"name":"ListRoomMemberships",
"http":{
@ -1341,6 +1499,24 @@
],
"documentation":"<p>Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists the tags applied to an Amazon Chime SDK meeting resource.</p>"
},
"ListUsers":{
"name":"ListUsers",
"http":{
@ -1499,6 +1675,26 @@
],
"documentation":"<p>Adds origination settings for the specified Amazon Chime Voice Connector.</p>"
},
"PutVoiceConnectorProxy":{
"name":"PutVoiceConnectorProxy",
"http":{
"method":"PUT",
"requestUri":"/voice-connectors/{voiceConnectorId}/programmable-numbers/proxy"
},
"input":{"shape":"PutVoiceConnectorProxyRequest"},
"output":{"shape":"PutVoiceConnectorProxyResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"AccessDeniedException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.</p>"
},
"PutVoiceConnectorStreamingConfiguration":{
"name":"PutVoiceConnectorStreamingConfiguration",
"http":{
@ -1639,6 +1835,120 @@
],
"documentation":"<p>Searches phone numbers that can be ordered.</p>"
},
"TagAttendee":{
"name":"TagAttendee",
"http":{
"method":"POST",
"requestUri":"/meetings/{meetingId}/attendees/{attendeeId}/tags?operation=add",
"responseCode":204
},
"input":{"shape":"TagAttendeeRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Applies the specified tags to the specified Amazon Chime SDK attendee.</p>"
},
"TagMeeting":{
"name":"TagMeeting",
"http":{
"method":"POST",
"requestUri":"/meetings/{meetingId}/tags?operation=add",
"responseCode":204
},
"input":{"shape":"TagMeetingRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Applies the specified tags to the specified Amazon Chime SDK meeting.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags?operation=tag-resource",
"responseCode":204
},
"input":{"shape":"TagResourceRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Applies the specified tags to the specified Amazon Chime SDK meeting resource.</p>"
},
"UntagAttendee":{
"name":"UntagAttendee",
"http":{
"method":"POST",
"requestUri":"/meetings/{meetingId}/attendees/{attendeeId}/tags?operation=delete",
"responseCode":204
},
"input":{"shape":"UntagAttendeeRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ThrottledClientException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Untags the specified tags from the specified Amazon Chime SDK attendee.</p>"
},
"UntagMeeting":{
"name":"UntagMeeting",
"http":{
"method":"POST",
"requestUri":"/meetings/{meetingId}/tags?operation=delete",
"responseCode":204
},
"input":{"shape":"UntagMeetingRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ThrottledClientException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Untags the specified tags from the specified Amazon Chime SDK meeting.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/tags?operation=untag-resource",
"responseCode":204
},
"input":{"shape":"UntagResourceRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Untags the specified tags from the specified Amazon Chime SDK meeting resource.</p>"
},
"UpdateAccount":{
"name":"UpdateAccount",
"http":{
@ -1756,6 +2066,26 @@
],
"documentation":"<p>Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.</p>"
},
"UpdateProxySession":{
"name":"UpdateProxySession",
"http":{
"method":"POST",
"requestUri":"/voice-connectors/{voiceConnectorId}/proxy-sessions/{proxySessionId}",
"responseCode":201
},
"input":{"shape":"UpdateProxySessionRequest"},
"output":{"shape":"UpdateProxySessionResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Updates the specified proxy session details, such as voice or SMS capabilities.</p>"
},
"UpdateRoom":{
"name":"UpdateRoom",
"http":{
@ -1978,6 +2308,10 @@
},
"documentation":"<p>The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.</p>"
},
"AreaCode":{
"type":"string",
"pattern":"^$|^[0-9]{3,3}$"
},
"Arn":{
"type":"string",
"max":1024,
@ -2120,6 +2454,18 @@
"type":"list",
"member":{"shape":"Attendee"}
},
"AttendeeTagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":10,
"min":1
},
"AttendeeTagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":10,
"min":1
},
"BadRequestException":{
"type":"structure",
"members":{
@ -2404,6 +2750,17 @@
"type":"list",
"member":{"shape":"CallingRegion"}
},
"Capability":{
"type":"string",
"enum":[
"Voice",
"SMS"
]
},
"CapabilityList":{
"type":"list",
"member":{"shape":"Capability"}
},
"ClientRequestToken":{
"type":"string",
"max":64,
@ -2421,6 +2778,16 @@
"error":{"httpStatusCode":409},
"exception":true
},
"Country":{
"type":"string",
"pattern":"^$|^[A-Z]{2,2}$"
},
"CountryList":{
"type":"list",
"member":{"shape":"Country"},
"max":100,
"min":1
},
"CpsLimit":{
"type":"integer",
"min":1
@ -2478,6 +2845,10 @@
"ExternalUserId":{
"shape":"ExternalUserIdType",
"documentation":"<p>The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.</p>"
},
"Tags":{
"shape":"AttendeeTagList",
"documentation":"<p>The tag key-value pairs.</p>"
}
}
},
@ -2488,6 +2859,10 @@
"ExternalUserId":{
"shape":"ExternalUserIdType",
"documentation":"<p>The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.</p>"
},
"Tags":{
"shape":"AttendeeTagList",
"documentation":"<p>The tag key-value pairs.</p>"
}
},
"documentation":"<p>The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.</p>"
@ -2546,6 +2921,10 @@
"documentation":"<p>The unique identifier for the client request. Use a different token for different meetings.</p>",
"idempotencyToken":true
},
"ExternalMeetingId":{
"shape":"ExternalMeetingIdType",
"documentation":"<p>The external meeting ID.</p>"
},
"MeetingHostId":{
"shape":"ExternalUserIdType",
"documentation":"<p>Reserved.</p>"
@ -2554,6 +2933,10 @@
"shape":"String",
"documentation":"<p>The Region in which to create the meeting. Available values: <code>ap-northeast-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-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>"
},
"Tags":{
"shape":"MeetingTagList",
"documentation":"<p>The tag key-value pairs.</p>"
},
"NotificationsConfiguration":{
"shape":"MeetingNotificationConfiguration",
"documentation":"<p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>"
@ -2595,6 +2978,59 @@
}
}
},
"CreateProxySessionRequest":{
"type":"structure",
"required":[
"ParticipantPhoneNumbers",
"Capabilities",
"VoiceConnectorId"
],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
},
"ParticipantPhoneNumbers":{
"shape":"ParticipantPhoneNumberList",
"documentation":"<p>The participant phone numbers.</p>"
},
"Name":{
"shape":"ProxySessionNameString",
"documentation":"<p>The name of the proxy session.</p>"
},
"ExpiryMinutes":{
"shape":"PositiveInteger",
"documentation":"<p>The number of minutes allowed for the proxy session.</p>"
},
"Capabilities":{
"shape":"CapabilityList",
"documentation":"<p>The proxy session capabilities.</p>"
},
"NumberSelectionBehavior":{
"shape":"NumberSelectionBehavior",
"documentation":"<p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>"
},
"GeoMatchLevel":{
"shape":"GeoMatchLevel",
"documentation":"<p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>"
},
"GeoMatchParams":{
"shape":"GeoMatchParams",
"documentation":"<p>The country and area code for the proxy phone number.</p>"
}
}
},
"CreateProxySessionResponse":{
"type":"structure",
"members":{
"ProxySession":{
"shape":"ProxySession",
"documentation":"<p>The proxy session details.</p>"
}
}
},
"CreateRoomMembershipRequest":{
"type":"structure",
"required":[
@ -2855,6 +3291,27 @@
}
}
},
"DeleteProxySessionRequest":{
"type":"structure",
"required":[
"VoiceConnectorId",
"ProxySessionId"
],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
},
"ProxySessionId":{
"shape":"NonEmptyString128",
"documentation":"<p>The proxy session ID.</p>",
"location":"uri",
"locationName":"proxySessionId"
}
}
},
"DeleteRoomMembershipRequest":{
"type":"structure",
"required":[
@ -2928,6 +3385,18 @@
}
}
},
"DeleteVoiceConnectorProxyRequest":{
"type":"structure",
"required":["VoiceConnectorId"],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime Voice Connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
}
}
},
"DeleteVoiceConnectorRequest":{
"type":"structure",
"required":["VoiceConnectorId"],
@ -3139,6 +3608,12 @@
},
"documentation":"<p>The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.</p>"
},
"ExternalMeetingIdType":{
"type":"string",
"max":64,
"min":2,
"sensitive":true
},
"ExternalUserIdType":{
"type":"string",
"max":64,
@ -3155,6 +3630,31 @@
"error":{"httpStatusCode":403},
"exception":true
},
"GeoMatchLevel":{
"type":"string",
"enum":[
"Country",
"AreaCode"
]
},
"GeoMatchParams":{
"type":"structure",
"required":[
"Country",
"AreaCode"
],
"members":{
"Country":{
"shape":"Country",
"documentation":"<p>The country.</p>"
},
"AreaCode":{
"shape":"AreaCode",
"documentation":"<p>The area code.</p>"
}
},
"documentation":"<p>The country and area code for a proxy phone number in a proxy phone session.</p>"
},
"GetAccountRequest":{
"type":"structure",
"required":["AccountId"],
@ -3376,6 +3876,36 @@
}
}
},
"GetProxySessionRequest":{
"type":"structure",
"required":[
"VoiceConnectorId",
"ProxySessionId"
],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
},
"ProxySessionId":{
"shape":"NonEmptyString128",
"documentation":"<p>The proxy session ID.</p>",
"location":"uri",
"locationName":"proxySessionId"
}
}
},
"GetProxySessionResponse":{
"type":"structure",
"members":{
"ProxySession":{
"shape":"ProxySession",
"documentation":"<p>The proxy session details.</p>"
}
}
},
"GetRoomRequest":{
"type":"structure",
"required":[
@ -3529,6 +4059,27 @@
}
}
},
"GetVoiceConnectorProxyRequest":{
"type":"structure",
"required":["VoiceConnectorId"],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
}
}
},
"GetVoiceConnectorProxyResponse":{
"type":"structure",
"members":{
"Proxy":{
"shape":"Proxy",
"documentation":"<p>The proxy configuration details.</p>"
}
}
},
"GetVoiceConnectorRequest":{
"type":"structure",
"required":["VoiceConnectorId"],
@ -3617,6 +4168,7 @@
"type":"string",
"pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}"
},
"Integer":{"type":"integer"},
"Invite":{
"type":"structure",
"members":{
@ -3748,6 +4300,36 @@
}
}
},
"ListAttendeeTagsRequest":{
"type":"structure",
"required":[
"MeetingId",
"AttendeeId"
],
"members":{
"MeetingId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>",
"location":"uri",
"locationName":"meetingId"
},
"AttendeeId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK attendee ID.</p>",
"location":"uri",
"locationName":"attendeeId"
}
}
},
"ListAttendeeTagsResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag key-value pairs.</p>"
}
}
},
"ListAttendeesRequest":{
"type":"structure",
"required":["MeetingId"],
@ -3822,6 +4404,27 @@
}
}
},
"ListMeetingTagsRequest":{
"type":"structure",
"required":["MeetingId"],
"members":{
"MeetingId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>",
"location":"uri",
"locationName":"meetingId"
}
}
},
"ListMeetingTagsResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag key-value pairs.</p>"
}
}
},
"ListMeetingsRequest":{
"type":"structure",
"members":{
@ -3936,6 +4539,49 @@
}
}
},
"ListProxySessionsRequest":{
"type":"structure",
"required":["VoiceConnectorId"],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
},
"Status":{
"shape":"ProxySessionStatus",
"documentation":"<p>The proxy session status.</p>",
"location":"querystring",
"locationName":"status"
},
"NextToken":{
"shape":"NextTokenString",
"documentation":"<p>The token to use to retrieve the next page of results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"ResultMax",
"documentation":"<p>The maximum number of results to return in a single call.</p>",
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListProxySessionsResponse":{
"type":"structure",
"members":{
"ProxySessions":{
"shape":"ProxySessions",
"documentation":"<p>The proxy session details.</p>"
},
"NextToken":{
"shape":"NextTokenString",
"documentation":"<p>The token to use to retrieve the next page of results.</p>"
}
}
},
"ListRoomMembershipsRequest":{
"type":"structure",
"required":[
@ -4025,6 +4671,27 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"Arn",
"documentation":"<p>The resource ARN.</p>",
"location":"querystring",
"locationName":"arn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag-key value pairs.</p>"
}
}
},
"ListUsersRequest":{
"type":"structure",
"required":["AccountId"],
@ -4232,6 +4899,10 @@
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>"
},
"ExternalMeetingId":{
"shape":"ExternalMeetingIdType",
"documentation":"<p>The external meeting ID.</p>"
},
"MediaPlacement":{
"shape":"MediaPlacement",
"documentation":"<p>The media placement for the meeting.</p>"
@ -4261,6 +4932,18 @@
},
"documentation":"<p>The configuration for resource targets to receive notifications when Amazon Chime SDK meeting and attendee events occur.</p>"
},
"MeetingTagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"MeetingTagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"Member":{
"type":"structure",
"members":{
@ -4336,10 +5019,20 @@
"member":{"shape":"MembershipItem"},
"max":50
},
"NextTokenString":{
"type":"string",
"max":65535
},
"NonEmptyString":{
"type":"string",
"pattern":".*\\S.*"
},
"NonEmptyString128":{
"type":"string",
"max":128,
"min":1,
"pattern":".*\\S.*"
},
"NonEmptyStringList":{
"type":"list",
"member":{"shape":"String"},
@ -4356,6 +5049,13 @@
"exception":true
},
"NullableBoolean":{"type":"boolean"},
"NumberSelectionBehavior":{
"type":"string",
"enum":[
"PreferSticky",
"AvoidSticky"
]
},
"OrderedPhoneNumber":{
"type":"structure",
"members":{
@ -4443,6 +5143,30 @@
"max":100,
"min":1
},
"Participant":{
"type":"structure",
"members":{
"PhoneNumber":{
"shape":"E164PhoneNumber",
"documentation":"<p>The participant's phone number.</p>"
},
"ProxyPhoneNumber":{
"shape":"E164PhoneNumber",
"documentation":"<p>The participant's proxy phone number.</p>"
}
},
"documentation":"<p>The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.</p>"
},
"ParticipantPhoneNumberList":{
"type":"list",
"member":{"shape":"E164PhoneNumber"},
"max":2,
"min":2
},
"Participants":{
"type":"list",
"member":{"shape":"Participant"}
},
"PhoneNumber":{
"type":"structure",
"members":{
@ -4664,11 +5388,112 @@
"max":65535,
"min":0
},
"PositiveInteger":{
"type":"integer",
"min":1
},
"ProfileServiceMaxResults":{
"type":"integer",
"max":200,
"min":1
},
"Proxy":{
"type":"structure",
"members":{
"DefaultSessionExpiryMinutes":{
"shape":"Integer",
"documentation":"<p>The default number of minutes allowed for proxy sessions.</p>"
},
"Disabled":{
"shape":"Boolean",
"documentation":"<p>When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.</p>"
},
"FallBackPhoneNumber":{
"shape":"E164PhoneNumber",
"documentation":"<p>The phone number to route calls to after a proxy session expires.</p>"
},
"PhoneNumberCountries":{
"shape":"StringList",
"documentation":"<p>The countries for proxy phone numbers to be selected from.</p>"
}
},
"documentation":"<p>The proxy configuration for an Amazon Chime Voice Connector.</p>"
},
"ProxySession":{
"type":"structure",
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>"
},
"ProxySessionId":{
"shape":"NonEmptyString128",
"documentation":"<p>The proxy session ID.</p>"
},
"Name":{
"shape":"String128",
"documentation":"<p>The name of the proxy session.</p>"
},
"Status":{
"shape":"ProxySessionStatus",
"documentation":"<p>The status of the proxy session.</p>"
},
"ExpiryMinutes":{
"shape":"PositiveInteger",
"documentation":"<p>The number of minutes allowed for the proxy session.</p>"
},
"Capabilities":{
"shape":"CapabilityList",
"documentation":"<p>The proxy session capabilities.</p>"
},
"CreatedTimestamp":{
"shape":"Iso8601Timestamp",
"documentation":"<p>The created timestamp, in ISO 8601 format.</p>"
},
"UpdatedTimestamp":{
"shape":"Iso8601Timestamp",
"documentation":"<p>The updated timestamp, in ISO 8601 format.</p>"
},
"EndedTimestamp":{
"shape":"Iso8601Timestamp",
"documentation":"<p>The ended timestamp, in ISO 8601 format.</p>"
},
"Participants":{
"shape":"Participants",
"documentation":"<p>The proxy session participants.</p>"
},
"NumberSelectionBehavior":{
"shape":"NumberSelectionBehavior",
"documentation":"<p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>"
},
"GeoMatchLevel":{
"shape":"GeoMatchLevel",
"documentation":"<p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>"
},
"GeoMatchParams":{
"shape":"GeoMatchParams",
"documentation":"<p>The country and area code for the proxy phone number.</p>"
}
},
"documentation":"<p>The proxy session for an Amazon Chime Voice Connector.</p>"
},
"ProxySessionNameString":{
"type":"string",
"pattern":"^$|^[a-zA-Z0-9 ]{0,30}$",
"sensitive":true
},
"ProxySessionStatus":{
"type":"string",
"enum":[
"Open",
"InProgress",
"Closed"
]
},
"ProxySessions":{
"type":"list",
"member":{"shape":"ProxySession"}
},
"PutEventsConfigurationRequest":{
"type":"structure",
"required":[
@ -4760,6 +5585,47 @@
}
}
},
"PutVoiceConnectorProxyRequest":{
"type":"structure",
"required":[
"DefaultSessionExpiryMinutes",
"PhoneNumberPoolCountries",
"VoiceConnectorId"
],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
},
"DefaultSessionExpiryMinutes":{
"shape":"Integer",
"documentation":"<p>The default number of minutes allowed for proxy sessions.</p>"
},
"PhoneNumberPoolCountries":{
"shape":"CountryList",
"documentation":"<p>The countries for proxy phone numbers to be selected from.</p>"
},
"FallBackPhoneNumber":{
"shape":"E164PhoneNumber",
"documentation":"<p>The phone number to route calls to after a proxy session expires.</p>"
},
"Disabled":{
"shape":"Boolean",
"documentation":"<p>When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.</p>"
}
}
},
"PutVoiceConnectorProxyResponse":{
"type":"structure",
"members":{
"Proxy":{
"shape":"Proxy",
"documentation":"<p>The proxy configuration details.</p>"
}
}
},
"PutVoiceConnectorStreamingConfigurationRequest":{
"type":"structure",
"required":[
@ -5117,10 +5983,118 @@
"documentation":"<p>The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.</p>"
},
"String":{"type":"string"},
"String128":{
"type":"string",
"max":128
},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>The key of the tag.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The value of the tag.</p>"
}
},
"documentation":"<p>Describes a tag applied to a resource.</p>"
},
"TagAttendeeRequest":{
"type":"structure",
"required":[
"MeetingId",
"AttendeeId",
"Tags"
],
"members":{
"MeetingId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>",
"location":"uri",
"locationName":"meetingId"
},
"AttendeeId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK attendee ID.</p>",
"location":"uri",
"locationName":"attendeeId"
},
"Tags":{
"shape":"AttendeeTagList",
"documentation":"<p>The tag key-value pairs.</p>"
}
}
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"sensitive":true
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagMeetingRequest":{
"type":"structure",
"required":[
"MeetingId",
"Tags"
],
"members":{
"MeetingId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>",
"location":"uri",
"locationName":"meetingId"
},
"Tags":{
"shape":"MeetingTagList",
"documentation":"<p>The tag key-value pairs.</p>"
}
}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"Arn",
"documentation":"<p>The resource ARN.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tag key-value pairs.</p>"
}
}
},
"TagValue":{
"type":"string",
"max":256,
"min":1,
"sensitive":true
},
"TelephonySettings":{
"type":"structure",
"required":[
@ -5220,6 +6194,68 @@
"error":{"httpStatusCode":422},
"exception":true
},
"UntagAttendeeRequest":{
"type":"structure",
"required":[
"MeetingId",
"TagKeys",
"AttendeeId"
],
"members":{
"MeetingId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>",
"location":"uri",
"locationName":"meetingId"
},
"AttendeeId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK attendee ID.</p>",
"location":"uri",
"locationName":"attendeeId"
},
"TagKeys":{
"shape":"AttendeeTagKeyList",
"documentation":"<p>The tag keys.</p>"
}
}
},
"UntagMeetingRequest":{
"type":"structure",
"required":[
"MeetingId",
"TagKeys"
],
"members":{
"MeetingId":{
"shape":"GuidString",
"documentation":"<p>The Amazon Chime SDK meeting ID.</p>",
"location":"uri",
"locationName":"meetingId"
},
"TagKeys":{
"shape":"MeetingTagKeyList",
"documentation":"<p>The tag keys.</p>"
}
}
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"TagKeys"
],
"members":{
"ResourceARN":{
"shape":"Arn",
"documentation":"<p>The resource ARN.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys.</p>"
}
}
},
"UpdateAccountRequest":{
"type":"structure",
"required":["AccountId"],
@ -5382,6 +6418,45 @@
}
}
},
"UpdateProxySessionRequest":{
"type":"structure",
"required":[
"Capabilities",
"VoiceConnectorId",
"ProxySessionId"
],
"members":{
"VoiceConnectorId":{
"shape":"NonEmptyString128",
"documentation":"<p>The Amazon Chime voice connector ID.</p>",
"location":"uri",
"locationName":"voiceConnectorId"
},
"ProxySessionId":{
"shape":"NonEmptyString128",
"documentation":"<p>The proxy session ID.</p>",
"location":"uri",
"locationName":"proxySessionId"
},
"Capabilities":{
"shape":"CapabilityList",
"documentation":"<p>The proxy session capabilities.</p>"
},
"ExpiryMinutes":{
"shape":"PositiveInteger",
"documentation":"<p>The number of minutes allowed for the proxy session.</p>"
}
}
},
"UpdateProxySessionResponse":{
"type":"structure",
"members":{
"ProxySession":{
"shape":"ProxySession",
"documentation":"<p>The proxy session details.</p>"
}
}
},
"UpdateRoomMembershipRequest":{
"type":"structure",
"required":[

View file

@ -0,0 +1,308 @@
{
"version": "1.0",
"examples": {
"CreateEnvironmentEC2": [
{
"input": {
"name": "my-demo-environment",
"automaticStopTimeMinutes": 60,
"description": "This is my demonstration environment.",
"instanceType": "t2.micro",
"ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"subnetId": "subnet-1fab8aEX"
},
"output": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "createenvironmentec2-1516821730547",
"title": "CreateEnvironmentEC2"
}
],
"CreateEnvironmentMembership": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-write",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
},
"output": {
"membership": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-write",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "createenvironmentmembership-1516822583452",
"title": "CreateEnvironmentMembership"
}
],
"DeleteEnvironment": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "deleteenvironment-1516822903149",
"title": "DeleteEnvironment"
}
],
"DeleteEnvironmentMembership": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "deleteenvironmentmembership-1516822975655",
"title": "DeleteEnvironmentMembership"
}
],
"DescribeEnvironmentMemberships": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
"memberships": [
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-write",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
},
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets information about all of the environment members for the specified AWS Cloud9 development environment.",
"id": "describeenvironmentmemberships1-1516823070453",
"title": "DescribeEnvironmentMemberships1"
},
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": [
"owner"
]
},
"output": {
"memberships": [
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets information about the owner of the specified AWS Cloud9 development environment.",
"id": "describeenvironmentmemberships2-1516823191355",
"title": "DescribeEnvironmentMemberships2"
},
{
"input": {
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser"
},
"output": {
"memberships": [
{
"environmentId": "10a75714bd494714929e7f5ec4125aEX",
"lastAccess": "2018-01-19T11:06:13Z",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
},
{
"environmentId": "12bfc3cd537f41cb9776f8af5525c9EX",
"lastAccess": "2018-01-19T11:39:19Z",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets AWS Cloud9 development environment membership information for the specified user.",
"id": "describeenvironmentmemberships3-1516823268793",
"title": "DescribeEnvironmentMemberships3"
}
],
"DescribeEnvironmentStatus": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
"message": "Environment is ready to use",
"status": "ready"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "describeenvironmentstatus-1516823462133",
"title": "DescribeEnvironmentStatus"
}
],
"DescribeEnvironments": [
{
"input": {
"environmentIds": [
"8d9967e2f0624182b74e7690ad69ebEX",
"349c86d4579e4e7298d500ff57a6b2EX"
]
},
"output": {
"environments": [
{
"name": "my-demo-environment",
"type": "ec2",
"arn": "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX",
"description": "This is my demonstration environment.",
"id": "8d9967e2f0624182b74e7690ad69ebEX",
"ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser"
},
{
"name": "another-demo-environment",
"type": "ssh",
"arn": "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX",
"id": "349c86d4579e4e7298d500ff57a6b2EX",
"ownerArn": "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "describeenvironments-1516823568291",
"title": "DescribeEnvironments"
}
],
"ListEnvironments": [
{
"input": {
},
"output": {
"environmentIds": [
"349c86d4579e4e7298d500ff57a6b2EX",
"45a3da47af0840f2b0c0824f5ee232EX"
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "listenvironments-1516823687205",
"title": "ListEnvironments"
}
],
"UpdateEnvironment": [
{
"input": {
"name": "my-changed-demo-environment",
"description": "This is my changed demonstration environment.",
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "updateenvironment-1516823781910",
"title": "UpdateEnvironment"
}
],
"UpdateEnvironmentMembership": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
},
"output": {
"membership": {
"environmentId": "8d9967e2f0624182b74e7690ad69eb31",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "updateenvironmentmembership-1516823876645",
"title": "UpdateEnvironmentMembership"
}
]
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -1,158 +1,5 @@
{
"version": "1.0",
"examples": {
"CancelUpdateStack": [
{
"input": {
"StackName": "MyStack"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example cancels an update of the specified stack.",
"id": "to-cancel-a-stack-update-that-is-in-progress-1472747085196",
"title": "To cancel a stack update in progress"
}
],
"UpdateStack": [
{
"input": {
"NotificationARNs": [
],
"Parameters": [
{
"ParameterKey": "KeyPairName",
"ParameterValue": "ExampleKeyPair"
},
{
"ParameterKey": "SubnetIDs",
"ParameterValue": "ExampleSubnetID1, ExampleSubnetID2"
}
],
"ResourceTypes": [
],
"StackName": "MyStack",
"Tags": [
],
"TemplateURL": "https://s3.amazonaws.com/example/updated.template"
},
"output": {
"StackId": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example updates the template and input parameters for the specified stack.",
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
"title": "To update an AWS CloudFormation stack"
},
{
"input": {
"NotificationARNs": [
],
"Parameters": [
{
"ParameterKey": "KeyPairName",
"UsePreviousValue": true
},
{
"ParameterKey": "SubnetIDs",
"ParameterValue": "SampleSubnetID1, UpdatedSampleSubnetID2"
}
],
"ResourceTypes": [
],
"StackName": "MyStack",
"Tags": [
],
"TemplateURL": "https://s3.amazonaws.com/example/updated.template"
},
"output": {
"StackId": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example updates only the the specified parameter value for the specified stack. If you don't specify a parameter value, AWS CloudFormation uses the default value from the template.",
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
"title": "To update an AWS CloudFormation stack"
},
{
"input": {
"Capabilities": [
],
"NotificationARNs": [
"arn:aws:sns:use-east-1:123456789012:mytopic1",
"arn:aws:sns:us-east-1:123456789012:mytopic2"
],
"Parameters": [
],
"ResourceTypes": [
],
"StackName": "MyStack",
"Tags": [
],
"TemplateURL": "https://s3.amazonaws.com/example/updated.template",
"UsePreviousTemplate": true
},
"output": {
"StackId": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds two stack notification topics to the specified stack.",
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
"title": "To update an AWS CloudFormation stack"
}
],
"ValidateTemplate": [
{
"input": {
"TemplateBody": "MyTemplate.json"
},
"output": {
"Capabilities": [
],
"CapabilitiesReason": "",
"Description": "AWS CloudFormation Example Template S3_Bucket: An example template that shows how to create a publicly-accessible S3 bucket. IMPORTANT: This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
"Parameters": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example validates the specified template.",
"id": "to-validate-an-aws-cloudformation-template-1472839072307",
"title": "To validate an AWS CloudFormation template"
}
]
}
}

View file

@ -95,7 +95,7 @@
{"shape":"InvalidOperationException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You must specify at least one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for <code>Regions</code>.</p>"
"documentation":"<p>Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for <code>Regions</code>.</p>"
},
"CreateStackSet":{
"name":"CreateStackSet",
@ -161,7 +161,7 @@
{"shape":"StaleRequestException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Deletes stack instances for the specified accounts, in the specified regions. </p>"
"documentation":"<p>Deletes stack instances for the specified accounts, in the specified Regions. </p>"
},
"DeleteStackSet":{
"name":"DeleteStackSet",
@ -268,7 +268,7 @@
{"shape":"StackSetNotFoundException"},
{"shape":"StackInstanceNotFoundException"}
],
"documentation":"<p>Returns the stack instance that's associated with the specified stack set, AWS account, and region.</p> <p>For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.</p>"
"documentation":"<p>Returns the stack instance that's associated with the specified stack set, AWS account, and Region.</p> <p>For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.</p>"
},
"DescribeStackResource":{
"name":"DescribeStackResource",
@ -535,7 +535,7 @@
"shape":"ListExportsOutput",
"resultWrapper":"ListExportsResult"
},
"documentation":"<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>"
"documentation":"<p>Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>"
},
"ListImports":{
"name":"ListImports",
@ -564,7 +564,7 @@
"errors":[
{"shape":"StackSetNotFoundException"}
],
"documentation":"<p>Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.</p>"
"documentation":"<p>Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region.</p>"
},
"ListStackResources":{
"name":"ListStackResources",
@ -721,7 +721,7 @@
"errors":[
{"shape":"CFNRegistryException"}
],
"documentation":"<p>Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:</p> <ul> <li> <p>Validating the resource schema</p> </li> <li> <p>Determining which handlers have been specified for the resource</p> </li> <li> <p>Making the resource type available for use in your account</p> </li> </ul> <p>For more information on how to develop types and ready them for registeration, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html\">Creating Resource Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p> <p>Once you have initiated a registration request using <code> <a>RegisterType</a> </code>, you can use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of the registration request.</p>",
"documentation":"<p>Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:</p> <ul> <li> <p>Validating the resource schema</p> </li> <li> <p>Determining which handlers have been specified for the resource</p> </li> <li> <p>Making the resource type available for use in your account</p> </li> </ul> <p>For more information on how to develop types and ready them for registeration, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html\">Creating Resource Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p> <p>You can have a maximum of 50 resource type versions registered at a time. This maximum is per account and per region. Use <a href=\"AWSCloudFormation/latest/APIReference/API_DeregisterType.html\">DeregisterType</a> to deregister specific resource type versions if necessary.</p> <p>Once you have initiated a registration request using <code> <a>RegisterType</a> </code>, you can use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of the registration request.</p>",
"idempotent":true
},
"SetStackPolicy":{
@ -814,7 +814,7 @@
{"shape":"StaleRequestException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. </p> <p>You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html\">CreateStackInstances</a>. </p> <p>During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>"
"documentation":"<p>Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. </p> <p>You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html\">CreateStackInstances</a>. </p> <p>During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>"
},
"UpdateStackSet":{
"name":"UpdateStackSet",
@ -835,7 +835,7 @@
{"shape":"InvalidOperationException"},
{"shape":"StackInstanceNotFoundException"}
],
"documentation":"<p>Updates the stack set, and associated stack instances in the specified accounts and regions.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>"
"documentation":"<p>Updates the stack set, and associated stack instances in the specified accounts and Regions.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>"
},
"UpdateTerminationProtection":{
"name":"UpdateTerminationProtection",
@ -874,14 +874,14 @@
"members":{
"Status":{
"shape":"AccountGateStatus",
"documentation":"<p>The status of the account gate function.</p> <ul> <li> <p> <code>SUCCEEDED</code>: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region. </p> </li> <li> <p> <code>FAILED</code>: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to <code>FAILED</code>. </p> </li> <li> <p> <code>SKIPPED</code>: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:</p> <ul> <li> <p>An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.</p> </li> <li> <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.</p> </li> <li> <p>Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.</p> </li> </ul> </li> </ul>"
"documentation":"<p>The status of the account gate function.</p> <ul> <li> <p> <code>SUCCEEDED</code>: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and Region. </p> </li> <li> <p> <code>FAILED</code>: The account gate function has determined that the account and Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to <code>FAILED</code>. </p> </li> <li> <p> <code>SKIPPED</code>: AWS CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:</p> <ul> <li> <p>An account gate function has not been specified for the account and Region. AWS CloudFormation proceeds with the stack set operation in this account and Region.</p> </li> <li> <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and Region.</p> </li> <li> <p>Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and Region.</p> </li> </ul> </li> </ul>"
},
"StatusReason":{
"shape":"AccountGateStatusReason",
"documentation":"<p>The reason for the account gate status assigned to this account and region for the stack set operation.</p>"
"documentation":"<p>The reason for the account gate status assigned to this account and Region for the stack set operation.</p>"
}
},
"documentation":"<p>Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.</p> <p>For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to <code>FAILED</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate</a>.</p>"
"documentation":"<p>Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.</p> <p>For each account and Region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region to <code>FAILED</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate</a>.</p>"
},
"AccountGateStatus":{
"type":"string",
@ -1268,7 +1268,7 @@
"members":{
"StackName":{
"shape":"StackName",
"documentation":"<p>The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.</p> <note> <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.</p> </note>"
"documentation":"<p>The name that is associated with the stack. The name must be unique in the Region in which you are creating the stack.</p> <note> <p>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.</p> </note>"
},
"TemplateBody":{
"shape":"TemplateBody",
@ -1320,7 +1320,7 @@
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
},
"Tags":{
"shape":"Tags",
@ -1350,7 +1350,7 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
@ -1358,11 +1358,11 @@
},
"Regions":{
"shape":"RegionList",
"documentation":"<p>The names of one or more regions where you want to create stack instances using the specified AWS account(s). </p>"
"documentation":"<p>The names of one or more Regions where you want to create stack instances using the specified AWS account(s). </p>"
},
"ParameterOverrides":{
"shape":"Parameters",
"documentation":"<p>A list of stack set parameters whose values you want to override in the selected stack instances.</p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template.</p>"
"documentation":"<p>A list of stack set parameters whose values you want to override in the selected stack instances.</p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template.</p>"
},
"OperationPreferences":{
"shape":"StackSetOperationPreferences",
@ -1400,7 +1400,7 @@
"members":{
"StackSetName":{
"shape":"StackSetName",
"documentation":"<p>The name to associate with the stack set. The name must be unique in the region where you create your stack set.</p> <note> <p>A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.</p> </note>"
"documentation":"<p>The name to associate with the stack set. The name must be unique in the Region where you create your stack set.</p> <note> <p>A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.</p> </note>"
},
"Description":{
"shape":"Description",
@ -1440,7 +1440,7 @@
},
"AutoDeployment":{
"shape":"AutoDeployment",
"documentation":"<p>Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if <code>PermissionModel</code> is <code>SERVICE_MANAGED</code>.</p> <p>If you specify <code>AutoDeployment</code>, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p>"
"documentation":"<p>Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if <code>PermissionModel</code> is <code>SERVICE_MANAGED</code>.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
@ -1529,7 +1529,7 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The names of the AWS accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
@ -1537,7 +1537,7 @@
},
"Regions":{
"shape":"RegionList",
"documentation":"<p>The regions where you want to delete stack set instances. </p>"
"documentation":"<p>The Regions where you want to delete stack set instances. </p>"
},
"OperationPreferences":{
"shape":"StackSetOperationPreferences",
@ -1588,10 +1588,10 @@
},
"OrganizationalUnitIds":{
"shape":"OrganizationalUnitIdList",
"documentation":"<p>The organization root ID or organizational unit (OUs) IDs to which StackSets deploys.</p>"
"documentation":"<p>The organization root ID or organizational unit (OU) IDs to which StackSets deploys.</p>"
}
},
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts to which StackSets deploys.</p> <p>For update operations, you can specify either <code>Accounts</code> or <code>OrganizationalUnitIds</code>. For create and delete operations, specify <code>OrganizationalUnitIds</code>.</p>"
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts to which StackSets deploys. StackSets does not deploy stack instances to the organization master account, even if the master account is in your organization or in an OU in your organization.</p> <p>For update operations, you can specify either <code>Accounts</code> or <code>OrganizationalUnitIds</code>. For create and delete operations, specify <code>OrganizationalUnitIds</code>.</p>"
},
"DeprecatedStatus":{
"type":"string",
@ -1834,7 +1834,7 @@
},
"StackInstanceRegion":{
"shape":"Region",
"documentation":"<p>The name of a region that's associated with this stack instance.</p>"
"documentation":"<p>The name of a Region that's associated with this stack instance.</p>"
}
}
},
@ -2656,7 +2656,7 @@
},
"StackInstanceRegion":{
"shape":"Region",
"documentation":"<p>The name of the region where you want to list stack instances. </p>"
"documentation":"<p>The name of the Region where you want to list stack instances. </p>"
}
}
},
@ -2732,7 +2732,7 @@
"members":{
"Summaries":{
"shape":"StackSetOperationResultSummaries",
"documentation":"<p>A list of <code>StackSetOperationResultSummary</code> structures that contain information about the specified operation results, for accounts and regions that are included in the operation.</p>"
"documentation":"<p>A list of <code>StackSetOperationResultSummary</code> structures that contain information about the specified operation results, for accounts and Regions that are included in the operation.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -3716,7 +3716,7 @@
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
"documentation":"<p>Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>"
}
},
"documentation":"<p>The input for the <a>SetStackPolicy</a> action.</p>"
@ -3997,11 +3997,11 @@
},
"Region":{
"shape":"Region",
"documentation":"<p>The name of the AWS region that the stack instance is associated with.</p>"
"documentation":"<p>The name of the AWS Region that the stack instance is associated with.</p>"
},
"Account":{
"shape":"Account",
"documentation":"<p>[Self-managed permissions] The name of the AWS account that the stack instance is associated with.</p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The name of the AWS account that the stack instance is associated with.</p>"
},
"StackId":{
"shape":"StackId",
@ -4021,7 +4021,7 @@
},
"OrganizationalUnitId":{
"shape":"OrganizationalUnitId",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.</p>"
"documentation":"<p>Reserved for internal use. No data returned.</p>"
},
"DriftStatus":{
"shape":"StackDriftStatus",
@ -4032,7 +4032,7 @@
"documentation":"<p>Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be <code>NULL</code> for any stack instance on which drift detection has not yet been performed.</p>"
}
},
"documentation":"<p>An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.</p>"
"documentation":"<p>An AWS CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.</p>"
},
"StackInstanceNotFoundException":{
"type":"structure",
@ -4067,11 +4067,11 @@
},
"Region":{
"shape":"Region",
"documentation":"<p>The name of the AWS region that the stack instance is associated with.</p>"
"documentation":"<p>The name of the AWS Region that the stack instance is associated with.</p>"
},
"Account":{
"shape":"Account",
"documentation":"<p>[Self-managed permissions] The name of the AWS account that the stack instance is associated with.</p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The name of the AWS account that the stack instance is associated with.</p>"
},
"StackId":{
"shape":"StackId",
@ -4087,7 +4087,7 @@
},
"OrganizationalUnitId":{
"shape":"OrganizationalUnitId",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.</p>"
"documentation":"<p>Reserved for internal use. No data returned.</p>"
},
"DriftStatus":{
"shape":"StackDriftStatus",
@ -4445,10 +4445,10 @@
},
"OrganizationalUnitIds":{
"shape":"OrganizationalUnitIdList",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.</p>"
"documentation":"<p>Reserved for internal use. No data returned.</p>"
}
},
"documentation":"<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. </p>"
"documentation":"<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. </p>"
},
"StackSetARN":{"type":"string"},
"StackSetDriftDetectionDetails":{
@ -4554,7 +4554,7 @@
},
"Status":{
"shape":"StackSetOperationStatus",
"documentation":"<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
"documentation":"<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [<code>Service-managed</code> permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
},
"OperationPreferences":{
"shape":"StackSetOperationPreferences",
@ -4574,11 +4574,11 @@
},
"CreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.</p>"
"documentation":"<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.</p>"
},
"EndTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.</p>"
"documentation":"<p>The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
@ -4605,15 +4605,15 @@
"members":{
"RegionOrder":{
"shape":"RegionList",
"documentation":"<p>The order of the regions in where you want to perform the stack operation.</p>"
"documentation":"<p>The order of the Regions in where you want to perform the stack operation.</p>"
},
"FailureToleranceCount":{
"shape":"FailureToleranceCount",
"documentation":"<p>The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.</p> <p>Conditional: You must specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code> (but not both).</p>"
"documentation":"<p>The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.</p> <p>Conditional: You must specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code> (but not both).</p>"
},
"FailureTolerancePercentage":{
"shape":"FailureTolerancePercentage",
"documentation":"<p>The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.</p> <p>When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds <i>down</i> to the next whole number.</p> <p>Conditional: You must specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code>, but not both.</p>"
"documentation":"<p>The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions.</p> <p>When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds <i>down</i> to the next whole number.</p> <p>Conditional: You must specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code>, but not both.</p>"
},
"MaxConcurrentCount":{
"shape":"MaxConcurrentCount",
@ -4645,15 +4645,15 @@
"members":{
"Account":{
"shape":"Account",
"documentation":"<p>[Self-managed permissions] The name of the AWS account for this operation result.</p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The name of the AWS account for this operation result.</p>"
},
"Region":{
"shape":"Region",
"documentation":"<p>The name of the AWS region for this operation result.</p>"
"documentation":"<p>The name of the AWS Region for this operation result.</p>"
},
"Status":{
"shape":"StackSetOperationResultStatus",
"documentation":"<p>The result status of the stack set operation for the given account in the given region.</p> <ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and region failed. </p> <p>If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set operation as a whole might be exceeded. </p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and region is currently in progress.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and region has yet to start. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and region completed successfully.</p> </li> </ul>"
"documentation":"<p>The result status of the stack set operation for the given account in the given Region.</p> <ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and Region failed. </p> <p>If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded. </p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and Region is currently in progress.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and Region has yet to start. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p> </li> </ul>"
},
"StatusReason":{
"shape":"Reason",
@ -4665,10 +4665,10 @@
},
"OrganizationalUnitId":{
"shape":"OrganizationalUnitId",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) ID for this operation result.</p>"
"documentation":"<p>Reserved for internal use. No data returned.</p>"
}
},
"documentation":"<p>The structure that contains information about a specified operation's results for a given account in a given region.</p>"
"documentation":"<p>The structure that contains information about a specified operation's results for a given account in a given Region.</p>"
},
"StackSetOperationStatus":{
"type":"string",
@ -4698,15 +4698,15 @@
},
"Status":{
"shape":"StackSetOperationStatus",
"documentation":"<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
"documentation":"<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [<code>Service-managed</code> permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
},
"CreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.</p>"
"documentation":"<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.</p>"
},
"EndTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.</p>"
"documentation":"<p>The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.</p>"
}
},
"documentation":"<p>The structures that contain summary information about the specified operation.</p>"
@ -5128,7 +5128,7 @@
},
"StackPolicyDuringUpdateURL":{
"shape":"StackPolicyDuringUpdateURL",
"documentation":"<p>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p> <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.</p>"
"documentation":"<p>Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p> <p>If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.</p>"
},
"Parameters":{
"shape":"Parameters",
@ -5156,7 +5156,7 @@
},
"StackPolicyURL":{
"shape":"StackPolicyURL",
"documentation":"<p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</p>"
"documentation":"<p>Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</p>"
},
"NotificationARNs":{
"shape":"NotificationARNs",
@ -5186,7 +5186,7 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
@ -5194,11 +5194,11 @@
},
"Regions":{
"shape":"RegionList",
"documentation":"<p>The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
"documentation":"<p>The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.</p>"
},
"ParameterOverrides":{
"shape":"Parameters",
"documentation":"<p> A list of input parameters whose values you want to update for the specified stack instances. </p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>"
"documentation":"<p> A list of input parameters whose values you want to update for the specified stack instances. </p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>"
},
"OperationPreferences":{
"shape":"StackSetOperationPreferences",
@ -5297,11 +5297,11 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
"documentation":"<p>[<code>Self-managed</code> permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status. </p>"
},
"Regions":{
"shape":"RegionList",
"documentation":"<p>The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
"documentation":"<p>The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status. </p>"
}
}
},

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -344,7 +344,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceFault"}
],
"documentation":"<p>Displays the tags associated with a CloudWatch resource. Alarms support tagging.</p>"
"documentation":"<p>Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.</p>"
},
"PutAnomalyDetector":{
"name":"PutAnomalyDetector",
@ -469,7 +469,7 @@
{"shape":"ConcurrentModificationException"},
{"shape":"InternalServiceFault"}
],
"documentation":"<p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a resource.</p>"
"documentation":"<p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.</p> <p>You can use the <code>TagResource</code> action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a CloudWatch resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -594,7 +594,7 @@
"documentation":"<p>The metric dimensions associated with the anomaly detection model.</p>"
},
"Stat":{
"shape":"Stat",
"shape":"AnomalyDetectorMetricStat",
"documentation":"<p>The statistic associated with the anomaly detection model.</p>"
},
"Configuration":{
@ -626,7 +626,15 @@
"type":"list",
"member":{"shape":"Range"}
},
"AnomalyDetectorMetricTimezone":{"type":"string"},
"AnomalyDetectorMetricStat":{
"type":"string",
"pattern":"(SampleCount|Average|Sum|Minimum|Maximum|p(\\d{1,2}|100)(\\.\\d{0,2})?|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?"
},
"AnomalyDetectorMetricTimezone":{
"type":"string",
"max":50,
"pattern":".*"
},
"AnomalyDetectorStateValue":{
"type":"string",
"enum":[
@ -927,7 +935,7 @@
"documentation":"<p>The metric dimensions associated with the anomaly detection model to delete.</p>"
},
"Stat":{
"shape":"Stat",
"shape":"AnomalyDetectorMetricStat",
"documentation":"<p>The statistic associated with the anomaly detection model to delete.</p>"
}
}
@ -1945,7 +1953,7 @@
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-cloudwatch\">Example ARNs</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The ARN of the CloudWatch resource that you want to view tags for.</p> <p>The ARN format of an alarm is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i> </code> </p> <p>The ARN format of a Contributor Insights rule is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule:<i>insight-rule-name</i> </code> </p> <p>For more information on ARN format, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies\"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General Reference</i>.</p>"
}
}
},
@ -2395,7 +2403,7 @@
"documentation":"<p>The metric dimensions to create the anomaly detection model for.</p>"
},
"Stat":{
"shape":"Stat",
"shape":"AnomalyDetectorMetricStat",
"documentation":"<p>The statistic to use for the metric and the anomaly detection model.</p>"
},
"Configuration":{
@ -2494,6 +2502,10 @@
"RuleDefinition":{
"shape":"InsightRuleDefinition",
"documentation":"<p>The definition of the rule, as a JSON object. For details on the valid syntax, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html\">Contributor Insights Rule Syntax</a>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.</p> <p>To be able to associate tags with a rule, you must have the <code>cloudwatch:TagResource</code> permission in addition to the <code>cloudwatch:PutInsightRule</code> permission.</p> <p>If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html\">TagResource</a>.</p>"
}
}
},
@ -2863,7 +2875,7 @@
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the CloudWatch alarm that you're adding tags to. The ARN format is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i> </code> </p>"
"documentation":"<p>The ARN of the CloudWatch resource that you're adding tags to.</p> <p>The ARN format of an alarm is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i> </code> </p> <p>The ARN format of a Contributor Insights rule is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule:<i>insight-rule-name</i> </code> </p> <p>For more information on ARN format, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies\"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"Tags":{
"shape":"TagList",
@ -2901,7 +2913,7 @@
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-cloudwatch\">Example ARNs</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The ARN of the CloudWatch resource that you're removing tags from.</p> <p>The ARN format of an alarm is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i> </code> </p> <p>The ARN format of a Contributor Insights rule is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule:<i>insight-rule-name</i> </code> </p> <p>For more information on ARN format, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies\"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"TagKeys":{
"shape":"TagKeyList",

View file

@ -1,5 +1,281 @@
{
"version": "1.0",
"examples": {
"BatchGetBuilds": [
{
"input": {
"ids": [
"codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX"
]
},
"output": {
"builds": [
{
"arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"artifacts": {
"location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project"
},
"buildComplete": true,
"buildStatus": "SUCCEEDED",
"currentPhase": "COMPLETED",
"endTime": 1479832474.764,
"environment": {
"type": "LINUX_CONTAINER",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [
],
"image": "aws/codebuild/java:openjdk-8",
"privilegedMode": false
},
"id": "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"initiator": "MyDemoUser",
"logs": {
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"groupName": "/aws/codebuild/codebuild-demo-project",
"streamName": "9b0ac37f-d19e-4254-9079-f47e9a389eEX"
},
"phases": [
{
"durationInSeconds": 0,
"endTime": 1479832342.23,
"phaseStatus": "SUCCEEDED",
"phaseType": "SUBMITTED",
"startTime": 1479832341.854
},
{
"contexts": [
],
"durationInSeconds": 72,
"endTime": 1479832415.064,
"phaseStatus": "SUCCEEDED",
"phaseType": "PROVISIONING",
"startTime": 1479832342.23
},
{
"contexts": [
],
"durationInSeconds": 46,
"endTime": 1479832461.261,
"phaseStatus": "SUCCEEDED",
"phaseType": "DOWNLOAD_SOURCE",
"startTime": 1479832415.064
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832461.354,
"phaseStatus": "SUCCEEDED",
"phaseType": "INSTALL",
"startTime": 1479832461.261
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832461.448,
"phaseStatus": "SUCCEEDED",
"phaseType": "PRE_BUILD",
"startTime": 1479832461.354
},
{
"contexts": [
],
"durationInSeconds": 9,
"endTime": 1479832471.115,
"phaseStatus": "SUCCEEDED",
"phaseType": "BUILD",
"startTime": 1479832461.448
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832471.224,
"phaseStatus": "SUCCEEDED",
"phaseType": "POST_BUILD",
"startTime": 1479832471.115
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832471.791,
"phaseStatus": "SUCCEEDED",
"phaseType": "UPLOAD_ARTIFACTS",
"startTime": 1479832471.224
},
{
"contexts": [
],
"durationInSeconds": 2,
"endTime": 1479832474.764,
"phaseStatus": "SUCCEEDED",
"phaseType": "FINALIZING",
"startTime": 1479832471.791
},
{
"phaseType": "COMPLETED",
"startTime": 1479832474.764
}
],
"projectName": "codebuild-demo-project",
"source": {
"type": "S3",
"buildspec": "",
"location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip"
},
"startTime": 1479832341.854,
"timeoutInMinutes": 60
},
{
"arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX",
"artifacts": {
"location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project"
},
"buildComplete": true,
"buildStatus": "SUCCEEDED",
"currentPhase": "COMPLETED",
"endTime": 1479401214.239,
"environment": {
"type": "LINUX_CONTAINER",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [
],
"image": "aws/codebuild/java:openjdk-8",
"privilegedMode": false
},
"id": "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX",
"initiator": "MyDemoUser",
"logs": {
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=b79a46f7-1473-4636-a23f-da9c45c208EX",
"groupName": "/aws/codebuild/codebuild-demo-project",
"streamName": "b79a46f7-1473-4636-a23f-da9c45c208EX"
},
"phases": [
{
"durationInSeconds": 0,
"endTime": 1479401082.342,
"phaseStatus": "SUCCEEDED",
"phaseType": "SUBMITTED",
"startTime": 1479401081.869
},
{
"contexts": [
],
"durationInSeconds": 71,
"endTime": 1479401154.129,
"phaseStatus": "SUCCEEDED",
"phaseType": "PROVISIONING",
"startTime": 1479401082.342
},
{
"contexts": [
],
"durationInSeconds": 45,
"endTime": 1479401199.136,
"phaseStatus": "SUCCEEDED",
"phaseType": "DOWNLOAD_SOURCE",
"startTime": 1479401154.129
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401199.236,
"phaseStatus": "SUCCEEDED",
"phaseType": "INSTALL",
"startTime": 1479401199.136
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401199.345,
"phaseStatus": "SUCCEEDED",
"phaseType": "PRE_BUILD",
"startTime": 1479401199.236
},
{
"contexts": [
],
"durationInSeconds": 9,
"endTime": 1479401208.68,
"phaseStatus": "SUCCEEDED",
"phaseType": "BUILD",
"startTime": 1479401199.345
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401208.783,
"phaseStatus": "SUCCEEDED",
"phaseType": "POST_BUILD",
"startTime": 1479401208.68
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401209.463,
"phaseStatus": "SUCCEEDED",
"phaseType": "UPLOAD_ARTIFACTS",
"startTime": 1479401208.783
},
{
"contexts": [
],
"durationInSeconds": 4,
"endTime": 1479401214.239,
"phaseStatus": "SUCCEEDED",
"phaseType": "FINALIZING",
"startTime": 1479401209.463
},
{
"phaseType": "COMPLETED",
"startTime": 1479401214.239
}
],
"projectName": "codebuild-demo-project",
"source": {
"type": "S3",
"location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip"
},
"startTime": 1479401081.869,
"timeoutInMinutes": 60
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets information about builds with the specified build IDs.",
"id": "to-get-information-about-builds-1501187184588",
"title": "To get information about builds"
}
]
}
}

View file

@ -28,7 +28,41 @@
{"shape":"ConflictException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request. You can view recommendations in the AWS CodeCommit repository.</p> <p>You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.</p>"
"documentation":"<p>Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.</p> <p>You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.</p>"
},
"DescribeCodeReview":{
"name":"DescribeCodeReview",
"http":{
"method":"GET",
"requestUri":"/codereviews/{CodeReviewArn}"
},
"input":{"shape":"DescribeCodeReviewRequest"},
"output":{"shape":"DescribeCodeReviewResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Returns the metadaata associated with the code review along with its status.</p>"
},
"DescribeRecommendationFeedback":{
"name":"DescribeRecommendationFeedback",
"http":{
"method":"GET",
"requestUri":"/feedback/{CodeReviewArn}"
},
"input":{"shape":"DescribeRecommendationFeedbackRequest"},
"output":{"shape":"DescribeRecommendationFeedbackResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Describes the customer feedback for a CodeGuru Reviewer recommendation. </p>"
},
"DescribeRepositoryAssociation":{
"name":"DescribeRepositoryAssociation",
@ -65,6 +99,56 @@
],
"documentation":"<p>Removes the association between Amazon CodeGuru Reviewer and a repository.</p>"
},
"ListCodeReviews":{
"name":"ListCodeReviews",
"http":{
"method":"GET",
"requestUri":"/codereviews"
},
"input":{"shape":"ListCodeReviewsRequest"},
"output":{"shape":"ListCodeReviewsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p> Lists all the code reviews that the customer has created in the past 90 days. </p>"
},
"ListRecommendationFeedback":{
"name":"ListRecommendationFeedback",
"http":{
"method":"GET",
"requestUri":"/feedback/{CodeReviewArn}/RecommendationFeedback"
},
"input":{"shape":"ListRecommendationFeedbackRequest"},
"output":{"shape":"ListRecommendationFeedbackResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations. </p>"
},
"ListRecommendations":{
"name":"ListRecommendations",
"http":{
"method":"GET",
"requestUri":"/codereviews/{CodeReviewArn}/Recommendations"
},
"input":{"shape":"ListRecommendationsRequest"},
"output":{"shape":"ListRecommendationsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Returns the list of all recommendations for a completed code review. </p>"
},
"ListRepositoryAssociations":{
"name":"ListRepositoryAssociations",
"http":{
@ -79,6 +163,23 @@
{"shape":"ThrottlingException"}
],
"documentation":"<p>Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.</p>"
},
"PutRecommendationFeedback":{
"name":"PutRecommendationFeedback",
"http":{
"method":"PUT",
"requestUri":"/feedback"
},
"input":{"shape":"PutRecommendationFeedbackRequest"},
"output":{"shape":"PutRecommendationFeedbackResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Stores customer feedback for a CodeGuru-Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. </p>"
}
},
"shapes":{
@ -95,7 +196,7 @@
"type":"string",
"max":1600,
"min":1,
"pattern":"^arn:aws[^:\\s]*:codeguru-reviewer:[^:\\s]+:[\\d]{12}:[a-z]+:[\\w-]+$"
"pattern":"^arn:aws[^:\\s]*:codeguru-reviewer:[^:\\s]+:[\\d]{12}:[a-z-]+:[\\w-]+$"
},
"AssociateRepositoryRequest":{
"type":"structure",
@ -107,7 +208,7 @@
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p> <p>If you want to add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.</p> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.</p> <p>You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.</p> <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries. </p>",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p> <p>To add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.</p> <p>If you use the AWS CLI or one of the AWS SDKs to call this operation, you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, you must generate a ClientRequestToken yourself for new versions and include that value in the request.</p> <p>You typically interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.</p> <p>Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries. </p>",
"idempotencyToken":true
}
}
@ -143,6 +244,137 @@
},
"documentation":"<p>Information about an AWS CodeCommit repository.</p>"
},
"CodeReview":{
"type":"structure",
"members":{
"Name":{
"shape":"Name",
"documentation":"<p> The name of the code review. </p>"
},
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>"
},
"RepositoryName":{
"shape":"Name",
"documentation":"<p> The name of the repository. </p>"
},
"Owner":{
"shape":"Owner",
"documentation":"<p> The owner of the repository. </p>"
},
"ProviderType":{
"shape":"ProviderType",
"documentation":"<p> The provider type of the repository association. </p>"
},
"State":{
"shape":"JobState",
"documentation":"<p> The state of the code review. </p>"
},
"StateReason":{
"shape":"StateReason",
"documentation":"<p> The reason for the state of the code review. </p>"
},
"CreatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time, in milliseconds since the epoch, when the code review was created. </p>"
},
"LastUpdatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time, in milliseconds since the epoch, when the code review was last updated. </p>"
},
"Type":{
"shape":"Type",
"documentation":"<p> The type of code review. </p>"
},
"PullRequestId":{
"shape":"PullRequestId",
"documentation":"<p> The pull request ID for the code review. </p>"
},
"SourceCodeType":{
"shape":"SourceCodeType",
"documentation":"<p> The type of the source code for the code review. </p>"
},
"Metrics":{
"shape":"Metrics",
"documentation":"<p> The statistics from the code review. </p>"
}
},
"documentation":"<p> Information about a code review. </p>"
},
"CodeReviewSummaries":{
"type":"list",
"member":{"shape":"CodeReviewSummary"}
},
"CodeReviewSummary":{
"type":"structure",
"members":{
"Name":{
"shape":"Name",
"documentation":"<p> The name of the code review. </p>"
},
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>"
},
"RepositoryName":{
"shape":"Name",
"documentation":"<p> The name of the repository. </p>"
},
"Owner":{
"shape":"Owner",
"documentation":"<p> The owner of the repository. </p>"
},
"ProviderType":{
"shape":"ProviderType",
"documentation":"<p> The provider type of the repository association. </p>"
},
"State":{
"shape":"JobState",
"documentation":"<p> The state of the code review. </p>"
},
"CreatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time, in milliseconds since the epoch, when the code review was created. </p>"
},
"LastUpdatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time, in milliseconds since the epoch, when the code review was last updated. </p>"
},
"Type":{
"shape":"Type",
"documentation":"<p> The type of the code review. </p>"
},
"PullRequestId":{
"shape":"PullRequestId",
"documentation":"<p> The pull request ID for the code review. </p>"
},
"MetricsSummary":{
"shape":"MetricsSummary",
"documentation":"<p> The statistics from the code review. </p>"
}
},
"documentation":"<p> Information about the summary of the code review. </p>"
},
"CommitDiffSourceCodeType":{
"type":"structure",
"members":{
"SourceCommit":{
"shape":"CommitId",
"documentation":"<p> Source Commit SHA. </p>"
},
"DestinationCommit":{
"shape":"CommitId",
"documentation":"<p> Destination Commit SHA </p>"
}
},
"documentation":"<p> The commit diff for the pull request. </p>"
},
"CommitId":{
"type":"string",
"max":64,
"min":6
},
"ConflictException":{
"type":"structure",
"members":{
@ -152,13 +384,70 @@
"error":{"httpStatusCode":409},
"exception":true
},
"DescribeCodeReviewRequest":{
"type":"structure",
"required":["CodeReviewArn"],
"members":{
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
}
}
},
"DescribeCodeReviewResponse":{
"type":"structure",
"members":{
"CodeReview":{
"shape":"CodeReview",
"documentation":"<p> Information about the code review. </p>"
}
}
},
"DescribeRecommendationFeedbackRequest":{
"type":"structure",
"required":[
"CodeReviewArn",
"RecommendationId"
],
"members":{
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. </p>",
"location":"querystring",
"locationName":"RecommendationId"
},
"UserId":{
"shape":"UserId",
"documentation":"<p> Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request. </p>",
"location":"querystring",
"locationName":"UserId"
}
}
},
"DescribeRecommendationFeedbackResponse":{
"type":"structure",
"members":{
"RecommendationFeedback":{
"shape":"RecommendationFeedback",
"documentation":"<p> The recommendation feedback given by the user. </p>"
}
}
},
"DescribeRepositoryAssociationRequest":{
"type":"structure",
"required":["AssociationArn"],
"members":{
"AssociationArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) identifying the association.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling <code>ListRepositories</code>.</p>",
"location":"uri",
"locationName":"AssociationArn"
}
@ -195,6 +484,12 @@
}
},
"ErrorMessage":{"type":"string"},
"FilePath":{
"type":"string",
"max":1024,
"min":1
},
"FindingsCount":{"type":"long"},
"InternalServerException":{
"type":"structure",
"members":{
@ -205,6 +500,168 @@
"exception":true,
"fault":true
},
"JobState":{
"type":"string",
"enum":[
"Completed",
"Pending",
"Failed",
"Deleting"
]
},
"JobStates":{
"type":"list",
"member":{"shape":"JobState"},
"max":3,
"min":1
},
"LineNumber":{"type":"integer"},
"ListCodeReviewsMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"ListCodeReviewsRequest":{
"type":"structure",
"required":["Type"],
"members":{
"ProviderTypes":{
"shape":"ProviderTypes",
"documentation":"<p> List of provider types for filtering that needs to be applied before displaying the result. For example, \"providerTypes=[GitHub]\" will list code reviews from GitHub. </p>",
"location":"querystring",
"locationName":"ProviderTypes"
},
"States":{
"shape":"JobStates",
"documentation":"<p> List of states for filtering that needs to be applied before displaying the result. For example, \"states=[Pending]\" will list code reviews in the Pending state. </p>",
"location":"querystring",
"locationName":"States"
},
"RepositoryNames":{
"shape":"RepositoryNames",
"documentation":"<p> List of repository names for filtering that needs to be applied before displaying the result. </p>",
"location":"querystring",
"locationName":"RepositoryNames"
},
"Type":{
"shape":"Type",
"documentation":"<p> The type of code reviews to list in the response. </p>",
"location":"querystring",
"locationName":"Type"
},
"MaxResults":{
"shape":"ListCodeReviewsMaxResults",
"documentation":"<p> The maximum number of results that are returned per call. The default is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>",
"location":"querystring",
"locationName":"NextToken"
}
}
},
"ListCodeReviewsResponse":{
"type":"structure",
"members":{
"CodeReviewSummaries":{
"shape":"CodeReviewSummaries",
"documentation":"<p> A list of code reviews that meet the criteria of the request. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. </p>"
}
}
},
"ListRecommendationFeedbackRequest":{
"type":"structure",
"required":["CodeReviewArn"],
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p> If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p> The maximum number of results that are returned per call. The default is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
},
"UserIds":{
"shape":"UserIds",
"documentation":"<p> Filter on userIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a code review from a given user. </p>",
"location":"querystring",
"locationName":"UserIds"
},
"RecommendationIds":{
"shape":"RecommendationIds",
"documentation":"<p> Filter on recommendationIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a given recommendation. </p>",
"location":"querystring",
"locationName":"RecommendationIds"
}
}
},
"ListRecommendationFeedbackResponse":{
"type":"structure",
"members":{
"RecommendationFeedbackSummaries":{
"shape":"RecommendationFeedbackSummaries",
"documentation":"<p> Recommendation feedback summaries corresponding to the code reivew ARN. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>"
}
}
},
"ListRecommendationsRequest":{
"type":"structure",
"required":["CodeReviewArn"],
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. </p>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p> The maximum number of results that are returned per call. The default is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>",
"location":"uri",
"locationName":"CodeReviewArn"
}
}
},
"ListRecommendationsResponse":{
"type":"structure",
"members":{
"RecommendationSummaries":{
"shape":"RecommendationSummaries",
"documentation":"<p> List of recommendations for the requested code review. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. </p>"
}
}
},
"ListRepositoryAssociationsRequest":{
"type":"structure",
"members":{
@ -222,25 +679,25 @@
},
"Names":{
"shape":"Names",
"documentation":"<p>List of names to use as a filter.</p>",
"documentation":"<p>List of repository names to use as a filter.</p>",
"location":"querystring",
"locationName":"Name"
},
"Owners":{
"shape":"Owners",
"documentation":"<p>List of owners to use as a filter. For AWS CodeCommit, the owner is the AWS account id. For GitHub, it is the GitHub account name.</p>",
"documentation":"<p>List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository.</p>",
"location":"querystring",
"locationName":"Owner"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of repository association results returned by <code>ListRepositoryAssociations</code> in paginated output. When this parameter is used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRepositoryAssociations</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListRepositoryAssociations</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>",
"documentation":"<p>The maximum number of repository association results returned by <code>ListRepositoryAssociations</code> in paginated output. When this parameter is used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results in a single page with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRepositoryAssociations</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 25. If this parameter is not used, <code>ListRepositoryAssociations</code> returns up to 25 results and a <code>nextToken</code> value if applicable. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRepositoryAssociations</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRepositoryAssociations</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"location":"querystring",
"locationName":"NextToken"
}
@ -264,10 +721,40 @@
"max":100,
"min":1
},
"MeteredLinesOfCodeCount":{"type":"long"},
"Metrics":{
"type":"structure",
"members":{
"MeteredLinesOfCodeCount":{
"shape":"MeteredLinesOfCodeCount",
"documentation":"<p> Lines of code metered in the code review. </p>"
},
"FindingsCount":{
"shape":"FindingsCount",
"documentation":"<p> Total number of recommendations found in the code review. </p>"
}
},
"documentation":"<p> Information about the statistics from the code review. </p>"
},
"MetricsSummary":{
"type":"structure",
"members":{
"MeteredLinesOfCodeCount":{
"shape":"MeteredLinesOfCodeCount",
"documentation":"<p> Lines of code metered in the code review. </p>"
},
"FindingsCount":{
"shape":"FindingsCount",
"documentation":"<p> Total number of recommendations found in the code review. </p>"
}
},
"documentation":"<p> Information about metrics summaries. </p>"
},
"Name":{
"type":"string",
"max":100,
"min":1
"min":1,
"pattern":"^\\S[\\w.-]*$"
},
"Names":{
"type":"list",
@ -292,7 +779,8 @@
"Owner":{
"type":"string",
"max":100,
"min":1
"min":1,
"pattern":"^\\S(.*\\S)?$"
},
"Owners":{
"type":"list",
@ -313,6 +801,144 @@
"max":3,
"min":1
},
"PullRequestId":{
"type":"string",
"max":64,
"min":1
},
"PutRecommendationFeedbackRequest":{
"type":"structure",
"required":[
"CodeReviewArn",
"RecommendationId",
"Reactions"
],
"members":{
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations and then to collect the feedback. </p>"
},
"Reactions":{
"shape":"Reactions",
"documentation":"<p> List for storing reactions. Reactions are utf-8 text code for emojis. If you send an empty list it clears all your feedback. </p>"
}
}
},
"PutRecommendationFeedbackResponse":{
"type":"structure",
"members":{
}
},
"Reaction":{
"type":"string",
"enum":[
"ThumbsUp",
"ThumbsDown"
]
},
"Reactions":{
"type":"list",
"member":{"shape":"Reaction"},
"max":1,
"min":0
},
"RecommendationFeedback":{
"type":"structure",
"members":{
"CodeReviewArn":{
"shape":"Arn",
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. </p>"
},
"Reactions":{
"shape":"Reactions",
"documentation":"<p> List for storing reactions. Reactions are utf-8 text code for emojis. You can send an empty list to clear off all your feedback. </p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p> The user principal that made the API call. </p>"
},
"CreatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time at which the feedback was created. </p>"
},
"LastUpdatedTimeStamp":{
"shape":"TimeStamp",
"documentation":"<p> The time at which the feedback was last updated. </p>"
}
},
"documentation":"<p> Information about the recommendation feedback. </p>"
},
"RecommendationFeedbackSummaries":{
"type":"list",
"member":{"shape":"RecommendationFeedbackSummary"}
},
"RecommendationFeedbackSummary":{
"type":"structure",
"members":{
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. </p>"
},
"Reactions":{
"shape":"Reactions",
"documentation":"<p> List for storing reactions. Reactions are utf-8 text code for emojis. </p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p> The identifier for the user that gave the feedback. </p>"
}
},
"documentation":"<p> Information about recommendation feedback summaries. </p>"
},
"RecommendationId":{
"type":"string",
"max":64,
"min":1
},
"RecommendationIds":{
"type":"list",
"member":{"shape":"RecommendationId"},
"max":100,
"min":1
},
"RecommendationSummaries":{
"type":"list",
"member":{"shape":"RecommendationSummary"}
},
"RecommendationSummary":{
"type":"structure",
"members":{
"FilePath":{
"shape":"FilePath",
"documentation":"<p>Name of the file on which a recommendation is provided.</p>"
},
"RecommendationId":{
"shape":"RecommendationId",
"documentation":"<p> The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback. </p>"
},
"StartLine":{
"shape":"LineNumber",
"documentation":"<p> Start line from where the recommendation is applicable in the source commit or source branch. </p>"
},
"EndLine":{
"shape":"LineNumber",
"documentation":"<p> Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values will be the same. </p>"
},
"Description":{
"shape":"Text",
"documentation":"<p> A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line. </p>"
}
},
"documentation":"<p> Information about recommendations. </p>"
},
"Repository":{
"type":"structure",
"members":{
@ -328,7 +954,7 @@
"members":{
"AssociationId":{
"shape":"AssociationId",
"documentation":"<p>The id of the repository association.</p>"
"documentation":"<p>The ID of the repository association.</p>"
},
"AssociationArn":{
"shape":"Arn",
@ -413,16 +1039,46 @@
},
"State":{
"shape":"RepositoryAssociationState",
"documentation":"<p>The state of the repository association.</p> <dl> <dt>Associated</dt> <dd> <p>Amazon CodeGuru Reviewer is associated with the repository. </p> </dd> <dt>Associating</dt> <dd> <p>The association is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The association failed. For more information about troubleshooting (or why it failed), see [troubleshooting topic]. </p> </dd> <dt>Disassociating</dt> <dd> <p>Amazon CodeGuru Reviewer is in the process of disassociating with the repository. </p> </dd> </dl>"
"documentation":"<p>The state of the repository association.</p> <dl> <dt>Associated</dt> <dd> <p>Amazon CodeGuru Reviewer is associated with the repository. </p> </dd> <dt>Associating</dt> <dd> <p>The association is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The association failed. </p> </dd> <dt>Disassociating</dt> <dd> <p>Amazon CodeGuru Reviewer is in the process of disassociating with the repository. </p> </dd> </dl>"
}
},
"documentation":"<p>Information about a repository association.</p>"
},
"RepositoryNames":{
"type":"list",
"member":{"shape":"Name"},
"max":100,
"min":1
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p> The resource specified in the request was not found. </p>",
"error":{"httpStatusCode":404},
"exception":true
},
"SourceCodeType":{
"type":"structure",
"members":{
"CommitDiff":{
"shape":"CommitDiffSourceCodeType",
"documentation":"<p> The commit diff for the pull request. </p>"
}
},
"documentation":"<p> Information about the source code type. </p>"
},
"StateReason":{
"type":"string",
"max":256,
"min":0
},
"Text":{
"type":"string",
"max":2048,
"min":1
},
"ThrottlingException":{
"type":"structure",
"members":{
@ -433,6 +1089,21 @@
"exception":true
},
"TimeStamp":{"type":"timestamp"},
"Type":{
"type":"string",
"enum":["PullRequest"]
},
"UserId":{
"type":"string",
"max":256,
"min":1
},
"UserIds":{
"type":"list",
"member":{"shape":"UserId"},
"max":100,
"min":1
},
"ValidationException":{
"type":"structure",
"members":{

View file

@ -1,3 +1,10 @@
{
"pagination": {}
"pagination": {
"ListProfileTimes": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "profileTimes"
}
}
}

View file

@ -83,6 +83,22 @@
],
"documentation":"<p>Describes a profiling group.</p>"
},
"GetPolicy":{
"name":"GetPolicy",
"http":{
"method":"GET",
"requestUri":"/profilingGroups/{profilingGroupName}/policy",
"responseCode":200
},
"input":{"shape":"GetPolicyRequest"},
"output":{"shape":"GetPolicyResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets the profiling group policy.</p>"
},
"GetProfile":{
"name":"GetProfile",
"http":{
@ -149,6 +165,43 @@
],
"documentation":"<p/>"
},
"PutPermission":{
"name":"PutPermission",
"http":{
"method":"PUT",
"requestUri":"/profilingGroups/{profilingGroupName}/policy/{actionGroup}",
"responseCode":200
},
"input":{"shape":"PutPermissionRequest"},
"output":{"shape":"PutPermissionResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Provides permission to the principals. This overwrites the existing permissions, and is not additive.</p>",
"idempotent":true
},
"RemovePermission":{
"name":"RemovePermission",
"http":{
"method":"DELETE",
"requestUri":"/profilingGroups/{profilingGroupName}/policy/{actionGroup}",
"responseCode":200
},
"input":{"shape":"RemovePermissionRequest"},
"output":{"shape":"RemovePermissionResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes statement for the provided action group from the policy.</p>"
},
"UpdateProfilingGroup":{
"name":"UpdateProfilingGroup",
"http":{
@ -170,6 +223,10 @@
}
},
"shapes":{
"ActionGroup":{
"type":"string",
"enum":["agentPermissions"]
},
"AgentConfiguration":{
"type":"structure",
"required":[
@ -362,6 +419,37 @@
"min":1,
"pattern":"^[\\w-.:/]+$"
},
"GetPolicyRequest":{
"type":"structure",
"required":["profilingGroupName"],
"members":{
"profilingGroupName":{
"shape":"ProfilingGroupName",
"documentation":"<p>The name of the profiling group.</p>",
"location":"uri",
"locationName":"profilingGroupName"
}
},
"documentation":"<p>The structure representing the getPolicyRequest.</p>"
},
"GetPolicyResponse":{
"type":"structure",
"required":[
"policy",
"revisionId"
],
"members":{
"policy":{
"shape":"String",
"documentation":"<p>The resource-based policy attached to the <code>ProfilingGroup</code>.</p>"
},
"revisionId":{
"shape":"RevisionId",
"documentation":"<p>A unique identifier for the current revision of the policy.</p>"
}
},
"documentation":"<p>The structure representing the getPolicyResponse.</p>"
},
"GetProfileRequest":{
"type":"structure",
"required":["profilingGroupName"],
@ -630,6 +718,13 @@
},
"documentation":"<p>The structure representing the postAgentProfileResponse.</p>"
},
"Principal":{"type":"string"},
"Principals":{
"type":"list",
"member":{"shape":"Principal"},
"max":50,
"min":1
},
"ProfileTime":{
"type":"structure",
"members":{
@ -707,6 +802,102 @@
},
"documentation":"<p>Information about the profiling status.</p>"
},
"PutPermissionRequest":{
"type":"structure",
"required":[
"actionGroup",
"principals",
"profilingGroupName"
],
"members":{
"actionGroup":{
"shape":"ActionGroup",
"documentation":"<p>The list of actions that the users and roles can perform on the profiling group.</p>",
"location":"uri",
"locationName":"actionGroup"
},
"principals":{
"shape":"Principals",
"documentation":"<p>The list of role and user ARNs or the accountId that needs access (wildcards are not allowed).</p>"
},
"profilingGroupName":{
"shape":"ProfilingGroupName",
"documentation":"<p>The name of the profiling group.</p>",
"location":"uri",
"locationName":"profilingGroupName"
},
"revisionId":{
"shape":"RevisionId",
"documentation":"<p>A unique identifier for the current revision of the policy. This is required, if a policy exists for the profiling group. This is not required when creating the policy for the first time.</p>"
}
},
"documentation":"<p>The structure representing the putPermissionRequest.</p>"
},
"PutPermissionResponse":{
"type":"structure",
"required":[
"policy",
"revisionId"
],
"members":{
"policy":{
"shape":"String",
"documentation":"<p>The resource-based policy.</p>"
},
"revisionId":{
"shape":"RevisionId",
"documentation":"<p>A unique identifier for the current revision of the policy.</p>"
}
},
"documentation":"<p>The structure representing the putPermissionResponse.</p>"
},
"RemovePermissionRequest":{
"type":"structure",
"required":[
"actionGroup",
"profilingGroupName",
"revisionId"
],
"members":{
"actionGroup":{
"shape":"ActionGroup",
"documentation":"<p>The list of actions that the users and roles can perform on the profiling group.</p>",
"location":"uri",
"locationName":"actionGroup"
},
"profilingGroupName":{
"shape":"ProfilingGroupName",
"documentation":"<p>The name of the profiling group.</p>",
"location":"uri",
"locationName":"profilingGroupName"
},
"revisionId":{
"shape":"RevisionId",
"documentation":"<p>A unique identifier for the current revision of the policy.</p>",
"location":"querystring",
"locationName":"revisionId"
}
},
"documentation":"<p>The structure representing the removePermissionRequest.</p>"
},
"RemovePermissionResponse":{
"type":"structure",
"required":[
"policy",
"revisionId"
],
"members":{
"policy":{
"shape":"String",
"documentation":"<p>The resource-based policy.</p>"
},
"revisionId":{
"shape":"RevisionId",
"documentation":"<p>A unique identifier for the current revision of the policy.</p>"
}
},
"documentation":"<p>The structure representing the removePermissionResponse.</p>"
},
"ResourceNotFoundException":{
"type":"structure",
"required":["message"],
@ -720,6 +911,10 @@
},
"exception":true
},
"RevisionId":{
"type":"string",
"pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
"ServiceQuotaExceededException":{
"type":"structure",
"required":["message"],

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -25,7 +25,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account. </p> <p>The request provides the ARN of behavior graph.</p> <p>The member account status in the graph must be <code>INVITED</code>.</p>"
"documentation":"<p>Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account. </p> <p>The request provides the ARN of behavior graph.</p> <p>The member account status in the graph must be <code>INVITED</code>.</p>"
},
"CreateGraph":{
"name":"CreateGraph",
@ -36,9 +36,10 @@
"output":{"shape":"CreateGraphResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"}
{"shape":"InternalServerException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.</p> <p>The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.</p> <p> <code>CreateGraph</code> triggers a process to create the corresponding data tables for the new behavior graph.</p> <p>An account can only be the master account for one behavior graph within a Region. If the same account calls <code>CreateGraph</code> with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.</p>"
"documentation":"<p>Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.</p> <p>Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective. </p> <p>The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.</p> <p> <code>CreateGraph</code> triggers a process to create the corresponding data tables for the new behavior graph.</p> <p>An account can only be the master account for one behavior graph within a Region. If the same account calls <code>CreateGraph</code> with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.</p>"
},
"CreateMembers":{
"name":"CreateMembers",
@ -54,7 +55,7 @@
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph. </p> <p> <code>CreateMembers</code> verifies the accounts and then sends invitations to the verified accounts.</p> <p>The request provides the behavior graph ARN and the list of accounts to invite.</p> <p>The response separates the requested accounts into two lists:</p> <ul> <li> <p>The accounts that <code>CreateMembers</code> was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.</p> </li> <li> <p>The accounts that <code>CreateMembers</code> was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.</p> </li> </ul>"
"documentation":"<p>Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph. </p> <p> <code>CreateMembers</code> verifies the accounts and then sends invitations to the verified accounts.</p> <p>The request provides the behavior graph ARN and the list of accounts to invite.</p> <p>The response separates the requested accounts into two lists:</p> <ul> <li> <p>The accounts that <code>CreateMembers</code> was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.</p> </li> <li> <p>The accounts that <code>CreateMembers</code> was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.</p> </li> </ul>"
},
"DeleteGraph":{
"name":"DeleteGraph",
@ -68,7 +69,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.</p> <p> <code>DeleteGraph</code> can only be called by the master account for a behavior graph.</p>"
"documentation":"<p>Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.</p> <p> <code>DeleteGraph</code> can only be called by the master account for a behavior graph.</p>"
},
"DeleteMembers":{
"name":"DeleteMembers",
@ -84,7 +85,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use <code>DeleteMembers</code> to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the <code>DeleteGraph</code> API method.</p>"
"documentation":"<p>Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use <code>DeleteMembers</code> to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the <code>DeleteGraph</code> API method.</p>"
},
"DisassociateMembership":{
"name":"DisassociateMembership",
@ -99,7 +100,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the <code>ENABLED</code> status.</p>"
"documentation":"<p>Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the <code>ENABLED</code> status.</p>"
},
"GetMembers":{
"name":"GetMembers",
@ -114,7 +115,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Returns the membership details for specified member accounts for a behavior graph.</p>"
"documentation":"<p>Returns the membership details for specified member accounts for a behavior graph.</p>"
},
"ListGraphs":{
"name":"ListGraphs",
@ -128,7 +129,7 @@
{"shape":"InternalServerException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.</p> <p>Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.</p>"
"documentation":"<p>Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.</p> <p>Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.</p>"
},
"ListInvitations":{
"name":"ListInvitations",
@ -142,7 +143,7 @@
{"shape":"InternalServerException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account.</p> <p>Open invitations are invitations that the member account has not responded to.</p> <p>The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.</p>"
"documentation":"<p>Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account.</p> <p>Open invitations are invitations that the member account has not responded to.</p> <p>The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.</p>"
},
"ListMembers":{
"name":"ListMembers",
@ -157,7 +158,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.</p>"
"documentation":"<p>Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.</p>"
},
"RejectInvitation":{
"name":"RejectInvitation",
@ -172,7 +173,23 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the <code>INVITED</code> status.</p>"
"documentation":"<p>Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the <code>INVITED</code> status.</p>"
},
"StartMonitoringMember":{
"name":"StartMonitoringMember",
"http":{
"method":"POST",
"requestUri":"/graph/member/monitoringstate"
},
"input":{"shape":"StartMonitoringMemberRequest"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Sends a request to enable data ingest for a member account that has a status of <code>ACCEPTED_BUT_DISABLED</code>.</p> <p>For valid member accounts, the status is updated as follows.</p> <ul> <li> <p>If Detective enabled the member account, then the new status is <code>ENABLED</code>.</p> </li> <li> <p>If Detective cannot enable the member account, the status remains <code>ACCEPTED_BUT_DISABLED</code>. </p> </li> </ul>"
}
},
"shapes":{
@ -202,7 +219,7 @@
"documentation":"<p>The AWS account root user email address for the AWS account.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>An AWS account that is the master of or a member of a behavior graph.</p>"
"documentation":"<p>An AWS account that is the master of or a member of a behavior graph.</p>"
},
"AccountId":{
"type":"string",
@ -378,7 +395,7 @@
"documentation":"<p>The date and time that the behavior graph was created. The value is in milliseconds since the epoch.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>A behavior graph in Detective.</p>"
"documentation":"<p>A behavior graph in Detective.</p>"
},
"GraphArn":{
"type":"string",
@ -501,7 +518,11 @@
},
"Status":{
"shape":"MemberStatus",
"documentation":"<p>The current membership status of the member account. The status can have one of the following values:</p> <ul> <li> <p> <code>INVITED</code> - Indicates that the member was sent an invitation but has not yet responded.</p> </li> <li> <p> <code>VERIFICATION_IN_PROGRESS</code> - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.</p> </li> <li> <p> <code>VERIFICATION_FAILED</code> - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.</p> </li> <li> <p> <code>ENABLED</code> - Indicates that the member account accepted the invitation to contribute to the behavior graph.</p> </li> </ul> <p>Member accounts that declined an invitation or that were removed from the behavior graph are not included.</p>"
"documentation":"<p>The current membership status of the member account. The status can have one of the following values:</p> <ul> <li> <p> <code>INVITED</code> - Indicates that the member was sent an invitation but has not yet responded.</p> </li> <li> <p> <code>VERIFICATION_IN_PROGRESS</code> - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.</p> </li> <li> <p> <code>VERIFICATION_FAILED</code> - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.</p> </li> <li> <p> <code>ENABLED</code> - Indicates that the member account accepted the invitation to contribute to the behavior graph.</p> </li> <li> <p> <code>ACCEPTED_BUT_DISABLED</code> - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. <code>DisabledReason</code> provides the reason why the member account is not enabled.</p> </li> </ul> <p>Member accounts that declined an invitation or that were removed from the behavior graph are not included.</p>"
},
"DisabledReason":{
"shape":"MemberDisabledReason",
"documentation":"<p>For member accounts with a status of <code>ACCEPTED_BUT_DISABLED</code>, the reason that the member account is not enabled.</p> <p>The reason can have one of the following values:</p> <ul> <li> <p> <code>VOLUME_TOO_HIGH</code> - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.</p> </li> <li> <p> <code>VOLUME_UNKNOWN</code> - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty. </p> </li> </ul>"
},
"InvitedTime":{
"shape":"Timestamp",
@ -510,14 +531,29 @@
"UpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the member account was last updated. The value is in milliseconds since the epoch.</p>"
},
"PercentOfGraphUtilization":{
"shape":"Percentage",
"documentation":"<p>The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.</p> <p>Note that this is not the percentage of the behavior graph data volume.</p> <p>For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then <code>PercentOfGraphUtilization</code> is 25. It represents 25% of the maximum allowed data volume. </p>"
},
"PercentOfGraphUtilizationUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the graph utilization percentage was last updated.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Details about a member account that was invited to contribute to a behavior graph.</p>"
"documentation":"<p>Details about a member account that was invited to contribute to a behavior graph.</p>"
},
"MemberDetailList":{
"type":"list",
"member":{"shape":"MemberDetail"}
},
"MemberDisabledReason":{
"type":"string",
"enum":[
"VOLUME_TOO_HIGH",
"VOLUME_UNKNOWN"
]
},
"MemberResultsLimit":{
"type":"integer",
"box":true,
@ -530,7 +566,8 @@
"INVITED",
"VERIFICATION_IN_PROGRESS",
"VERIFICATION_FAILED",
"ENABLED"
"ENABLED",
"ACCEPTED_BUT_DISABLED"
]
},
"PaginationToken":{
@ -538,6 +575,7 @@
"max":1024,
"min":1
},
"Percentage":{"type":"double"},
"RejectInvitationRequest":{
"type":"structure",
"required":["GraphArn"],
@ -562,10 +600,27 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>This request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.</p>",
"documentation":"<p>This request cannot be completed for one of the following reasons.</p> <ul> <li> <p>The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.</p> </li> <li> <p>The request would cause the data rate for the behavior graph to exceed the maximum allowed.</p> </li> <li> <p>Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty. </p> </li> </ul>",
"error":{"httpStatusCode":402},
"exception":true
},
"StartMonitoringMemberRequest":{
"type":"structure",
"required":[
"GraphArn",
"AccountId"
],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph.</p>"
},
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID of the member account to try to enable.</p> <p>The account must be an invited member account with a status of <code>ACCEPTED_BUT_DISABLED</code>. </p>"
}
}
},
"Timestamp":{"type":"timestamp"},
"UnprocessedAccount":{
"type":"structure",
@ -579,7 +634,7 @@
"documentation":"<p>The reason that the member account request could not be processed.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>A member account that was included in a request but for which the request could not be processed.</p>"
"documentation":"<p>A member account that was included in a request but for which the request could not be processed.</p>"
},
"UnprocessedAccountList":{
"type":"list",
@ -596,5 +651,5 @@
"exception":true
}
},
"documentation":"<important> <p>Amazon Detective is currently in preview. The Detective API can only be used by accounts that are admitted into the preview.</p> </important> <p>Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>A Detective master account can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> </ul> <p>A member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>"
"documentation":"<p>Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>A Detective master account can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> </ul> <p>A member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>"
}

View file

@ -36,7 +36,7 @@
"output": {
"project": {
"name": "MyProject",
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
"created": "1472660939.152"
}
},
@ -90,10 +90,10 @@
"upload": {
"name": "MyAppiumPythonUpload",
"type": "APPIUM_PYTHON_TEST_PACKAGE",
"arn": "arn:aws:devicefarm:us-west-2:183774035805:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE",
"arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE",
"created": "1472661404.186",
"status": "INITIALIZED",
"url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE"
"url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE"
}
},
"comments": {
@ -840,12 +840,12 @@
"projects": [
{
"name": "My Test Project",
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
"created": "1453163262.105"
},
{
"name": "Hello World",
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE",
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE",
"created": "1470350112.439"
}
]
@ -1217,12 +1217,12 @@
{
"input": {
"name": "NewName",
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE"
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE"
},
"output": {
"project": {
"name": "NewName",
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE",
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE",
"created": "1448400709.927"
}
},

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -211,7 +211,7 @@
"members":{
"Interval":{
"shape":"Interval",
"documentation":"<p>The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.</p>"
"documentation":"<p>The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.</p>"
},
"IntervalUnit":{
"shape":"IntervalUnitValues",

View file

@ -1,5 +1,1053 @@
{
"version": "1.0",
"examples": {
"AddTagsToResource": [
{
"input": {
"ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E",
"Tags": [
{
"Key": "Acount",
"Value": "1633456"
}
]
},
"output": {
},
"comments": {
"input": {
"ResourceArn": "Required. Use the ARN of the resource you want to tag.",
"Tags": "Required. Use the Key/Value pair format."
},
"output": {
}
},
"description": "Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.",
"id": "add-tags-to-resource-1481744141435",
"title": "Add tags to resource"
}
],
"CreateEndpoint": [
{
"input": {
"CertificateArn": "",
"DatabaseName": "testdb",
"EndpointIdentifier": "test-endpoint-1",
"EndpointType": "source",
"EngineName": "mysql",
"ExtraConnectionAttributes": "",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
"Password": "pasword",
"Port": 3306,
"ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
"SslMode": "require",
"Tags": [
{
"Key": "Acount",
"Value": "143327655"
}
],
"Username": "username"
},
"output": {
"Endpoint": {
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
"EndpointIdentifier": "test-endpoint-1",
"EndpointType": "source",
"EngineName": "mysql",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
"Port": 3306,
"ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
"Status": "active",
"Username": "username"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates an endpoint using the provided settings.",
"id": "create-endpoint-1481746254348",
"title": "Create endpoint"
}
],
"CreateReplicationInstance": [
{
"input": {
"AllocatedStorage": 123,
"AutoMinorVersionUpgrade": true,
"AvailabilityZone": "",
"EngineVersion": "",
"KmsKeyId": "",
"MultiAZ": true,
"PreferredMaintenanceWindow": "",
"PubliclyAccessible": true,
"ReplicationInstanceClass": "",
"ReplicationInstanceIdentifier": "",
"ReplicationSubnetGroupIdentifier": "",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcSecurityGroupIds": [
]
},
"output": {
"ReplicationInstance": {
"AllocatedStorage": 5,
"AutoMinorVersionUpgrade": true,
"EngineVersion": "1.5.0",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
"PendingModifiedValues": {
},
"PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
"PubliclyAccessible": true,
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceIdentifier": "test-rep-1",
"ReplicationInstanceStatus": "creating",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupDescription": "default",
"ReplicationSubnetGroupIdentifier": "default",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetIdentifier": "subnet-f6dd91af",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetIdentifier": "subnet-3605751d",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-c2daefb5",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetIdentifier": "subnet-85e90cb8",
"SubnetStatus": "Active"
}
],
"VpcId": "vpc-6741a603"
}
}
},
"comments": {
"output": {
}
},
"description": "Creates the replication instance using the specified parameters.",
"id": "create-replication-instance-1481746705295",
"title": "Create replication instance"
}
],
"CreateReplicationSubnetGroup": [
{
"input": {
"ReplicationSubnetGroupDescription": "US West subnet group",
"ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366",
"SubnetIds": [
"subnet-e145356n",
"subnet-58f79200"
],
"Tags": [
{
"Key": "Acount",
"Value": "145235"
}
]
},
"output": {
"ReplicationSubnetGroup": {
}
},
"comments": {
"output": {
}
},
"description": "Creates a replication subnet group given a list of the subnet IDs in a VPC.",
"id": "create-replication-subnet-group-1481747297930",
"title": "Create replication subnet group"
}
],
"CreateReplicationTask": [
{
"input": {
"CdcStartTime": "2016-12-14T18:25:43Z",
"MigrationType": "full-load",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationTaskIdentifier": "task1",
"ReplicationTaskSettings": "",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"TableMappings": "file://mappingfile.json",
"Tags": [
{
"Key": "Acount",
"Value": "24352226"
}
],
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
},
"output": {
"ReplicationTask": {
"MigrationType": "full-load",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
"ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
"ReplicationTaskIdentifier": "task1",
"ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"Status": "creating",
"TableMappings": "file://mappingfile.json",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a replication task using the specified parameters.",
"id": "create-replication-task-1481747646288",
"title": "Create replication task"
}
],
"DeleteCertificate": [
{
"input": {
"CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ"
},
"output": {
"Certificate": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the specified certificate.",
"id": "delete-certificate-1481751957981",
"title": "Delete Certificate"
}
],
"DeleteEndpoint": [
{
"input": {
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM"
},
"output": {
"Endpoint": {
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
"EndpointIdentifier": "test-endpoint-1",
"EndpointType": "source",
"EngineName": "mysql",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
"Port": 3306,
"ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com",
"Status": "active",
"Username": "username"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.\n",
"id": "delete-endpoint-1481752425530",
"title": "Delete Endpoint"
}
],
"DeleteReplicationInstance": [
{
"input": {
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
},
"output": {
"ReplicationInstance": {
"AllocatedStorage": 5,
"AutoMinorVersionUpgrade": true,
"EngineVersion": "1.5.0",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
"PendingModifiedValues": {
},
"PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
"PubliclyAccessible": true,
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceIdentifier": "test-rep-1",
"ReplicationInstanceStatus": "creating",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupDescription": "default",
"ReplicationSubnetGroupIdentifier": "default",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetIdentifier": "subnet-f6dd91af",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetIdentifier": "subnet-3605751d",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-c2daefb5",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetIdentifier": "subnet-85e90cb8",
"SubnetStatus": "Active"
}
],
"VpcId": "vpc-6741a603"
}
}
},
"comments": {
"output": {
}
},
"description": "Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.\n\n",
"id": "delete-replication-instance-1481752552839",
"title": "Delete Replication Instance"
}
],
"DeleteReplicationSubnetGroup": [
{
"input": {
"ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes a replication subnet group.",
"id": "delete-replication-subnet-group-1481752728597",
"title": "Delete Replication Subnet Group"
}
],
"DeleteReplicationTask": [
{
"input": {
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
},
"output": {
"ReplicationTask": {
"MigrationType": "full-load",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
"ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
"ReplicationTaskIdentifier": "task1",
"ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"Status": "creating",
"TableMappings": "file://mappingfile.json",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the specified replication task.",
"id": "delete-replication-task-1481752903506",
"title": "Delete Replication Task"
}
],
"DescribeAccountAttributes": [
{
"input": {
},
"output": {
"AccountQuotas": [
{
"AccountQuotaName": "ReplicationInstances",
"Max": 20,
"Used": 0
},
{
"AccountQuotaName": "AllocatedStorage",
"Max": 20,
"Used": 0
},
{
"AccountQuotaName": "Endpoints",
"Max": 20,
"Used": 0
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.",
"id": "describe-acount-attributes-1481753085663",
"title": "Describe acount attributes"
}
],
"DescribeCertificates": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Certificates": [
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Provides a description of the certificate.",
"id": "describe-certificates-1481753186244",
"title": "Describe certificates"
}
],
"DescribeConnections": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Connections": [
{
"EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"EndpointIdentifier": "testsrc1",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationInstanceIdentifier": "test",
"Status": "successful"
}
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.",
"id": "describe-connections-1481754477953",
"title": "Describe connections"
}
],
"DescribeEndpointTypes": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Marker": "",
"SupportedEndpointTypes": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the type of endpoints available.",
"id": "describe-endpoint-types-1481754742591",
"title": "Describe endpoint types"
}
],
"DescribeEndpoints": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Endpoints": [
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the endpoints for your account in the current region.",
"id": "describe-endpoints-1481754926060",
"title": "Describe endpoints"
}
],
"DescribeOrderableReplicationInstances": [
{
"input": {
"Marker": "",
"MaxRecords": 123
},
"output": {
"Marker": "",
"OrderableReplicationInstances": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the replication instance types that can be created in the specified region.",
"id": "describe-orderable-replication-instances-1481755123669",
"title": "Describe orderable replication instances"
}
],
"DescribeRefreshSchemasStatus": [
{
"input": {
"EndpointArn": ""
},
"output": {
"RefreshSchemasStatus": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns the status of the refresh-schemas operation.",
"id": "describe-refresh-schema-status-1481755303497",
"title": "Describe refresh schema status"
}
],
"DescribeReplicationInstances": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Marker": "",
"ReplicationInstances": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns the status of the refresh-schemas operation.",
"id": "describe-replication-instances-1481755443952",
"title": "Describe replication instances"
}
],
"DescribeReplicationSubnetGroups": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Marker": "",
"ReplicationSubnetGroups": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the replication subnet groups.",
"id": "describe-replication-subnet-groups-1481755621284",
"title": "Describe replication subnet groups"
}
],
"DescribeReplicationTasks": [
{
"input": {
"Filters": [
{
"Name": "string",
"Values": [
"string",
"string"
]
}
],
"Marker": "",
"MaxRecords": 123
},
"output": {
"Marker": "",
"ReplicationTasks": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about replication tasks for your account in the current region.",
"id": "describe-replication-tasks-1481755777563",
"title": "Describe replication tasks"
}
],
"DescribeSchemas": [
{
"input": {
"EndpointArn": "",
"Marker": "",
"MaxRecords": 123
},
"output": {
"Marker": "",
"Schemas": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the schema for the specified endpoint.",
"id": "describe-schemas-1481755933924",
"title": "Describe schemas"
}
],
"DescribeTableStatistics": [
{
"input": {
"Marker": "",
"MaxRecords": 123,
"ReplicationTaskArn": ""
},
"output": {
"Marker": "",
"ReplicationTaskArn": "",
"TableStatistics": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.",
"id": "describe-table-statistics-1481756071890",
"title": "Describe table statistics"
}
],
"ImportCertificate": [
{
"input": {
"CertificateIdentifier": "",
"CertificatePem": ""
},
"output": {
"Certificate": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Uploads the specified certificate.",
"id": "import-certificate-1481756197206",
"title": "Import certificate"
}
],
"ListTagsForResource": [
{
"input": {
"ResourceArn": ""
},
"output": {
"TagList": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists all tags for an AWS DMS resource.",
"id": "list-tags-for-resource-1481761095501",
"title": "List tags for resource"
}
],
"ModifyEndpoint": [
{
"input": {
"CertificateArn": "",
"DatabaseName": "",
"EndpointArn": "",
"EndpointIdentifier": "",
"EndpointType": "source",
"EngineName": "",
"ExtraConnectionAttributes": "",
"Password": "",
"Port": 123,
"ServerName": "",
"SslMode": "require",
"Username": ""
},
"output": {
"Endpoint": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Modifies the specified endpoint.",
"id": "modify-endpoint-1481761649937",
"title": "Modify endpoint"
}
],
"ModifyReplicationInstance": [
{
"input": {
"AllocatedStorage": 123,
"AllowMajorVersionUpgrade": true,
"ApplyImmediately": true,
"AutoMinorVersionUpgrade": true,
"EngineVersion": "1.5.0",
"MultiAZ": true,
"PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceIdentifier": "test-rep-1",
"VpcSecurityGroupIds": [
]
},
"output": {
"ReplicationInstance": {
"AllocatedStorage": 5,
"AutoMinorVersionUpgrade": true,
"EngineVersion": "1.5.0",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
"PendingModifiedValues": {
},
"PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
"PubliclyAccessible": true,
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceIdentifier": "test-rep-1",
"ReplicationInstanceStatus": "available",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupDescription": "default",
"ReplicationSubnetGroupIdentifier": "default",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetIdentifier": "subnet-f6dd91af",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetIdentifier": "subnet-3605751d",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-c2daefb5",
"SubnetStatus": "Active"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetIdentifier": "subnet-85e90cb8",
"SubnetStatus": "Active"
}
],
"VpcId": "vpc-6741a603"
}
}
},
"comments": {
"output": {
}
},
"description": "Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.",
"id": "modify-replication-instance-1481761784746",
"title": "Modify replication instance"
}
],
"ModifyReplicationSubnetGroup": [
{
"input": {
"ReplicationSubnetGroupDescription": "",
"ReplicationSubnetGroupIdentifier": "",
"SubnetIds": [
]
},
"output": {
"ReplicationSubnetGroup": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Modifies the settings for the specified replication subnet group.",
"id": "modify-replication-subnet-group-1481762275392",
"title": "Modify replication subnet group"
}
],
"RefreshSchemas": [
{
"input": {
"EndpointArn": "",
"ReplicationInstanceArn": ""
},
"output": {
"RefreshSchemasStatus": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.",
"id": "refresh-schema-1481762399111",
"title": "Refresh schema"
}
],
"RemoveTagsFromResource": [
{
"input": {
"ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E",
"TagKeys": [
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Removes metadata tags from an AWS DMS resource.",
"id": "remove-tags-from-resource-1481762571330",
"title": "Remove tags from resource"
}
],
"StartReplicationTask": [
{
"input": {
"CdcStartTime": "2016-12-14T13:33:20Z",
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"StartReplicationTaskType": "start-replication"
},
"output": {
"ReplicationTask": {
"MigrationType": "full-load",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
"ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
"ReplicationTaskIdentifier": "task1",
"ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"Status": "creating",
"TableMappings": "file://mappingfile.json",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Starts the replication task.",
"id": "start-replication-task-1481762706778",
"title": "Start replication task"
}
],
"StopReplicationTask": [
{
"input": {
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
},
"output": {
"ReplicationTask": {
"MigrationType": "full-load",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
"ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
"ReplicationTaskIdentifier": "task1",
"ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"Status": "creating",
"TableMappings": "file://mappingfile.json",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Stops the replication task.",
"id": "stop-replication-task-1481762924947",
"title": "Stop replication task"
}
],
"TestConnection": [
{
"input": {
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
},
"output": {
"Connection": {
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Tests the connection between the replication instance and the endpoint.",
"id": "test-conection-1481763017636",
"title": "Test conection"
}
]
}
}

View file

@ -548,13 +548,16 @@
"output": {
"Attributes": {
"AlbumTitle": {
"S": "Songs About Life"
"S": "Louder Than Ever"
},
"Artist": {
"S": "Acme Band"
},
"SongTitle": {
"S": "Happy Day"
},
"Year": {
"N": "2015"
}
}
},

View file

@ -156,6 +156,36 @@
"title": "To associate the default DHCP options set with a VPC"
}
],
"AssociateIamInstanceProfile": [
{
"input": {
"IamInstanceProfile": {
"Name": "admin-role"
},
"InstanceId": "i-123456789abcde123"
},
"output": {
"IamInstanceProfileAssociation": {
"AssociationId": "iip-assoc-0e7736511a163c209",
"IamInstanceProfile": {
"Arn": "arn:aws:iam::123456789012:instance-profile/admin-role",
"Id": "AIPAJBLK7RKJKWDXVHIEC"
},
"InstanceId": "i-123456789abcde123",
"State": "associating"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates an IAM instance profile named admin-role with the specified instance.",
"id": "to-associate-an-iam-instance-profile-with-an-instance-1528928429850",
"title": "To associate an IAM instance profile with an instance"
}
],
"AssociateRouteTable": [
{
"input": {
@ -239,6 +269,153 @@
"title": "To attach a volume to an instance"
}
],
"AuthorizeSecurityGroupEgress": [
{
"input": {
"GroupId": "sg-1a2b3c4d",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"IpRanges": [
{
"CidrIp": "10.0.0.0/16"
}
],
"ToPort": 80
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds a rule that grants access to the specified address ranges on TCP port 80.",
"id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-address-range-1528929309636",
"title": "To add a rule that allows outbound traffic to a specific address range"
},
{
"input": {
"GroupId": "sg-1a2b3c4d",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"ToPort": 80,
"UserIdGroupPairs": [
{
"GroupId": "sg-4b51a32f"
}
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds a rule that grants access to the specified security group on TCP port 80.",
"id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-security-group-1528929760260",
"title": "To add a rule that allows outbound traffic to a specific security group"
}
],
"AuthorizeSecurityGroupIngress": [
{
"input": {
"GroupId": "sg-903004f8",
"IpPermissions": [
{
"FromPort": 22,
"IpProtocol": "tcp",
"IpRanges": [
{
"CidrIp": "203.0.113.0/24",
"Description": "SSH access from the LA office"
}
],
"ToPort": 22
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.",
"id": "to-add-a-rule-that-allows-inbound-ssh-traffic-1529011610328",
"title": "To add a rule that allows inbound SSH traffic from an IPv4 address range"
},
{
"input": {
"GroupId": "sg-111aaa22",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"ToPort": 80,
"UserIdGroupPairs": [
{
"Description": "HTTP access from other instances",
"GroupId": "sg-1a2b3c4d"
}
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.",
"id": "to-add-a-rule-that-allows-inbound-http-traffic-from-another-security-group-1529012163168",
"title": "To add a rule that allows inbound HTTP traffic from another security group"
},
{
"input": {
"GroupId": "sg-123abc12 ",
"IpPermissions": [
{
"FromPort": 3389,
"IpProtocol": "tcp",
"Ipv6Ranges": [
{
"CidrIpv6": "2001:db8:1234:1a00::/64",
"Description": "RDP access from the NY office"
}
],
"ToPort": 3389
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.",
"id": "to-add-a-rule-with-a-description-1529012418116",
"title": "To add a rule that allows inbound RDP traffic from an IPv6 address range"
}
],
"CancelSpotFleetRequests": [
{
"input": {
@ -339,6 +516,28 @@
"title": "To confirm the product instance"
}
],
"CopyImage": [
{
"input": {
"Description": "",
"Name": "My server",
"SourceImageId": "ami-5731123e",
"SourceRegion": "us-east-1"
},
"output": {
"ImageId": "ami-438bea42"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example copies the specified AMI from the us-east-1 region to the current region.",
"id": "to-copy-an-ami-to-another-region-1529022820832",
"title": "To copy an AMI to another region"
}
],
"CopySnapshot": [
{
"input": {
@ -430,6 +629,40 @@
"title": "To create a DHCP options set"
}
],
"CreateImage": [
{
"input": {
"BlockDeviceMappings": [
{
"DeviceName": "/dev/sdh",
"Ebs": {
"VolumeSize": "100"
}
},
{
"DeviceName": "/dev/sdc",
"VirtualName": "ephemeral1"
}
],
"Description": "An AMI for my server",
"InstanceId": "i-1234567890abcdef0",
"Name": "My server",
"NoReboot": true
},
"output": {
"ImageId": "ami-1a2b3c4d"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc.",
"id": "to-create-an-ami-from-an-amazon-ebs-backed-instance-1529023150636",
"title": "To create an AMI from an Amazon EBS-backed instance"
}
],
"CreateInternetGateway": [
{
"output": {
@ -470,6 +703,104 @@
"title": "To create a key pair"
}
],
"CreateLaunchTemplate": [
{
"input": {
"LaunchTemplateData": {
"ImageId": "ami-8c1be5f6",
"InstanceType": "t2.small",
"NetworkInterfaces": [
{
"AssociatePublicIpAddress": true,
"DeviceIndex": 0,
"Ipv6AddressCount": 1,
"SubnetId": "subnet-7b16de0c"
}
],
"TagSpecifications": [
{
"ResourceType": "instance",
"Tags": [
{
"Key": "Name",
"Value": "webserver"
}
]
}
]
},
"LaunchTemplateName": "my-template",
"VersionDescription": "WebVersion1"
},
"output": {
"LaunchTemplate": {
"CreateTime": "2017-11-27T09:13:24.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersionNumber": 1,
"LatestVersionNumber": 1,
"LaunchTemplateId": "lt-01238c059e3466abc",
"LaunchTemplateName": "my-template"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.",
"id": "to-create-a-launch-template-1529023655488",
"title": "To create a launch template"
}
],
"CreateLaunchTemplateVersion": [
{
"input": {
"LaunchTemplateData": {
"ImageId": "ami-c998b6b2"
},
"LaunchTemplateId": "lt-0abcd290751193123",
"SourceVersion": "1",
"VersionDescription": "WebVersion2"
},
"output": {
"LaunchTemplateVersion": {
"CreateTime": "2017-12-01T13:35:46.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersion": false,
"LaunchTemplateData": {
"ImageId": "ami-c998b6b2",
"InstanceType": "t2.micro",
"NetworkInterfaces": [
{
"AssociatePublicIpAddress": true,
"DeviceIndex": 0,
"Ipv6Addresses": [
{
"Ipv6Address": "2001:db8:1234:1a00::123"
}
],
"SubnetId": "subnet-7b16de0c"
}
]
},
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "my-template",
"VersionDescription": "WebVersion2",
"VersionNumber": 2
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.",
"id": "to-create-a-launch-template-version-1529024195702",
"title": "To create a launch template version"
}
],
"CreateNatGateway": [
{
"input": {
@ -697,6 +1028,27 @@
"title": "To create a route table"
}
],
"CreateSecurityGroup": [
{
"input": {
"Description": "My security group",
"GroupName": "my-security-group",
"VpcId": "vpc-1a2b3c4d"
},
"output": {
"GroupId": "sg-903004f8"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a security group for the specified VPC.",
"id": "to-create-a-security-group-for-a-vpc-1529024532716",
"title": "To create a security group for a VPC"
}
],
"CreateSnapshot": [
{
"input": {
@ -953,6 +1305,63 @@
"title": "To delete a key pair"
}
],
"DeleteLaunchTemplate": [
{
"input": {
"LaunchTemplateId": "lt-0abcd290751193123"
},
"output": {
"LaunchTemplate": {
"CreateTime": "2017-11-23T16:46:25.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersionNumber": 2,
"LatestVersionNumber": 2,
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "my-template"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified launch template.",
"id": "to-delete-a-launch-template-1529024658216",
"title": "To delete a launch template"
}
],
"DeleteLaunchTemplateVersions": [
{
"input": {
"LaunchTemplateId": "lt-0abcd290751193123",
"Versions": [
"1"
]
},
"output": {
"SuccessfullyDeletedLaunchTemplateVersions": [
{
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "my-template",
"VersionNumber": 1
}
],
"UnsuccessfullyDeletedLaunchTemplateVersions": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified launch template version.",
"id": "to-delete-a-launch-template-version-1529024790864",
"title": "To delete a launch template version"
}
],
"DeleteNatGateway": [
{
"input": {
@ -1073,6 +1482,24 @@
"title": "To delete a route table"
}
],
"DeleteSecurityGroup": [
{
"input": {
"GroupId": "sg-903004f8"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified security group.",
"id": "to-delete-a-security-group-1529024952972",
"title": "To delete a security group"
}
],
"DeleteSnapshot": [
{
"input": {
@ -1490,6 +1917,111 @@
"title": "To describe a DHCP options set"
}
],
"DescribeIamInstanceProfileAssociations": [
{
"input": {
"AssociationIds": [
"iip-assoc-0db249b1f25fa24b8"
]
},
"output": {
"IamInstanceProfileAssociations": [
{
"AssociationId": "iip-assoc-0db249b1f25fa24b8",
"IamInstanceProfile": {
"Arn": "arn:aws:iam::123456789012:instance-profile/admin-role",
"Id": "AIPAJVQN4F5WVLGCJDRGM"
},
"InstanceId": "i-09eb09efa73ec1dee",
"State": "associated"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the specified IAM instance profile association.",
"id": "to-describe-an-iam-instance-profile-association-1529025123918",
"title": "To describe an IAM instance profile association"
}
],
"DescribeImageAttribute": [
{
"input": {
"Attribute": "launchPermission",
"ImageId": "ami-5731123e"
},
"output": {
"ImageId": "ami-5731123e",
"LaunchPermissions": [
{
"UserId": "123456789012"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the launch permissions for the specified AMI.",
"id": "to-describe-the-launch-permissions-for-an-ami-1529025296264",
"title": "To describe the launch permissions for an AMI"
}
],
"DescribeImages": [
{
"input": {
"ImageIds": [
"ami-5731123e"
]
},
"output": {
"Images": [
{
"Architecture": "x86_64",
"BlockDeviceMappings": [
{
"DeviceName": "/dev/sda1",
"Ebs": {
"DeleteOnTermination": true,
"SnapshotId": "snap-1234567890abcdef0",
"VolumeSize": 8,
"VolumeType": "standard"
}
}
],
"Description": "An AMI for my server",
"Hypervisor": "xen",
"ImageId": "ami-5731123e",
"ImageLocation": "123456789012/My server",
"ImageType": "machine",
"KernelId": "aki-88aa75e1",
"Name": "My server",
"OwnerId": "123456789012",
"Public": false,
"RootDeviceName": "/dev/sda1",
"RootDeviceType": "ebs",
"State": "available",
"VirtualizationType": "paravirtual"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the specified AMI.",
"id": "to-describe-an-ami-1529025482866",
"title": "To describe an AMI"
}
],
"DescribeInstanceAttribute": [
{
"input": {
@ -1572,6 +2104,120 @@
"title": "To describe the block device mapping for an instance"
}
],
"DescribeInstanceStatus": [
{
"input": {
"InstanceIds": [
"i-1234567890abcdef0"
]
},
"output": {
"InstanceStatuses": [
{
"AvailabilityZone": "us-east-1d",
"InstanceId": "i-1234567890abcdef0",
"InstanceState": {
"Code": 16,
"Name": "running"
},
"InstanceStatus": {
"Details": [
{
"Name": "reachability",
"Status": "passed"
}
],
"Status": "ok"
},
"SystemStatus": {
"Details": [
{
"Name": "reachability",
"Status": "passed"
}
],
"Status": "ok"
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the current status of the specified instance.",
"id": "to-describe-the-status-of-an-instance-1529025696830",
"title": "To describe the status of an instance"
}
],
"DescribeInstances": [
{
"input": {
"InstanceIds": [
"i-1234567890abcdef0"
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the specified instance.",
"id": "to-describe-an-amazon-ec2-instance-1529025982172",
"title": "To describe an Amazon EC2 instance"
},
{
"input": {
"Filters": [
{
"Name": "instance-type",
"Values": [
"t2.micro"
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the instances with the t2.micro instance type.",
"id": "to-describe-the-instances-with-the-instance-type-t2micro-1529026147602",
"title": "To describe the instances with a specific instance type"
},
{
"input": {
"Filters": [
{
"Name": "tag:Purpose",
"Values": [
"test"
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the instances with the Purpose=test tag.",
"id": "to-describe-the-instances-with-a-specific-tag-1529026251928",
"title": "To describe the instances with a specific tag"
}
],
"DescribeInternetGateways": [
{
"input": {
@ -1637,6 +2283,103 @@
"title": "To display a key pair"
}
],
"DescribeLaunchTemplateVersions": [
{
"input": {
"LaunchTemplateId": "068f72b72934aff71"
},
"output": {
"LaunchTemplateVersions": [
{
"CreateTime": "2017-11-20T13:12:32.000Z",
"CreatedBy": "arn:aws:iam::123456789102:root",
"DefaultVersion": false,
"LaunchTemplateData": {
"ImageId": "ami-6057e21a",
"InstanceType": "t2.medium",
"KeyName": "kp-us-east",
"NetworkInterfaces": [
{
"DeviceIndex": 0,
"Groups": [
"sg-7c227019"
],
"SubnetId": "subnet-1a2b3c4d"
}
]
},
"LaunchTemplateId": "lt-068f72b72934aff71",
"LaunchTemplateName": "Webservers",
"VersionNumber": 2
},
{
"CreateTime": "2017-11-20T12:52:33.000Z",
"CreatedBy": "arn:aws:iam::123456789102:root",
"DefaultVersion": true,
"LaunchTemplateData": {
"ImageId": "ami-aabbcc11",
"InstanceType": "t2.medium",
"KeyName": "kp-us-east",
"NetworkInterfaces": [
{
"AssociatePublicIpAddress": true,
"DeleteOnTermination": false,
"DeviceIndex": 0,
"Groups": [
"sg-7c227019"
],
"SubnetId": "subnet-7b16de0c"
}
],
"UserData": ""
},
"LaunchTemplateId": "lt-068f72b72934aff71",
"LaunchTemplateName": "Webservers",
"VersionNumber": 1
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the versions for the specified launch template.",
"id": "to-describe-the-versions-for-a-launch-template-1529344425048",
"title": "To describe the versions for a launch template"
}
],
"DescribeLaunchTemplates": [
{
"input": {
"LaunchTemplateIds": [
"lt-01238c059e3466abc"
]
},
"output": {
"LaunchTemplates": [
{
"CreateTime": "2018-01-16T04:32:57.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersionNumber": 1,
"LatestVersionNumber": 1,
"LaunchTemplateId": "lt-01238c059e3466abc",
"LaunchTemplateName": "my-template"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the specified launch template.",
"id": "to-describe-a-launch-template-1529344182862",
"title": "To describe a launch template"
}
],
"DescribeMovingAddresses": [
{
"output": {
@ -2126,6 +2869,76 @@
"title": "To describe your Scheduled Instances"
}
],
"DescribeSecurityGroupReferences": [
{
"input": {
"GroupId": [
"sg-903004f8"
]
},
"output": {
"SecurityGroupReferenceSet": [
{
"GroupId": "sg-903004f8",
"ReferencingVpcId": "vpc-1a2b3c4d",
"VpcPeeringConnectionId": "pcx-b04deed9"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the security group references for the specified security group.",
"id": "to-describe-security-group-references-1529354312088",
"title": "To describe security group references"
}
],
"DescribeSecurityGroups": [
{
"input": {
"GroupIds": [
"sg-903004f8"
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the specified security group.",
"id": "to-describe-a-security-group-1529354426314",
"title": "To describe a security group"
},
{
"input": {
"Filters": [
{
"Name": "tag:Purpose",
"Values": [
"test"
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the security groups that include the specified tag (Purpose=test).",
"id": "to-describe-a-tagged-security-group-1529354553880",
"title": "To describe a tagged security group"
}
],
"DescribeSnapshotAttribute": [
{
"input": {
@ -2925,6 +3738,33 @@
"title": "To disassociate an Elastic IP addresses in EC2-Classic"
}
],
"DisassociateIamInstanceProfile": [
{
"input": {
"AssociationId": "iip-assoc-05020b59952902f5f"
},
"output": {
"IamInstanceProfileAssociation": {
"AssociationId": "iip-assoc-05020b59952902f5f",
"IamInstanceProfile": {
"Arn": "arn:aws:iam::123456789012:instance-profile/admin-role",
"Id": "AIPAI5IVIHMFFYY2DKV5Y"
},
"InstanceId": "i-123456789abcde123",
"State": "disassociating"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example disassociates the specified IAM instance profile from an instance.",
"id": "to-disassociate-an-iam-instance-profile-1529355364478",
"title": "To disassociate an IAM instance profile"
}
],
"DisassociateRouteTable": [
{
"input": {
@ -2974,6 +3814,210 @@
"title": "To enable I/O for a volume"
}
],
"GetConsoleOutput": [
{
"input": {
"InstanceId": "i-1234567890abcdef0"
},
"output": {
"InstanceId": "i-1234567890abcdef0",
"Output": "...",
"Timestamp": "2018-05-25T21:23:53.000Z"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example gets the console output for the specified instance.",
"id": "to-get-the-console-output-1529355683194",
"title": "To get the console output"
}
],
"GetLaunchTemplateData": [
{
"input": {
"InstanceId": "0123d646e8048babc"
},
"output": {
"LaunchTemplateData": {
"BlockDeviceMappings": [
{
"DeviceName": "/dev/xvda",
"Ebs": {
"DeleteOnTermination": true,
"Encrypted": false,
"Iops": 100,
"SnapshotId": "snap-02594938353ef77d3",
"VolumeSize": 8,
"VolumeType": "gp2"
}
}
],
"EbsOptimized": false,
"ImageId": "ami-32cf7b4a",
"InstanceType": "t2.medium",
"KeyName": "my-key-pair",
"Monitoring": {
"Enabled": false
},
"NetworkInterfaces": [
{
"AssociatePublicIpAddress": false,
"DeleteOnTermination": true,
"Description": "",
"DeviceIndex": 0,
"Groups": [
"sg-d14e1bb4"
],
"Ipv6Addresses": [
],
"NetworkInterfaceId": "eni-4338b5a9",
"PrivateIpAddress": "10.0.3.233",
"PrivateIpAddresses": [
{
"Primary": true,
"PrivateIpAddress": "10.0.3.233"
}
],
"SubnetId": "subnet-5264e837"
}
],
"Placement": {
"AvailabilityZone": "us-east-2b",
"GroupName": "",
"Tenancy": "default"
}
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example gets the launch template data for the specified instance.",
"id": "to-get-the-launch-template-data-for-an-instance--1529356515702",
"title": "To get the launch template data for an instance "
}
],
"ModifyImageAttribute": [
{
"input": {
"ImageId": "ami-5731123e",
"LaunchPermission": {
"Add": [
{
"Group": "all"
}
]
}
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example makes the specified AMI public.",
"id": "to-make-an-ami-public-1529357395278",
"title": "To make an AMI public"
},
{
"input": {
"ImageId": "ami-5731123e",
"LaunchPermission": {
"Add": [
{
"UserId": "123456789012"
}
]
}
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example grants launch permissions for the specified AMI to the specified AWS account.",
"id": "to-grant-launch-permissions-1529357727906",
"title": "To grant launch permissions"
}
],
"ModifyInstanceAttribute": [
{
"input": {
"InstanceId": "i-1234567890abcdef0",
"InstanceType": {
"Value": "m5.large"
}
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example modifies the instance type of the specified stopped instance.",
"id": "to-modify-the-instance-type-1529357844378",
"title": "To modify the instance type"
},
{
"input": {
"EnaSupport": {
"Value": true
},
"InstanceId": "i-1234567890abcdef0"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example enables enhanced networking for the specified stopped instance.",
"id": "to-enable-enhanced-networking-1529358279870",
"title": "To enable enhanced networking"
}
],
"ModifyLaunchTemplate": [
{
"input": {
"DefaultVersion": "2",
"LaunchTemplateId": "lt-0abcd290751193123"
},
"output": {
"LaunchTemplate": {
"CreateTime": "2017-12-01T13:35:46.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersionNumber": 2,
"LatestVersionNumber": 2,
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "WebServers"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example specifies version 2 as the default version of the specified launch template.",
"id": "to-change-the-default-version-of-a-launch-template-1529358440364",
"title": "To change the default version of a launch template"
}
],
"ModifyNetworkInterfaceAttribute": [
{
"input": {
@ -3274,6 +4318,26 @@
"title": "To purchase a Scheduled Instance"
}
],
"RebootInstances": [
{
"input": {
"InstanceIds": [
"i-1234567890abcdef5"
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example reboots the specified EC2 instance.",
"id": "to-reboot-an-ec2-instance-1529358566382",
"title": "To reboot an EC2 instance"
}
],
"ReleaseAddress": [
{
"input": {
@ -3604,6 +4668,44 @@
"title": "To create a one-time Spot Instance request"
}
],
"ResetImageAttribute": [
{
"input": {
"Attribute": "launchPermission",
"ImageId": "ami-5731123e"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.",
"id": "to-reset-the-launchpermission-attribute-1529359519534",
"title": "To reset the launchPermission attribute"
}
],
"ResetInstanceAttribute": [
{
"input": {
"Attribute": "sourceDestCheck",
"InstanceId": "i-1234567890abcdef0"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example resets the sourceDestCheck attribute for the specified instance.",
"id": "to-reset-the-sourcedestcheck-attribute-1529359630708",
"title": "To reset the sourceDestCheck attribute"
}
],
"ResetSnapshotAttribute": [
{
"input": {
@ -3643,6 +4745,51 @@
"title": "To restore an address to EC2-Classic"
}
],
"RunInstances": [
{
"input": {
"BlockDeviceMappings": [
{
"DeviceName": "/dev/sdh",
"Ebs": {
"VolumeSize": 100
}
}
],
"ImageId": "ami-abc12345",
"InstanceType": "t2.micro",
"KeyName": "my-key-pair",
"MaxCount": 1,
"MinCount": 1,
"SecurityGroupIds": [
"sg-1a2b3c4d"
],
"SubnetId": "subnet-6e7f829e",
"TagSpecifications": [
{
"ResourceType": "instance",
"Tags": [
{
"Key": "Purpose",
"Value": "test"
}
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.",
"id": "to-launch-an-instance-1529360150806",
"title": "To launch an instance"
}
],
"RunScheduledInstances": [
{
"input": {
@ -3717,6 +4864,105 @@
"title": "To launch a Scheduled Instance in EC2-Classic"
}
],
"StartInstances": [
{
"input": {
"InstanceIds": [
"i-1234567890abcdef0"
]
},
"output": {
"StartingInstances": [
{
"CurrentState": {
"Code": 0,
"Name": "pending"
},
"InstanceId": "i-1234567890abcdef0",
"PreviousState": {
"Code": 80,
"Name": "stopped"
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example starts the specified EC2 instance.",
"id": "to-start-a-stopped-ec2-instance-1529358792730",
"title": "To start a stopped EC2 instance"
}
],
"StopInstances": [
{
"input": {
"InstanceIds": [
"i-1234567890abcdef0"
]
},
"output": {
"StoppingInstances": [
{
"CurrentState": {
"Code": 64,
"Name": "stopping"
},
"InstanceId": "i-1234567890abcdef0",
"PreviousState": {
"Code": 16,
"Name": "running"
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example stops the specified EC2 instance.",
"id": "to-stop-a-running-ec2-instance-1529358905540",
"title": "To stop a running EC2 instance"
}
],
"TerminateInstances": [
{
"input": {
"InstanceIds": [
"i-1234567890abcdef0"
]
},
"output": {
"TerminatingInstances": [
{
"CurrentState": {
"Code": 32,
"Name": "shutting-down"
},
"InstanceId": "i-1234567890abcdef0",
"PreviousState": {
"Code": 16,
"Name": "running"
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example terminates the specified EC2 instance.",
"id": "to-terminate-an-ec2-instance-1529359350660",
"title": "To terminate an EC2 instance"
}
],
"UnassignPrivateIpAddresses": [
{
"input": {
@ -3735,6 +4981,68 @@
"id": "ec2-unassign-private-ip-addresses-1",
"title": "To unassign a secondary private IP address from a network interface"
}
],
"UpdateSecurityGroupRuleDescriptionsEgress": [
{
"input": {
"GroupId": "sg-123abc12",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"IpRanges": [
{
"CidrIp": "203.0.113.0/24",
"Description": "Outbound HTTP access to server 2"
}
],
"ToPort": 80
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example updates the description for the specified security group rule.",
"id": "to-update-an-outbound-security-group-rule-description-1529360481544",
"title": "To update an outbound security group rule description"
}
],
"UpdateSecurityGroupRuleDescriptionsIngress": [
{
"input": {
"GroupId": "sg-123abc12",
"IpPermissions": [
{
"FromPort": 22,
"IpProtocol": "tcp",
"IpRanges": [
{
"CidrIp": "203.0.113.0/16",
"Description": "SSH access from the LA office"
}
],
"ToPort": 22
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example updates the description for the specified security group rule.",
"id": "to-update-an-inbound-security-group-rule-description-1529360820372",
"title": "To update an inbound security group rule description"
}
]
}
}

View file

@ -662,6 +662,7 @@
"requestUri":"/"
},
"input":{"shape":"CreatePlacementGroupRequest"},
"output":{"shape":"CreatePlacementGroupResult"},
"documentation":"<p>Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. </p> <p>A <code>cluster</code> placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A <code>spread</code> placement group places instances on distinct hardware. A <code>partition</code> placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
},
"CreateReservedInstancesListing":{
@ -1411,6 +1412,16 @@
"input":{"shape":"DeregisterImageRequest"},
"documentation":"<p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.</p> <p>When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.</p>"
},
"DeregisterInstanceEventNotificationAttributes":{
"name":"DeregisterInstanceEventNotificationAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterInstanceEventNotificationAttributesRequest"},
"output":{"shape":"DeregisterInstanceEventNotificationAttributesResult"},
"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",
"http":{
@ -1831,6 +1842,16 @@
"output":{"shape":"DescribeInstanceCreditSpecificationsResult"},
"documentation":"<p>Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are <code>standard</code> and <code>unlimited</code>.</p> <p>If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the <code>unlimited</code> credit option, as well as instances that were previously configured as T2, T3, and T3a with the <code>unlimited</code> credit option. For example, if you resize a T2 instance, while it is configured as <code>unlimited</code>, to an M4 instance, Amazon EC2 returns the M4 instance.</p> <p>If you specify one or more instance IDs, Amazon EC2 returns the credit option (<code>standard</code> or <code>unlimited</code>) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.</p> <p>Recently terminated instances might appear in the returned results. This interval is usually less than one hour.</p> <p>If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html\">Burstable Performance Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
},
"DescribeInstanceEventNotificationAttributes":{
"name":"DescribeInstanceEventNotificationAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeInstanceEventNotificationAttributesRequest"},
"output":{"shape":"DescribeInstanceEventNotificationAttributesResult"},
"documentation":"<p>Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.</p>"
},
"DescribeInstanceStatus":{
"name":"DescribeInstanceStatus",
"http":{
@ -2249,7 +2270,7 @@
},
"input":{"shape":"DescribeSpotInstanceRequestsRequest"},
"output":{"shape":"DescribeSpotInstanceRequestsResult"},
"documentation":"<p>Describes the specified Spot Instance requests.</p> <p>You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot Instance by examining the response. If the status of the Spot Instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>.</p> <p>We recommend that you set <code>MaxResults</code> to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSpotInstanceRequests</code> request to retrieve the remaining results.</p> <p>Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.</p>"
"documentation":"<p>Describes the specified Spot Instance requests.</p> <p>You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot Instance by examining the response. If the status of the Spot Instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances\">DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>.</p> <p>We recommend that you set <code>MaxResults</code> to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSpotInstanceRequests</code> request to retrieve the remaining results.</p> <p>Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.</p>"
},
"DescribeSpotPriceHistory":{
"name":"DescribeSpotPriceHistory",
@ -3523,6 +3544,16 @@
"output":{"shape":"RegisterImageResult"},
"documentation":"<p>Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html\">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <note> <p>For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself.</p> </note> <p>You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-launch-snapshot.html\">Launching a Linux Instance from a Backup</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.</p> <p>Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:</p> <ol> <li> <p>Launch an instance from an existing AMI with that billing product code.</p> </li> <li> <p>Customize the instance.</p> </li> <li> <p>Create an AMI from the instance using <a>CreateImage</a>.</p> </li> </ol> <p>If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html\">Obtaining Billing Information</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.</p>"
},
"RegisterInstanceEventNotificationAttributes":{
"name":"RegisterInstanceEventNotificationAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"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>"
},
"RegisterTransitGatewayMulticastGroupMembers":{
"name":"RegisterTransitGatewayMulticastGroupMembers",
"http":{
@ -3791,7 +3822,7 @@
},
"input":{"shape":"RunInstancesRequest"},
"output":{"shape":"Reservation"},
"documentation":"<p>Launches the specified number of instances using an AMI for which you have permissions. </p> <p>You can specify a number of options, or leave the default options. The following rules apply:</p> <ul> <li> <p>[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.</p> </li> <li> <p>[EC2-Classic] If don't specify an Availability Zone, we choose one for you.</p> </li> <li> <p>Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html#vpc-only-instance-types\">Instance Types Available Only in a VPC</a>.</p> </li> <li> <p>[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.</p> </li> <li> <p>Not all instance types support IPv6 addresses. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a>.</p> </li> <li> <p>If you don't specify a security group ID, we use the default security group. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Security Groups</a>.</p> </li> <li> <p>If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.</p> </li> </ul> <p>You can create a <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\">launch template</a>, which is a resource that contains the parameters to launch an instance. When you launch an instance using <a>RunInstances</a>, you can specify the launch template instead of specifying the launch parameters.</p> <p>To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.</p> <p>An instance is ready for you to use when it's in the <code>running</code> state. You can check the state of your instance using <a>DescribeInstances</a>. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see <a>CreateTags</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Amazon EC2 Resources</a>.</p> <p>Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For troubleshooting, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html\">What To Do If An Instance Immediately Terminates</a>, and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html\">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>Launches the specified number of instances using an AMI for which you have permissions.</p> <p>You can specify a number of options, or leave the default options. The following rules apply:</p> <ul> <li> <p>[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.</p> </li> <li> <p>[EC2-Classic] If don't specify an Availability Zone, we choose one for you.</p> </li> <li> <p>Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-vpc.html#vpc-only-instance-types\">Instance Types Available Only in a VPC</a>.</p> </li> <li> <p>[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.</p> </li> <li> <p>Not all instance types support IPv6 addresses. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a>.</p> </li> <li> <p>If you don't specify a security group ID, we use the default security group. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Security Groups</a>.</p> </li> <li> <p>If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.</p> </li> </ul> <p>You can create a <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\">launch template</a>, which is a resource that contains the parameters to launch an instance. When you launch an instance using <a>RunInstances</a>, you can specify the launch template instead of specifying the launch parameters.</p> <p>To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.</p> <p>An instance is ready for you to use when it's in the <code>running</code> state. You can check the state of your instance using <a>DescribeInstances</a>. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see <a>CreateTags</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Amazon EC2 Resources</a>.</p> <p>Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For troubleshooting, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html\">What To Do If An Instance Immediately Terminates</a>, and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html\">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
},
"RunScheduledInstances":{
"name":"RunScheduledInstances",
@ -8160,6 +8191,11 @@
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>",
"locationName":"dryRun"
},
"TagSpecifications":{
"shape":"TagSpecificationList",
"documentation":"<p>The tags to apply to the new key pair.</p>",
"locationName":"TagSpecification"
}
}
},
@ -8581,6 +8617,20 @@
"PartitionCount":{
"shape":"Integer",
"documentation":"<p>The number of partitions. Valid only when <b>Strategy</b> is set to <code>partition</code>.</p>"
},
"TagSpecifications":{
"shape":"TagSpecificationList",
"documentation":"<p>The tags to apply to the new placement group.</p>",
"locationName":"TagSpecification"
}
}
},
"CreatePlacementGroupResult":{
"type":"structure",
"members":{
"PlacementGroup":{
"shape":"PlacementGroup",
"locationName":"placementGroup"
}
}
},
@ -10260,12 +10310,15 @@
},
"DeleteKeyPairRequest":{
"type":"structure",
"required":["KeyName"],
"members":{
"KeyName":{
"shape":"KeyPairName",
"documentation":"<p>The name of the key pair.</p>"
},
"KeyPairId":{
"shape":"KeyPairId",
"documentation":"<p>The ID of the key pair.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>",
@ -11242,6 +11295,44 @@
},
"documentation":"<p>Contains the parameters for DeregisterImage.</p>"
},
"DeregisterInstanceEventNotificationAttributesRequest":{
"type":"structure",
"members":{
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
},
"InstanceTagAttribute":{
"shape":"DeregisterInstanceTagAttributeRequest",
"documentation":"<p>Information about the tag keys to deregister.</p>"
}
}
},
"DeregisterInstanceEventNotificationAttributesResult":{
"type":"structure",
"members":{
"InstanceTagAttribute":{
"shape":"InstanceTagNotificationAttribute",
"documentation":"<p>The resulting set of tag keys.</p>",
"locationName":"instanceTagAttribute"
}
}
},
"DeregisterInstanceTagAttributeRequest":{
"type":"structure",
"members":{
"IncludeAllTagsOfInstance":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to deregister all tag keys in the current Region. Specify <code>false</code> to deregister all tag keys.</p>"
},
"InstanceTagKeys":{
"shape":"InstanceTagKeySet",
"documentation":"<p>Information about the tag keys to deregister.</p>",
"locationName":"InstanceTagKey"
}
},
"documentation":"<p>Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either <code>IncludeAllTagsOfInstance</code> or <code>InstanceTagKeys</code> in the request</p>"
},
"DeregisterTransitGatewayMulticastGroupMembersRequest":{
"type":"structure",
"members":{
@ -12753,7 +12844,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>instance-id</code> - The ID of the instance.</p> </li> <li> <p> <code>state</code> - The state of the association (<code>associating</code> | <code>associated</code> | <code>disassociating</code> | <code>disassociated</code>).</p> </li> </ul>",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>instance-id</code> - The ID of the instance.</p> </li> <li> <p> <code>state</code> - The state of the association (<code>associating</code> | <code>associated</code> | <code>disassociating</code>).</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@ -13042,6 +13133,25 @@
}
}
},
"DescribeInstanceEventNotificationAttributesRequest":{
"type":"structure",
"members":{
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
}
}
},
"DescribeInstanceEventNotificationAttributesResult":{
"type":"structure",
"members":{
"InstanceTagAttribute":{
"shape":"InstanceTagNotificationAttribute",
"documentation":"<p>Information about the registered tag keys.</p>",
"locationName":"instanceTagAttribute"
}
}
},
"DescribeInstanceStatusRequest":{
"type":"structure",
"members":{
@ -13313,7 +13423,7 @@
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>fingerprint</code> - The fingerprint of the key pair.</p> </li> <li> <p> <code>key-name</code> - The name of the key pair.</p> </li> </ul>",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>key-pair-id</code> - The ID of the key pair.</p> </li> <li> <p> <code>fingerprint</code> - The fingerprint of the key pair.</p> </li> <li> <p> <code>key-name</code> - The name of the key pair.</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>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> </ul>",
"locationName":"Filter"
},
"KeyNames":{
@ -14002,7 +14112,7 @@
"members":{
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>group-name</code> - The name of the placement group.</p> </li> <li> <p> <code>state</code> - The state of the placement group (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p> </li> <li> <p> <code>strategy</code> - The strategy of the placement group (<code>cluster</code> | <code>spread</code> | <code>partition</code>).</p> </li> </ul>",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>group-name</code> - The name of the placement group.</p> </li> <li> <p> <code>state</code> - The state of the placement group (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p> </li> <li> <p> <code>strategy</code> - The strategy of the placement group (<code>cluster</code> | <code>spread</code> | <code>partition</code>).</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 that have a tag with a specific key, regardless of the tag value.</p> </li> </ul>",
"locationName":"Filter"
},
"DryRun":{
@ -15130,7 +15240,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>key</code> - The tag key.</p> </li> <li> <p> <code>resource-id</code> - The ID of the resource.</p> </li> <li> <p> <code>resource-type</code> - The resource type (<code>customer-gateway</code> | <code>dedicated-host</code> | <code>dhcp-options</code> | <code>elastic-ip</code> | <code>fleet</code> | <code>fpga-image</code> | <code>image</code> | <code>instance</code> | <code>host-reservation</code> | <code>internet-gateway</code> | <code>launch-template</code> | <code>natgateway</code> | <code>network-acl</code> | <code>network-interface</code> | <code>placement-group</code> | <code>reserved-instances</code> | <code>route-table</code> | <code>security-group</code> | <code>snapshot</code> | <code>spot-instances-request</code> | <code>subnet</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-endpoint</code> | <code>vpc-endpoint-service</code> | <code>vpc-peering-connection</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>).</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - The key/value combination of the tag. For example, specify \"tag:Owner\" for the filter name and \"TeamA\" for the filter value to find resources with the tag \"Owner=TeamA\".</p> </li> <li> <p> <code>value</code> - The tag value.</p> </li> </ul>",
"documentation":"<p>The filters.</p> <ul> <li> <p> <code>key</code> - The tag key.</p> </li> <li> <p> <code>resource-id</code> - The ID of the resource.</p> </li> <li> <p> <code>resource-type</code> - The resource type (<code>customer-gateway</code> | <code>dedicated-host</code> | <code>dhcp-options</code> | <code>elastic-ip</code> | <code>fleet</code> | <code>fpga-image</code> | <code>host-reservation</code> | <code>image</code> | <code>instance</code> | <code>internet-gateway</code> | <code>key-pair</code> | <code>launch-template</code> | <code>natgateway</code> | <code>network-acl</code> | <code>network-interface</code> | <code>placement-group</code> | <code>reserved-instances</code> | <code>route-table</code> | <code>security-group</code> | <code>snapshot</code> | <code>spot-instances-request</code> | <code>subnet</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-endpoint</code> | <code>vpc-endpoint-service</code> | <code>vpc-peering-connection</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>).</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - The key/value combination of the tag. For example, specify \"tag:Owner\" for the filter name and \"TeamA\" for the filter value to find resources with the tag \"Owner=TeamA\".</p> </li> <li> <p> <code>value</code> - The tag value.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@ -21075,6 +21185,11 @@
"shape":"Blob",
"documentation":"<p>The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.</p>",
"locationName":"publicKeyMaterial"
},
"TagSpecifications":{
"shape":"TagSpecificationList",
"documentation":"<p>The tags to apply to the imported key pair.</p>",
"locationName":"TagSpecification"
}
}
},
@ -21090,6 +21205,16 @@
"shape":"String",
"documentation":"<p>The key pair name you provided.</p>",
"locationName":"keyName"
},
"KeyPairId":{
"shape":"String",
"documentation":"<p>The ID of the resulting key pair.</p>",
"locationName":"keyPairId"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags applied to the imported key pair.</p>",
"locationName":"tagSet"
}
}
},
@ -22506,6 +22631,29 @@
},
"documentation":"<p>Describes the disks that are available for the instance type.</p>"
},
"InstanceTagKeySet":{
"type":"list",
"member":{
"shape":"String",
"locationName":"item"
}
},
"InstanceTagNotificationAttribute":{
"type":"structure",
"members":{
"InstanceTagKeys":{
"shape":"InstanceTagKeySet",
"documentation":"<p>The registered tag keys.</p>",
"locationName":"instanceTagKeySet"
},
"IncludeAllTagsOfInstance":{
"shape":"Boolean",
"documentation":"<p>Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. <code>true</code> indicates that all tag keys in the current Region are registered.</p>",
"locationName":"includeAllTagsOfInstance"
}
},
"documentation":"<p>Describes the registered tag keys for the current Region.</p>"
},
"InstanceType":{
"type":"string",
"enum":[
@ -23274,6 +23422,11 @@
"shape":"String",
"documentation":"<p>The ID of the key pair.</p>",
"locationName":"keyPairId"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Any tags applied to the key pair.</p>",
"locationName":"tagSet"
}
},
"documentation":"<p>Describes a key pair.</p>"
@ -27830,12 +27983,12 @@
"members":{
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>The Availability Zone of the instance.</p> <p>If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>The Availability Zone of the instance.</p> <p>If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"availabilityZone"
},
"Affinity":{
"shape":"String",
"documentation":"<p>The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the <a>ImportInstance</a> command.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html\">ImportInstance</a> command.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"affinity"
},
"GroupName":{
@ -27845,27 +27998,27 @@
},
"PartitionNumber":{
"shape":"Integer",
"documentation":"<p>The number of the partition the instance is in. Valid only if the placement group strategy is set to <code>partition</code>.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>The number of the partition the instance is in. Valid only if the placement group strategy is set to <code>partition</code>.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"partitionNumber"
},
"HostId":{
"shape":"String",
"documentation":"<p>The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the <a>ImportInstance</a> command.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html\">ImportInstance</a> command.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"hostId"
},
"Tenancy":{
"shape":"Tenancy",
"documentation":"<p>The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware. The <code>host</code> tenancy is not supported for the <a>ImportInstance</a> command.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware. The <code>host</code> tenancy is not supported for the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html\">ImportInstance</a> command.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"tenancy"
},
"SpreadDomain":{
"shape":"String",
"documentation":"<p>Reserved for future use.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>Reserved for future use.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"spreadDomain"
},
"HostResourceGroupArn":{
"shape":"String",
"documentation":"<p>The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the <b>Tenancy</b> parameter or set it to <code>host</code>.</p> <p>This parameter is not supported by .</p>",
"documentation":"<p>The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the <b>Tenancy</b> parameter or set it to <code>host</code>.</p> <p>This parameter is not supported by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet\">CreateFleet</a>.</p>",
"locationName":"hostResourceGroupArn"
}
},
@ -28901,6 +29054,44 @@
},
"documentation":"<p>Contains the output of RegisterImage.</p>"
},
"RegisterInstanceEventNotificationAttributesRequest":{
"type":"structure",
"members":{
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
},
"InstanceTagAttribute":{
"shape":"RegisterInstanceTagAttributeRequest",
"documentation":"<p>Information about the tag keys to register.</p>"
}
}
},
"RegisterInstanceEventNotificationAttributesResult":{
"type":"structure",
"members":{
"InstanceTagAttribute":{
"shape":"InstanceTagNotificationAttribute",
"documentation":"<p>The resulting set of tag keys.</p>",
"locationName":"instanceTagAttribute"
}
}
},
"RegisterInstanceTagAttributeRequest":{
"type":"structure",
"members":{
"IncludeAllTagsOfInstance":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to register all tag keys in the current Region. Specify <code>true</code> to register all tag keys.</p>"
},
"InstanceTagKeys":{
"shape":"InstanceTagKeySet",
"documentation":"<p>The tag keys to register.</p>",
"locationName":"InstanceTagKey"
}
},
"documentation":"<p>Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either <code>IncludeAllTagsOfInstance</code> or <code>InstanceTagKeys</code> in the request</p>"
},
"RegisterTransitGatewayMulticastGroupMembersRequest":{
"type":"structure",
"members":{
@ -32877,7 +33068,7 @@
},
"IamFleetRole":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites\">Spot Fleet Prerequisites</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using <a>CancelSpotFleetRequests</a> or when the Spot Fleet request expires, if you set <code>TerminateInstancesWithExpiration</code>.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites\">Spot Fleet Prerequisites</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests\">CancelSpotFleetRequests</a> or when the Spot Fleet request expires, if you set <code>TerminateInstancesWithExpiration</code>.</p>",
"locationName":"iamFleetRole"
},
"LaunchSpecifications":{
@ -33188,7 +33379,7 @@
},
"SpotInstanceType":{
"shape":"SpotInstanceType",
"documentation":"<p>The Spot Instance request type. For <a>RunInstances</a>, persistent Spot Instance requests are only supported when <b>InstanceInterruptionBehavior</b> is set to either <code>hibernate</code> or <code>stop</code>.</p>"
"documentation":"<p>The Spot Instance request type. For <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances\">RunInstances</a>, persistent Spot Instance requests are only supported when <b>InstanceInterruptionBehavior</b> is set to either <code>hibernate</code> or <code>stop</code>.</p>"
},
"BlockDurationMinutes":{
"shape":"Integer",
@ -33922,7 +34113,7 @@
"locationName":"defaultTargetCapacityType"
}
},
"documentation":"<p>The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p> <p>You can use the On-Demand Instance <code>MaxTotalPrice</code> parameter, the Spot Instance <code>MaxTotalPrice</code>, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasnt met the target capacity. The <code>MaxTotalPrice</code> parameters are located in and </p>"
"documentation":"<p>The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p> <p>You can use the On-Demand Instance <code>MaxTotalPrice</code> parameter, the Spot Instance <code>MaxTotalPrice</code>, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasnt met the target capacity. The <code>MaxTotalPrice</code> parameters are located in <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html\">OnDemandOptions</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions\">SpotOptions</a> </p>"
},
"TargetCapacitySpecificationRequest":{
"type":"structure",
@ -33945,7 +34136,7 @@
"documentation":"<p>The default <code>TotalTargetCapacity</code>, which is either <code>Spot</code> or <code>On-Demand</code>.</p>"
}
},
"documentation":"<p>The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p> <p>You can use the On-Demand Instance <code>MaxTotalPrice</code> parameter, the Spot Instance <code>MaxTotalPrice</code> parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasnt met the target capacity. The <code>MaxTotalPrice</code> parameters are located in and .</p>"
"documentation":"<p>The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is <code>maintain</code>, you can specify a target capacity of 0 and add capacity later.</p> <p>You can use the On-Demand Instance <code>MaxTotalPrice</code> parameter, the Spot Instance <code>MaxTotalPrice</code> parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasnt met the target capacity. The <code>MaxTotalPrice</code> parameters are located in <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptionsRequest\">OnDemandOptionsRequest</a> and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptionsRequest\">SpotOptionsRequest</a>.</p>"
},
"TargetConfiguration":{
"type":"structure",

View file

@ -154,26 +154,6 @@
"title": "To describe all repositories in the current account"
}
],
"GetAuthorizationToken": [
{
"input": {
},
"output": {
"authorizationData": [
{
"authorizationToken": "QVdTOkN...",
"expiresAt": "1470951892.432",
"proxyEndpoint": "https://012345678901.dkr.ecr.us-west-2.amazonaws.com"
}
]
},
"comments": {
},
"description": "This example gets an authorization token for your default registry.",
"id": "getauthorizationtoken-example-1470867047084",
"title": "To obtain an authorization token"
}
],
"GetRepositoryPolicy": [
{
"input": {

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,114 @@
{
"version": "1.0",
"examples": {
"CreateCluster": [
{
"input": {
"version": "1.10",
"name": "prod",
"clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951",
"resourcesVpcConfig": {
"securityGroupIds": [
"sg-6979fe18"
],
"subnetIds": [
"subnet-6782e71e",
"subnet-e7e761ac"
]
},
"roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example creates an Amazon EKS cluster called prod.",
"id": "to-create-a-new-cluster-1527868185648",
"title": "To create a new cluster"
}
],
"DeleteCluster": [
{
"input": {
"name": "devel"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example command deletes a cluster named `devel` in your default region.",
"id": "to-delete-a-cluster-1527868641252",
"title": "To delete a cluster"
}
],
"DescribeCluster": [
{
"input": {
"name": "devel"
},
"output": {
"cluster": {
"version": "1.10",
"name": "devel",
"arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel",
"certificateAuthority": {
"data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
},
"createdAt": 1527807879.988,
"endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com",
"resourcesVpcConfig": {
"securityGroupIds": [
"sg-6979fe18"
],
"subnetIds": [
"subnet-6782e71e",
"subnet-e7e761ac"
],
"vpcId": "vpc-950809ec"
},
"roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI",
"status": "ACTIVE"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example command provides a description of the specified cluster in your default region.",
"id": "to-describe-a-cluster-1527868708512",
"title": "To describe a cluster"
}
],
"ListClusters": [
{
"input": {
},
"output": {
"clusters": [
"devel",
"prod"
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example command lists all of your available clusters in your default region.",
"id": "to-list-your-available-clusters-1527868801040",
"title": "To list your available clusters"
}
]
}
}

View file

@ -84,7 +84,7 @@
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes the Amazon EKS cluster control plane.</p> <p>If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html\">Deleting a Cluster</a> in the <i>Amazon EKS User Guide</i>.</p> <p>If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see <a>DeleteNodegroup</a> and<a>DeleteFargateProfile</a>.</p>"
"documentation":"<p>Deletes the Amazon EKS cluster control plane.</p> <p>If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html\">Deleting a Cluster</a> in the <i>Amazon EKS User Guide</i>.</p> <p>If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see <a>DeleteNodegroup</a> and <a>DeleteFargateProfile</a>.</p>"
},
"DeleteFargateProfile":{
"name":"DeleteFargateProfile",
@ -232,7 +232,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the Amazon EKS node groups associated with the specified cluster in your AWS account in the specified Region.</p>"
"documentation":"<p>Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -666,7 +666,7 @@
},
"nodeRole":{
"shape":"String",
"documentation":"<p>The IAM role associated with your node group. The Amazon EKS worker node <code>kubelet</code> daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html\">Amazon EKS Worker Node IAM Role</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node <code>kubelet</code> daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html\">Amazon EKS Worker Node IAM Role</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"labels":{
"shape":"labelsMap",
@ -1436,8 +1436,11 @@
"Ec2LaunchTemplateNotFound",
"Ec2LaunchTemplateVersionMismatch",
"Ec2SubnetNotFound",
"Ec2SubnetInvalidConfiguration",
"IamInstanceProfileNotFound",
"IamLimitExceeded",
"IamNodeRoleNotFound",
"NodeCreationFailure",
"AsgInstanceLaunchFailures",
"InstanceLimitExceeded",
"InsufficientFreeAddresses",

View file

@ -1,3 +1,10 @@
{
"pagination": {}
"pagination": {
"DescribeAccelerators": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "acceleratorSet"
}
}
}

View file

@ -13,6 +13,49 @@
"uid":"elastic-inference-2017-07-25"
},
"operations":{
"DescribeAcceleratorOfferings":{
"name":"DescribeAcceleratorOfferings",
"http":{
"method":"POST",
"requestUri":"/describe-accelerator-offerings"
},
"input":{"shape":"DescribeAcceleratorOfferingsRequest"},
"output":{"shape":"DescribeAcceleratorOfferingsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p> Describes the locations in which a given accelerator type or set of types is present in a given region. </p>"
},
"DescribeAcceleratorTypes":{
"name":"DescribeAcceleratorTypes",
"http":{
"method":"GET",
"requestUri":"/describe-accelerator-types"
},
"input":{"shape":"DescribeAcceleratorTypesRequest"},
"output":{"shape":"DescribeAcceleratorTypesResponse"},
"errors":[
{"shape":"InternalServerException"}
],
"documentation":"<p> Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput. </p>"
},
"DescribeAccelerators":{
"name":"DescribeAccelerators",
"http":{
"method":"POST",
"requestUri":"/describe-accelerators"
},
"input":{"shape":"DescribeAcceleratorsRequest"},
"output":{"shape":"DescribeAcceleratorsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p> Describes information over a provided set of accelerators belonging to an account. </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
@ -26,7 +69,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"Returns all tags of an Elastic Inference Accelerator."
"documentation":"<p> Returns all tags of an Elastic Inference Accelerator. </p>"
},
"TagResource":{
"name":"TagResource",
@ -41,7 +84,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"Adds the specified tag(s) to an Elastic Inference Accelerator."
"documentation":"<p> Adds the specified tags to an Elastic Inference Accelerator. </p>"
},
"UntagResource":{
"name":"UntagResource",
@ -56,35 +99,275 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"Removes the specified tag(s) from an Elastic Inference Accelerator."
"documentation":"<p> Removes the specified tags from an Elastic Inference Accelerator. </p>"
}
},
"shapes":{
"AcceleratorHealthStatus":{
"type":"string",
"max":256,
"min":1
},
"AcceleratorId":{
"type":"string",
"max":256,
"min":1,
"pattern":"^eia-[0-9a-f]+$"
},
"AcceleratorIdList":{
"type":"list",
"member":{"shape":"AcceleratorId"},
"max":1000,
"min":0
},
"AcceleratorType":{
"type":"structure",
"members":{
"acceleratorTypeName":{
"shape":"AcceleratorTypeName",
"documentation":"<p> The name of the Elastic Inference Accelerator type. </p>"
},
"memoryInfo":{
"shape":"MemoryInfo",
"documentation":"<p> The memory information of the Elastic Inference Accelerator type. </p>"
},
"throughputInfo":{
"shape":"ThroughputInfoList",
"documentation":"<p> The throughput information of the Elastic Inference Accelerator type. </p>"
}
},
"documentation":"<p> The details of an Elastic Inference Accelerator type. </p>"
},
"AcceleratorTypeList":{
"type":"list",
"member":{"shape":"AcceleratorType"},
"max":100,
"min":0
},
"AcceleratorTypeName":{
"type":"string",
"max":256,
"min":1,
"pattern":"^\\S+$"
},
"AcceleratorTypeNameList":{
"type":"list",
"member":{"shape":"AcceleratorTypeName"},
"max":100,
"min":0
},
"AcceleratorTypeOffering":{
"type":"structure",
"members":{
"acceleratorType":{
"shape":"AcceleratorTypeName",
"documentation":"<p> The name of the Elastic Inference Accelerator type. </p>"
},
"locationType":{
"shape":"LocationType",
"documentation":"<p> The location type for the offering. It can assume the following values: region: defines that the offering is at the regional level. availability-zone: defines that the offering is at the availability zone level. availability-zone-id: defines that the offering is at the availability zone level, defined by the availability zone id. </p>"
},
"location":{
"shape":"Location",
"documentation":"<p> The location for the offering. It will return either the region, availability zone or availability zone id for the offering depending on the locationType value. </p>"
}
},
"documentation":"<p> The offering for an Elastic Inference Accelerator type. </p>"
},
"AcceleratorTypeOfferingList":{
"type":"list",
"member":{"shape":"AcceleratorTypeOffering"},
"max":100,
"min":0
},
"AvailabilityZone":{
"type":"string",
"max":256,
"min":1
},
"BadRequestException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"Raised when a malformed input has been provided to the API.",
"documentation":"<p> Raised when a malformed input has been provided to the API. </p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DescribeAcceleratorOfferingsRequest":{
"type":"structure",
"required":["locationType"],
"members":{
"locationType":{
"shape":"LocationType",
"documentation":"<p> The location type that you want to describe accelerator type offerings for. It can assume the following values: region: will return the accelerator type offering at the regional level. availability-zone: will return the accelerator type offering at the availability zone level. availability-zone-id: will return the accelerator type offering at the availability zone level returning the availability zone id. </p>"
},
"acceleratorTypes":{
"shape":"AcceleratorTypeNameList",
"documentation":"<p> The list of accelerator types to describe. </p>"
}
}
},
"DescribeAcceleratorOfferingsResponse":{
"type":"structure",
"members":{
"acceleratorTypeOfferings":{
"shape":"AcceleratorTypeOfferingList",
"documentation":"<p> The list of accelerator type offerings for a specific location. </p>"
}
}
},
"DescribeAcceleratorTypesRequest":{
"type":"structure",
"members":{
}
},
"DescribeAcceleratorTypesResponse":{
"type":"structure",
"members":{
"acceleratorTypes":{
"shape":"AcceleratorTypeList",
"documentation":"<p> The available accelerator types. </p>"
}
}
},
"DescribeAcceleratorsRequest":{
"type":"structure",
"members":{
"acceleratorIds":{
"shape":"AcceleratorIdList",
"documentation":"<p> The IDs of the accelerators to describe. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> One or more filters. Filter names and values are case-sensitive. Valid filter names are: accelerator-types: can provide a list of accelerator type names to filter for. instance-id: can provide a list of EC2 instance ids to filter for. </p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p> The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI. </p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
"DescribeAcceleratorsResponse":{
"type":"structure",
"members":{
"acceleratorSet":{
"shape":"ElasticInferenceAcceleratorSet",
"documentation":"<p> The details of the Elastic Inference Accelerators. </p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
"ElasticInferenceAccelerator":{
"type":"structure",
"members":{
"acceleratorHealth":{
"shape":"ElasticInferenceAcceleratorHealth",
"documentation":"<p> The health of the Elastic Inference Accelerator. </p>"
},
"acceleratorType":{
"shape":"AcceleratorTypeName",
"documentation":"<p> The type of the Elastic Inference Accelerator. </p>"
},
"acceleratorId":{
"shape":"AcceleratorId",
"documentation":"<p> The ID of the Elastic Inference Accelerator. </p>"
},
"availabilityZone":{
"shape":"AvailabilityZone",
"documentation":"<p> The availability zone where the Elastic Inference Accelerator is present. </p>"
},
"attachedResource":{
"shape":"ResourceArn",
"documentation":"<p> The ARN of the resource that the Elastic Inference Accelerator is attached to. </p>"
}
},
"documentation":"<p> The details of an Elastic Inference Accelerator. </p>"
},
"ElasticInferenceAcceleratorHealth":{
"type":"structure",
"members":{
"status":{
"shape":"AcceleratorHealthStatus",
"documentation":"<p> The health status of the Elastic Inference Accelerator. </p>"
}
},
"documentation":"<p> The health details of an Elastic Inference Accelerator. </p>"
},
"ElasticInferenceAcceleratorSet":{
"type":"list",
"member":{"shape":"ElasticInferenceAccelerator"}
},
"Filter":{
"type":"structure",
"members":{
"name":{
"shape":"FilterName",
"documentation":"<p> The filter name for the Elastic Inference Accelerator list. It can assume the following values: accelerator-type: the type of Elastic Inference Accelerator to filter for. instance-id: an EC2 instance id to filter for. </p>"
},
"values":{
"shape":"ValueStringList",
"documentation":"<p> The values for the filter of the Elastic Inference Accelerator list. </p>"
}
},
"documentation":"<p> A filter expression for the Elastic Inference Accelerator list. </p>"
},
"FilterList":{
"type":"list",
"member":{"shape":"Filter"},
"max":100,
"min":0
},
"FilterName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^\\S+$"
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"Raised when an unexpected error occurred during request processing.",
"documentation":"<p> Raised when an unexpected error occurred during request processing. </p>",
"error":{"httpStatusCode":500},
"exception":true
},
"Key":{
"type":"string",
"max":256,
"min":1,
"pattern":"^\\S+$"
},
"KeyValuePair":{
"type":"structure",
"members":{
"key":{
"shape":"Key",
"documentation":"<p> The throughput value of the Elastic Inference Accelerator type. It can assume the following values: TFLOPS16bit: the throughput expressed in 16bit TeraFLOPS. TFLOPS32bit: the throughput expressed in 32bit TeraFLOPS. </p>"
},
"value":{
"shape":"Value",
"documentation":"<p> The throughput value of the Elastic Inference Accelerator type. </p>"
}
},
"documentation":"<p> A throughput entry for an Elastic Inference Accelerator type. </p>"
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"ResourceARN",
"documentation":"The ARN of the Elastic Inference Accelerator to list the tags for.",
"documentation":"<p> The ARN of the Elastic Inference Accelerator to list the tags for. </p>",
"location":"uri",
"locationName":"resourceArn"
}
@ -95,13 +378,55 @@
"members":{
"tags":{
"shape":"TagMap",
"documentation":"The tags of the Elastic Inference Accelerator."
"documentation":"<p> The tags of the Elastic Inference Accelerator. </p>"
}
}
},
"Location":{
"type":"string",
"max":256,
"min":1
},
"LocationType":{
"type":"string",
"enum":[
"region",
"availability-zone",
"availability-zone-id"
],
"max":256,
"min":1
},
"MaxResults":{
"type":"integer",
"max":100,
"min":0
},
"MemoryInfo":{
"type":"structure",
"members":{
"sizeInMiB":{
"shape":"Integer",
"documentation":"<p> The size in mebibytes of the Elastic Inference Accelerator type. </p>"
}
},
"documentation":"<p> The memory information of an Elastic Inference Accelerator type. </p>"
},
"NextToken":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^[A-Za-z0-9+/]+={0,2}$"
},
"ResourceARN":{
"type":"string",
"max":1011,
"min":1,
"pattern":"^arn:aws\\S*:elastic-inference:\\S+:\\d{12}:elastic-inference-accelerator/eia-[0-9a-f]+$"
},
"ResourceArn":{
"type":"string",
"max":1283,
"min":1
},
"ResourceNotFoundException":{
@ -109,15 +434,20 @@
"members":{
"message":{"shape":"String"}
},
"documentation":"Raised when the requested resource cannot be found.",
"documentation":"<p> Raised when the requested resource cannot be found. </p>",
"error":{"httpStatusCode":404},
"exception":true
},
"String":{"type":"string"},
"String":{
"type":"string",
"max":500000,
"pattern":"^.*$"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
"min":1,
"pattern":"^\\S$"
},
"TagKeyList":{
"type":"list",
@ -141,13 +471,13 @@
"members":{
"resourceArn":{
"shape":"ResourceARN",
"documentation":"The ARN of the Elastic Inference Accelerator to tag.",
"documentation":"<p> The ARN of the Elastic Inference Accelerator to tag. </p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"The tags to add to the Elastic Inference Accelerator."
"documentation":"<p> The tags to add to the Elastic Inference Accelerator. </p>"
}
}
},
@ -160,6 +490,12 @@
"type":"string",
"max":256
},
"ThroughputInfoList":{
"type":"list",
"member":{"shape":"KeyValuePair"},
"max":100,
"min":0
},
"UntagResourceRequest":{
"type":"structure",
"required":[
@ -169,13 +505,13 @@
"members":{
"resourceArn":{
"shape":"ResourceARN",
"documentation":"The ARN of the Elastic Inference Accelerator to untag.",
"documentation":"<p> The ARN of the Elastic Inference Accelerator to untag. </p>",
"location":"uri",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"The list of tags to remove from the Elastic Inference Accelerator.",
"documentation":"<p> The list of tags to remove from the Elastic Inference Accelerator. </p>",
"location":"querystring",
"locationName":"tagKeys"
}
@ -185,7 +521,14 @@
"type":"structure",
"members":{
}
},
"Value":{"type":"integer"},
"ValueStringList":{
"type":"list",
"member":{"shape":"String"},
"max":100,
"min":0
}
},
"documentation":"Elastic Inference public APIs."
"documentation":"<p> Elastic Inference public APIs. </p>"
}

View file

@ -0,0 +1,3149 @@
{
"version": "1.0",
"examples": {
"AddTagsToResource": [
{
"input": {
"ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster",
"Tags": [
{
"Key": "APIVersion",
"Value": "20150202"
},
{
"Key": "Service",
"Value": "ElastiCache"
}
]
},
"output": {
"TagList": [
{
"Key": "APIVersion",
"Value": "20150202"
},
{
"Key": "Service",
"Value": "ElastiCache"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.",
"id": "addtagstoresource-1482430264385",
"title": "AddTagsToResource"
}
],
"AuthorizeCacheSecurityGroupIngress": [
{
"input": {
"CacheSecurityGroupName": "my-sec-grp",
"EC2SecurityGroupName": "my-ec2-sec-grp",
"EC2SecurityGroupOwnerId": "1234567890"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon EC2 security groups are used as the authorization mechanism.",
"id": "authorizecachecachesecuritygroupingress-1483046446206",
"title": "AuthorizeCacheCacheSecurityGroupIngress"
}
],
"CopySnapshot": [
{
"input": {
"SourceSnapshotName": "my-snapshot",
"TargetBucket": "",
"TargetSnapshotName": "my-snapshot-copy"
},
"output": {
"Snapshot": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-21T22:24:04.955Z",
"CacheClusterId": "my-redis4",
"CacheNodeType": "cache.m3.large",
"CacheParameterGroupName": "default.redis3.2",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeSnapshots": [
{
"CacheNodeCreateTime": "2016-12-21T22:24:04.955Z",
"CacheNodeId": "0001",
"CacheSize": "3 MB",
"SnapshotCreateTime": "2016-12-28T07:00:52Z"
}
],
"NumCacheNodes": 1,
"Port": 6379,
"PreferredAvailabilityZone": "us-east-1c",
"PreferredMaintenanceWindow": "tue:09:30-tue:10:30",
"SnapshotName": "my-snapshot-copy",
"SnapshotRetentionLimit": 7,
"SnapshotSource": "manual",
"SnapshotStatus": "creating",
"SnapshotWindow": "07:00-08:00",
"VpcId": "vpc-3820329f3"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Copies a snapshot to a specified name.",
"id": "copysnapshot-1482961393820",
"title": "CopySnapshot"
}
],
"CreateCacheCluster": [
{
"input": {
"AZMode": "cross-az",
"CacheClusterId": "my-memcached-cluster",
"CacheNodeType": "cache.r3.large",
"CacheSubnetGroupName": "default",
"Engine": "memcached",
"EngineVersion": "1.4.24",
"NumCacheNodes": 2,
"Port": 11211
},
"output": {
"CacheCluster": {
"AutoMinorVersionUpgrade": true,
"CacheClusterId": "my-memcached-cluster",
"CacheClusterStatus": "creating",
"CacheNodeType": "cache.r3.large",
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.memcached1.4",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
"Engine": "memcached",
"EngineVersion": "1.4.24",
"NumCacheNodes": 2,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "Multiple",
"PreferredMaintenanceWindow": "wed:09:00-wed:10:00"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a Memcached cluster with 2 nodes. ",
"id": "createcachecluster-1474994727381",
"title": "CreateCacheCluster"
},
{
"input": {
"AutoMinorVersionUpgrade": true,
"CacheClusterId": "my-redis",
"CacheNodeType": "cache.r3.larage",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NumCacheNodes": 1,
"Port": 6379,
"PreferredAvailabilityZone": "us-east-1c",
"SnapshotRetentionLimit": 7
},
"output": {
"CacheCluster": {
"AutoMinorVersionUpgrade": true,
"CacheClusterId": "my-redis",
"CacheClusterStatus": "creating",
"CacheNodeType": "cache.m3.large",
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.redis3.2",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https: //console.aws.amazon.com/elasticache/home#client-download: ",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NumCacheNodes": 1,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "us-east-1c",
"PreferredMaintenanceWindow": "fri: 05: 30-fri: 06: 30",
"SnapshotRetentionLimit": 7,
"SnapshotWindow": "10: 00-11: 00"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a Redis cluster with 1 node. ",
"id": "createcachecluster-1474994727381",
"title": "CreateCacheCluster"
}
],
"CreateCacheParameterGroup": [
{
"input": {
"CacheParameterGroupFamily": "redis2.8",
"CacheParameterGroupName": "custom-redis2-8",
"Description": "Custom Redis 2.8 parameter group."
},
"output": {
"CacheParameterGroup": {
"CacheParameterGroupFamily": "redis2.8",
"CacheParameterGroupName": "custom-redis2-8",
"Description": "Custom Redis 2.8 parameter group."
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates the Amazon ElastiCache parameter group custom-redis2-8.",
"id": "createcacheparametergroup-1474997699362",
"title": "CreateCacheParameterGroup"
}
],
"CreateCacheSecurityGroup": [
{
"input": {
"CacheSecurityGroupName": "my-cache-sec-grp",
"Description": "Example ElastiCache security group."
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.",
"id": "createcachesecuritygroup-1483041506604",
"title": "CreateCacheSecurityGroup"
}
],
"CreateCacheSubnetGroup": [
{
"input": {
"CacheSubnetGroupDescription": "Sample subnet group",
"CacheSubnetGroupName": "my-sn-grp2",
"SubnetIds": [
"subnet-6f28c982",
"subnet-bcd382f3",
"subnet-845b3e7c0"
]
},
"output": {
"CacheSubnetGroup": {
"CacheSubnetGroupDescription": "My subnet group.",
"CacheSubnetGroupName": "my-sn-grp",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetIdentifier": "subnet-6f28c982"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-bcd382f3"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetIdentifier": "subnet-845b3e7c0"
}
],
"VpcId": "vpc-91280df6"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a new cache subnet group.",
"id": "createcachesubnet-1483042274558",
"title": "CreateCacheSubnet"
}
],
"CreateReplicationGroup": [
{
"input": {
"AutomaticFailoverEnabled": true,
"CacheNodeType": "cache.m3.medium",
"Engine": "redis",
"EngineVersion": "2.8.24",
"NumCacheClusters": 3,
"ReplicationGroupDescription": "A Redis replication group.",
"ReplicationGroupId": "my-redis-rg",
"SnapshotRetentionLimit": 30
},
"output": {
"ReplicationGroup": {
"AutomaticFailover": "enabling",
"Description": "A Redis replication group.",
"MemberClusters": [
"my-redis-rg-001",
"my-redis-rg-002",
"my-redis-rg-003"
],
"PendingModifiedValues": {
},
"ReplicationGroupId": "my-redis-rg",
"SnapshottingClusterId": "my-redis-rg-002",
"Status": "creating"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a Redis replication group with 3 nodes.",
"id": "createcachereplicationgroup-1474998730655",
"title": "CreateCacheReplicationGroup"
},
{
"input": {
"AutoMinorVersionUpgrade": true,
"CacheNodeType": "cache.m3.medium",
"CacheParameterGroupName": "default.redis3.2.cluster.on",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeGroupConfiguration": [
{
"PrimaryAvailabilityZone": "us-east-1c",
"ReplicaAvailabilityZones": [
"us-east-1b"
],
"ReplicaCount": 1,
"Slots": "0-8999"
},
{
"PrimaryAvailabilityZone": "us-east-1a",
"ReplicaAvailabilityZones": [
"us-east-1a",
"us-east-1c"
],
"ReplicaCount": 2,
"Slots": "9000-16383"
}
],
"NumNodeGroups": 2,
"ReplicationGroupDescription": "A multi-sharded replication group",
"ReplicationGroupId": "clustered-redis-rg",
"SnapshotRetentionLimit": 8
},
"output": {
"ReplicationGroup": {
"AutomaticFailover": "enabled",
"Description": "Sharded replication group",
"MemberClusters": [
"rc-rg3-0001-001",
"rc-rg3-0001-002",
"rc-rg3-0002-001",
"rc-rg3-0002-002",
"rc-rg3-0002-003"
],
"PendingModifiedValues": {
},
"ReplicationGroupId": "clustered-redis-rg",
"SnapshotRetentionLimit": 8,
"SnapshotWindow": "05:30-06:30",
"Status": "creating"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.",
"id": "createreplicationgroup-1483657035585",
"title": "CreateReplicationGroup"
}
],
"CreateSnapshot": [
{
"input": {
"CacheClusterId": "onenoderedis",
"SnapshotName": "snapshot-1"
},
"output": {
"Snapshot": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2017-02-03T15:43:36.278Z",
"CacheClusterId": "onenoderedis",
"CacheNodeType": "cache.m3.medium",
"CacheParameterGroupName": "default.redis3.2",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeSnapshots": [
{
"CacheNodeCreateTime": "2017-02-03T15:43:36.278Z",
"CacheNodeId": "0001",
"CacheSize": ""
}
],
"NumCacheNodes": 1,
"Port": 6379,
"PreferredAvailabilityZone": "us-west-2c",
"PreferredMaintenanceWindow": "sat:08:00-sat:09:00",
"SnapshotName": "snapshot-1",
"SnapshotRetentionLimit": 1,
"SnapshotSource": "manual",
"SnapshotStatus": "creating",
"SnapshotWindow": "00:00-01:00",
"VpcId": "vpc-73c3cd17"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a snapshot of a non-clustered Redis cluster that has only one node.",
"id": "createsnapshot-1474999681024",
"title": "CreateSnapshot - NonClustered Redis, no read-replicas"
},
{
"input": {
"CacheClusterId": "threenoderedis-001",
"SnapshotName": "snapshot-2"
},
"output": {
"Snapshot": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2017-02-03T15:43:36.278Z",
"CacheClusterId": "threenoderedis-001",
"CacheNodeType": "cache.m3.medium",
"CacheParameterGroupName": "default.redis3.2",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeSnapshots": [
{
"CacheNodeCreateTime": "2017-02-03T15:43:36.278Z",
"CacheNodeId": "0001",
"CacheSize": ""
}
],
"NumCacheNodes": 1,
"Port": 6379,
"PreferredAvailabilityZone": "us-west-2c",
"PreferredMaintenanceWindow": "sat:08:00-sat:09:00",
"SnapshotName": "snapshot-2",
"SnapshotRetentionLimit": 1,
"SnapshotSource": "manual",
"SnapshotStatus": "creating",
"SnapshotWindow": "00:00-01:00",
"VpcId": "vpc-73c3cd17"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas. CacheClusterId must be a specific node in the cluster.",
"id": "createsnapshot-1474999681024",
"title": "CreateSnapshot - NonClustered Redis, 2 read-replicas"
},
{
"input": {
"ReplicationGroupId": "clusteredredis",
"SnapshotName": "snapshot-2x5"
},
"output": {
"Snapshot": {
"AutoMinorVersionUpgrade": true,
"AutomaticFailover": "enabled",
"CacheNodeType": "cache.m3.medium",
"CacheParameterGroupName": "default.redis3.2.cluster.on",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeSnapshots": [
{
"CacheSize": "",
"NodeGroupId": "0001"
},
{
"CacheSize": "",
"NodeGroupId": "0002"
}
],
"NumNodeGroups": 2,
"Port": 6379,
"PreferredMaintenanceWindow": "mon:09:30-mon:10:30",
"ReplicationGroupDescription": "Redis cluster with 2 shards.",
"ReplicationGroupId": "clusteredredis",
"SnapshotName": "snapshot-2x5",
"SnapshotRetentionLimit": 1,
"SnapshotSource": "manual",
"SnapshotStatus": "creating",
"SnapshotWindow": "12:00-13:00",
"VpcId": "vpc-73c3cd17"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.",
"id": "createsnapshot-clustered-redis-1486144841758",
"title": "CreateSnapshot-clustered Redis"
}
],
"DeleteCacheCluster": [
{
"input": {
"CacheClusterId": "my-memcached"
},
"output": {
"CacheCluster": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-22T16:05:17.314Z",
"CacheClusterId": "my-memcached",
"CacheClusterStatus": "deleting",
"CacheNodeType": "cache.r3.large",
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.memcached1.4",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
"ConfigurationEndpoint": {
"Address": "my-memcached2.ameaqx.cfg.use1.cache.amazonaws.com",
"Port": 11211
},
"Engine": "memcached",
"EngineVersion": "1.4.24",
"NumCacheNodes": 2,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "Multiple",
"PreferredMaintenanceWindow": "tue:07:30-tue:08:30"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes an Amazon ElastiCache cluster.",
"id": "deletecachecluster-1475010605291",
"title": "DeleteCacheCluster"
}
],
"DeleteCacheParameterGroup": [
{
"input": {
"CacheParameterGroupName": "custom-mem1-4"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the Amazon ElastiCache parameter group custom-mem1-4.",
"id": "deletecacheparametergroup-1475010933957",
"title": "DeleteCacheParameterGroup"
}
],
"DeleteCacheSecurityGroup": [
{
"input": {
"CacheSecurityGroupName": "my-sec-group"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes a cache security group.",
"id": "deletecachesecuritygroup-1483046967507",
"title": "DeleteCacheSecurityGroup"
}
],
"DeleteCacheSubnetGroup": [
{
"input": {
"CacheSubnetGroupName": "my-subnet-group"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the Amazon ElastiCache subnet group my-subnet-group.",
"id": "deletecachesubnetgroup-1475011431325",
"title": "DeleteCacheSubnetGroup"
}
],
"DeleteReplicationGroup": [
{
"input": {
"ReplicationGroupId": "my-redis-rg",
"RetainPrimaryCluster": false
},
"output": {
"ReplicationGroup": {
"AutomaticFailover": "disabled",
"Description": "simple redis cluster",
"PendingModifiedValues": {
},
"ReplicationGroupId": "my-redis-rg",
"Status": "deleting"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the Amazon ElastiCache replication group my-redis-rg.",
"id": "deletereplicationgroup-1475011641804",
"title": "DeleteReplicationGroup"
}
],
"DeleteSnapshot": [
{
"input": {
"SnapshotName": "snapshot-20161212"
},
"output": {
"Snapshot": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-21T22:27:12.543Z",
"CacheClusterId": "my-redis5",
"CacheNodeType": "cache.m3.large",
"CacheParameterGroupName": "default.redis3.2",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeSnapshots": [
{
"CacheNodeCreateTime": "2016-12-21T22:27:12.543Z",
"CacheNodeId": "0001",
"CacheSize": "3 MB",
"SnapshotCreateTime": "2016-12-21T22:30:26Z"
}
],
"NumCacheNodes": 1,
"Port": 6379,
"PreferredAvailabilityZone": "us-east-1c",
"PreferredMaintenanceWindow": "fri:05:30-fri:06:30",
"SnapshotName": "snapshot-20161212",
"SnapshotRetentionLimit": 7,
"SnapshotSource": "manual",
"SnapshotStatus": "deleting",
"SnapshotWindow": "10:00-11:00",
"VpcId": "vpc-91280df6"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Deletes the Redis snapshot snapshot-20160822.",
"id": "deletesnapshot-1475011945779",
"title": "DeleteSnapshot"
}
],
"DescribeCacheClusters": [
{
"input": {
"CacheClusterId": "my-mem-cluster"
},
"output": {
"CacheClusters": [
{
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-21T21:59:43.794Z",
"CacheClusterId": "my-mem-cluster",
"CacheClusterStatus": "available",
"CacheNodeType": "cache.t2.medium",
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.memcached1.4",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
"ConfigurationEndpoint": {
"Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com",
"Port": 11211
},
"Engine": "memcached",
"EngineVersion": "1.4.24",
"NumCacheNodes": 2,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "Multiple",
"PreferredMaintenanceWindow": "wed:06:00-wed:07:00"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists the details for up to 50 cache clusters.",
"id": "describecacheclusters-1475012269754",
"title": "DescribeCacheClusters"
},
{
"input": {
"CacheClusterId": "my-mem-cluster",
"ShowCacheNodeInfo": true
},
"output": {
"CacheClusters": [
{
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-21T21:59:43.794Z",
"CacheClusterId": "my-mem-cluster",
"CacheClusterStatus": "available",
"CacheNodeType": "cache.t2.medium",
"CacheNodes": [
{
"CacheNodeCreateTime": "2016-12-21T21:59:43.794Z",
"CacheNodeId": "0001",
"CacheNodeStatus": "available",
"CustomerAvailabilityZone": "us-east-1b",
"Endpoint": {
"Address": "my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com",
"Port": 11211
},
"ParameterGroupStatus": "in-sync"
},
{
"CacheNodeCreateTime": "2016-12-21T21:59:43.794Z",
"CacheNodeId": "0002",
"CacheNodeStatus": "available",
"CustomerAvailabilityZone": "us-east-1a",
"Endpoint": {
"Address": "my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com",
"Port": 11211
},
"ParameterGroupStatus": "in-sync"
}
],
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.memcached1.4",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
"ConfigurationEndpoint": {
"Address": "my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com",
"Port": 11211
},
"Engine": "memcached",
"EngineVersion": "1.4.24",
"NumCacheNodes": 2,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "Multiple",
"PreferredMaintenanceWindow": "wed:06:00-wed:07:00"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists the details for the cache cluster my-mem-cluster.",
"id": "describecacheclusters-1475012269754",
"title": "DescribeCacheClusters"
}
],
"DescribeCacheEngineVersions": [
{
"input": {
},
"output": {
"CacheEngineVersions": [
{
"CacheEngineDescription": "memcached",
"CacheEngineVersionDescription": "memcached version 1.4.14",
"CacheParameterGroupFamily": "memcached1.4",
"Engine": "memcached",
"EngineVersion": "1.4.14"
},
{
"CacheEngineDescription": "memcached",
"CacheEngineVersionDescription": "memcached version 1.4.24",
"CacheParameterGroupFamily": "memcached1.4",
"Engine": "memcached",
"EngineVersion": "1.4.24"
},
{
"CacheEngineDescription": "memcached",
"CacheEngineVersionDescription": "memcached version 1.4.33",
"CacheParameterGroupFamily": "memcached1.4",
"Engine": "memcached",
"EngineVersion": "1.4.33"
},
{
"CacheEngineDescription": "memcached",
"CacheEngineVersionDescription": "memcached version 1.4.5",
"CacheParameterGroupFamily": "memcached1.4",
"Engine": "memcached",
"EngineVersion": "1.4.5"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.6.13",
"CacheParameterGroupFamily": "redis2.6",
"Engine": "redis",
"EngineVersion": "2.6.13"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.19",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.19"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.21",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.21"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.22 R5",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.22"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.23 R4",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.23"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.24 R3",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.24"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.6",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.6"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 3.2.4",
"CacheParameterGroupFamily": "redis3.2",
"Engine": "redis",
"EngineVersion": "3.2.4"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists the details for up to 25 Memcached and Redis cache engine versions.",
"id": "describecacheengineversions-1475012638790",
"title": "DescribeCacheEngineVersions"
},
{
"input": {
"DefaultOnly": false,
"Engine": "redis",
"MaxRecords": 50
},
"output": {
"CacheEngineVersions": [
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.6.13",
"CacheParameterGroupFamily": "redis2.6",
"Engine": "redis",
"EngineVersion": "2.6.13"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.19",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.19"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.21",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.21"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.22 R5",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.22"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.23 R4",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.23"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.24 R3",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.24"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 2.8.6",
"CacheParameterGroupFamily": "redis2.8",
"Engine": "redis",
"EngineVersion": "2.8.6"
},
{
"CacheEngineDescription": "Redis",
"CacheEngineVersionDescription": "redis version 3.2.4",
"CacheParameterGroupFamily": "redis3.2",
"Engine": "redis",
"EngineVersion": "3.2.4"
}
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists the details for up to 50 Redis cache engine versions.",
"id": "describecacheengineversions-1475012638790",
"title": "DescribeCacheEngineVersions"
}
],
"DescribeCacheParameterGroups": [
{
"input": {
"CacheParameterGroupName": "custom-mem1-4"
},
"output": {
"CacheParameterGroups": [
{
"CacheParameterGroupFamily": "memcached1.4",
"CacheParameterGroupName": "custom-mem1-4",
"Description": "Custom memcache param group"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.",
"id": "describecacheparametergroups-1483045457557",
"title": "DescribeCacheParameterGroups"
}
],
"DescribeCacheParameters": [
{
"input": {
"CacheParameterGroupName": "custom-redis2-8",
"MaxRecords": 100,
"Source": "user"
},
"output": {
"Marker": "",
"Parameters": [
{
"AllowedValues": "yes,no",
"ChangeType": "requires-reboot",
"DataType": "string",
"Description": "Apply rehashing or not.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "activerehashing",
"ParameterValue": "yes",
"Source": "system"
},
{
"AllowedValues": "always,everysec,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "fsync policy for AOF persistence",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "appendfsync",
"ParameterValue": "everysec",
"Source": "system"
},
{
"AllowedValues": "yes,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "Enable Redis persistence.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "appendonly",
"ParameterValue": "no",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Normal client output buffer hard limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-normal-hard-limit",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Normal client output buffer soft limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-normal-soft-limit",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Normal client output buffer soft limit in seconds.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-normal-soft-seconds",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Pubsub client output buffer hard limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-pubsub-hard-limit",
"ParameterValue": "33554432",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Pubsub client output buffer soft limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-pubsub-soft-limit",
"ParameterValue": "8388608",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Pubsub client output buffer soft limit in seconds.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-pubsub-soft-seconds",
"ParameterValue": "60",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Slave client output buffer soft limit in seconds.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-slave-soft-seconds",
"ParameterValue": "60",
"Source": "system"
},
{
"AllowedValues": "yes,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.23",
"ParameterName": "close-on-slave-write",
"ParameterValue": "yes",
"Source": "system"
},
{
"AllowedValues": "1-1200000",
"ChangeType": "requires-reboot",
"DataType": "integer",
"Description": "Set the number of databases.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "databases",
"ParameterValue": "16",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The maximum number of hash entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "hash-max-ziplist-entries",
"ParameterValue": "512",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The threshold of biggest hash entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "hash-max-ziplist-value",
"ParameterValue": "64",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The maximum number of list entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "list-max-ziplist-entries",
"ParameterValue": "512",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The threshold of biggest list entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "list-max-ziplist-value",
"ParameterValue": "64",
"Source": "system"
},
{
"AllowedValues": "5000",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "lua-time-limit",
"ParameterValue": "5000",
"Source": "system"
},
{
"AllowedValues": "1-65000",
"ChangeType": "requires-reboot",
"DataType": "integer",
"Description": "The maximum number of Redis clients.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxclients",
"ParameterValue": "65000",
"Source": "system"
},
{
"AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction",
"ChangeType": "immediate",
"DataType": "string",
"Description": "Max memory policy.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxmemory-policy",
"ParameterValue": "volatile-lru",
"Source": "system"
},
{
"AllowedValues": "1-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Max memory samples.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxmemory-samples",
"ParameterValue": "3",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "min-slaves-max-lag",
"ParameterValue": "10",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "min-slaves-to-write",
"ParameterValue": "0",
"Source": "system"
},
{
"ChangeType": "immediate",
"DataType": "string",
"Description": "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "notify-keyspace-events",
"Source": "system"
},
{
"AllowedValues": "16384-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "repl-backlog-size",
"ParameterValue": "1048576",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "repl-backlog-ttl",
"ParameterValue": "3600",
"Source": "system"
},
{
"AllowedValues": "11-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The timeout in seconds for bulk transfer I/O during sync and master timeout from the perspective of the slave, and slave timeout from the perspective of the master.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "repl-timeout",
"ParameterValue": "60",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The amount of memory reserved for non-cache memory usage, in bytes. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "reserved-memory",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The limit in the size of the set in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "set-max-intset-entries",
"ParameterValue": "512",
"Source": "system"
},
{
"AllowedValues": "yes,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "Configures if chaining of slaves is allowed",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "slave-allow-chaining",
"ParameterValue": "no",
"Source": "system"
},
{
"AllowedValues": "-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "slowlog-log-slower-than",
"ParameterValue": "10000",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "slowlog-max-len",
"ParameterValue": "128",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "If non-zero, send ACKs every given number of seconds.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "tcp-keepalive",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0,20-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Close connection if client is idle for a given number of seconds, or never if 0.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "timeout",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The maximum number of sorted set entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "zset-max-ziplist-entries",
"ParameterValue": "128",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The threshold of biggest sorted set entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "zset-max-ziplist-value",
"ParameterValue": "64",
"Source": "system"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists up to 100 user parameter values for the parameter group custom.redis2.8.",
"id": "describecacheparameters-1475013576900",
"title": "DescribeCacheParameters"
}
],
"DescribeCacheSecurityGroups": [
{
"input": {
"CacheSecurityGroupName": "my-sec-group"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.",
"id": "describecachesecuritygroups-1483047200801",
"title": "DescribeCacheSecurityGroups"
}
],
"DescribeCacheSubnetGroups": [
{
"input": {
"MaxRecords": 25
},
"output": {
"CacheSubnetGroups": [
{
"CacheSubnetGroupDescription": "Default CacheSubnetGroup",
"CacheSubnetGroupName": "default",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetIdentifier": "subnet-1a2b3c4d"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-a1b2c3d4"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetIdentifier": "subnet-abcd1234"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetIdentifier": "subnet-1234abcd"
}
],
"VpcId": "vpc-91280df6"
}
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Describes up to 25 cache subnet groups.",
"id": "describecachesubnetgroups-1482439214064",
"title": "DescribeCacheSubnetGroups"
}
],
"DescribeEngineDefaultParameters": [
{
"input": {
"CacheParameterGroupFamily": "redis2.8",
"MaxRecords": 25
},
"output": {
"EngineDefaults": {
"CacheNodeTypeSpecificParameters": [
{
"AllowedValues": "0-",
"CacheNodeTypeSpecificValues": [
{
"CacheNodeType": "cache.c1.xlarge",
"Value": "650117120"
},
{
"CacheNodeType": "cache.m1.large",
"Value": "702545920"
},
{
"CacheNodeType": "cache.m1.medium",
"Value": "309329920"
},
{
"CacheNodeType": "cache.m1.small",
"Value": "94371840"
},
{
"CacheNodeType": "cache.m1.xlarge",
"Value": "1488977920"
},
{
"CacheNodeType": "cache.m2.2xlarge",
"Value": "3502243840"
},
{
"CacheNodeType": "cache.m2.4xlarge",
"Value": "7088373760"
},
{
"CacheNodeType": "cache.m2.xlarge",
"Value": "1709178880"
},
{
"CacheNodeType": "cache.m3.2xlarge",
"Value": "2998927360"
},
{
"CacheNodeType": "cache.m3.large",
"Value": "650117120"
},
{
"CacheNodeType": "cache.m3.medium",
"Value": "309329920"
},
{
"CacheNodeType": "cache.m3.xlarge",
"Value": "1426063360"
},
{
"CacheNodeType": "cache.m4.10xlarge",
"Value": "16604761424"
},
{
"CacheNodeType": "cache.m4.2xlarge",
"Value": "3188912636"
},
{
"CacheNodeType": "cache.m4.4xlarge",
"Value": "6525729063"
},
{
"CacheNodeType": "cache.m4.large",
"Value": "689259315"
},
{
"CacheNodeType": "cache.m4.xlarge",
"Value": "1532850176"
},
{
"CacheNodeType": "cache.r3.2xlarge",
"Value": "6081740800"
},
{
"CacheNodeType": "cache.r3.4xlarge",
"Value": "12268339200"
},
{
"CacheNodeType": "cache.r3.8xlarge",
"Value": "24536678400"
},
{
"CacheNodeType": "cache.r3.large",
"Value": "1468006400"
},
{
"CacheNodeType": "cache.r3.xlarge",
"Value": "3040870400"
},
{
"CacheNodeType": "cache.t1.micro",
"Value": "14260633"
},
{
"CacheNodeType": "cache.t2.medium",
"Value": "346134937"
},
{
"CacheNodeType": "cache.t2.micro",
"Value": "58195968"
},
{
"CacheNodeType": "cache.t2.small",
"Value": "166513868"
}
],
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Slave client output buffer hard limit in bytes.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-slave-hard-limit",
"Source": "system"
},
{
"AllowedValues": "0-",
"CacheNodeTypeSpecificValues": [
{
"CacheNodeType": "cache.c1.xlarge",
"Value": "650117120"
},
{
"CacheNodeType": "cache.m1.large",
"Value": "702545920"
},
{
"CacheNodeType": "cache.m1.medium",
"Value": "309329920"
},
{
"CacheNodeType": "cache.m1.small",
"Value": "94371840"
},
{
"CacheNodeType": "cache.m1.xlarge",
"Value": "1488977920"
},
{
"CacheNodeType": "cache.m2.2xlarge",
"Value": "3502243840"
},
{
"CacheNodeType": "cache.m2.4xlarge",
"Value": "7088373760"
},
{
"CacheNodeType": "cache.m2.xlarge",
"Value": "1709178880"
},
{
"CacheNodeType": "cache.m3.2xlarge",
"Value": "2998927360"
},
{
"CacheNodeType": "cache.m3.large",
"Value": "650117120"
},
{
"CacheNodeType": "cache.m3.medium",
"Value": "309329920"
},
{
"CacheNodeType": "cache.m3.xlarge",
"Value": "1426063360"
},
{
"CacheNodeType": "cache.m4.10xlarge",
"Value": "16604761424"
},
{
"CacheNodeType": "cache.m4.2xlarge",
"Value": "3188912636"
},
{
"CacheNodeType": "cache.m4.4xlarge",
"Value": "6525729063"
},
{
"CacheNodeType": "cache.m4.large",
"Value": "689259315"
},
{
"CacheNodeType": "cache.m4.xlarge",
"Value": "1532850176"
},
{
"CacheNodeType": "cache.r3.2xlarge",
"Value": "6081740800"
},
{
"CacheNodeType": "cache.r3.4xlarge",
"Value": "12268339200"
},
{
"CacheNodeType": "cache.r3.8xlarge",
"Value": "24536678400"
},
{
"CacheNodeType": "cache.r3.large",
"Value": "1468006400"
},
{
"CacheNodeType": "cache.r3.xlarge",
"Value": "3040870400"
},
{
"CacheNodeType": "cache.t1.micro",
"Value": "14260633"
},
{
"CacheNodeType": "cache.t2.medium",
"Value": "346134937"
},
{
"CacheNodeType": "cache.t2.micro",
"Value": "58195968"
},
{
"CacheNodeType": "cache.t2.small",
"Value": "166513868"
}
],
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Slave client output buffer soft limit in bytes.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-slave-soft-limit",
"Source": "system"
},
{
"AllowedValues": "0-",
"CacheNodeTypeSpecificValues": [
{
"CacheNodeType": "cache.c1.xlarge",
"Value": "6501171200"
},
{
"CacheNodeType": "cache.m1.large",
"Value": "7025459200"
},
{
"CacheNodeType": "cache.m1.medium",
"Value": "3093299200"
},
{
"CacheNodeType": "cache.m1.small",
"Value": "943718400"
},
{
"CacheNodeType": "cache.m1.xlarge",
"Value": "14889779200"
},
{
"CacheNodeType": "cache.m2.2xlarge",
"Value": "35022438400"
},
{
"CacheNodeType": "cache.m2.4xlarge",
"Value": "70883737600"
},
{
"CacheNodeType": "cache.m2.xlarge",
"Value": "17091788800"
},
{
"CacheNodeType": "cache.m3.2xlarge",
"Value": "29989273600"
},
{
"CacheNodeType": "cache.m3.large",
"Value": "6501171200"
},
{
"CacheNodeType": "cache.m3.medium",
"Value": "2988441600"
},
{
"CacheNodeType": "cache.m3.xlarge",
"Value": "14260633600"
},
{
"CacheNodeType": "cache.m4.10xlarge",
"Value": "166047614239"
},
{
"CacheNodeType": "cache.m4.2xlarge",
"Value": "31889126359"
},
{
"CacheNodeType": "cache.m4.4xlarge",
"Value": "65257290629"
},
{
"CacheNodeType": "cache.m4.large",
"Value": "6892593152"
},
{
"CacheNodeType": "cache.m4.xlarge",
"Value": "15328501760"
},
{
"CacheNodeType": "cache.r3.2xlarge",
"Value": "62495129600"
},
{
"CacheNodeType": "cache.r3.4xlarge",
"Value": "126458265600"
},
{
"CacheNodeType": "cache.r3.8xlarge",
"Value": "254384537600"
},
{
"CacheNodeType": "cache.r3.large",
"Value": "14470348800"
},
{
"CacheNodeType": "cache.r3.xlarge",
"Value": "30513561600"
},
{
"CacheNodeType": "cache.t1.micro",
"Value": "142606336"
},
{
"CacheNodeType": "cache.t2.medium",
"Value": "3461349376"
},
{
"CacheNodeType": "cache.t2.micro",
"Value": "581959680"
},
{
"CacheNodeType": "cache.t2.small",
"Value": "1665138688"
}
],
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The maximum configurable amount of memory to use to store items, in bytes.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxmemory",
"Source": "system"
}
],
"CacheParameterGroupFamily": "redis2.8",
"Marker": "bWluLXNsYXZlcy10by13cml0ZQ==",
"Parameters": [
{
"AllowedValues": "yes,no",
"ChangeType": "requires-reboot",
"DataType": "string",
"Description": "Apply rehashing or not.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "activerehashing",
"ParameterValue": "yes",
"Source": "system"
},
{
"AllowedValues": "always,everysec,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "fsync policy for AOF persistence",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "appendfsync",
"ParameterValue": "everysec",
"Source": "system"
},
{
"AllowedValues": "yes,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "Enable Redis persistence.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "appendonly",
"ParameterValue": "no",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Normal client output buffer hard limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-normal-hard-limit",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Normal client output buffer soft limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-normal-soft-limit",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Normal client output buffer soft limit in seconds.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-normal-soft-seconds",
"ParameterValue": "0",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Pubsub client output buffer hard limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-pubsub-hard-limit",
"ParameterValue": "33554432",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Pubsub client output buffer soft limit in bytes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-pubsub-soft-limit",
"ParameterValue": "8388608",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Pubsub client output buffer soft limit in seconds.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-pubsub-soft-seconds",
"ParameterValue": "60",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Slave client output buffer soft limit in seconds.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "client-output-buffer-limit-slave-soft-seconds",
"ParameterValue": "60",
"Source": "system"
},
{
"AllowedValues": "yes,no",
"ChangeType": "immediate",
"DataType": "string",
"Description": "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.23",
"ParameterName": "close-on-slave-write",
"ParameterValue": "yes",
"Source": "system"
},
{
"AllowedValues": "1-1200000",
"ChangeType": "requires-reboot",
"DataType": "integer",
"Description": "Set the number of databases.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "databases",
"ParameterValue": "16",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The maximum number of hash entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "hash-max-ziplist-entries",
"ParameterValue": "512",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The threshold of biggest hash entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "hash-max-ziplist-value",
"ParameterValue": "64",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The maximum number of list entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "list-max-ziplist-entries",
"ParameterValue": "512",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "The threshold of biggest list entries in order for the dataset to be compressed.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "list-max-ziplist-value",
"ParameterValue": "64",
"Source": "system"
},
{
"AllowedValues": "5000",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "lua-time-limit",
"ParameterValue": "5000",
"Source": "system"
},
{
"AllowedValues": "1-65000",
"ChangeType": "requires-reboot",
"DataType": "integer",
"Description": "The maximum number of Redis clients.",
"IsModifiable": false,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxclients",
"ParameterValue": "65000",
"Source": "system"
},
{
"AllowedValues": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction",
"ChangeType": "immediate",
"DataType": "string",
"Description": "Max memory policy.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxmemory-policy",
"ParameterValue": "volatile-lru",
"Source": "system"
},
{
"AllowedValues": "1-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Max memory samples.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "maxmemory-samples",
"ParameterValue": "3",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "min-slaves-max-lag",
"ParameterValue": "10",
"Source": "system"
},
{
"AllowedValues": "0-",
"ChangeType": "immediate",
"DataType": "integer",
"Description": "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.",
"IsModifiable": true,
"MinimumEngineVersion": "2.8.6",
"ParameterName": "min-slaves-to-write",
"ParameterValue": "0",
"Source": "system"
}
]
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns the default engine and system parameter information for the specified cache engine.",
"id": "describeenginedefaultparameters-1481738057686",
"title": "DescribeEngineDefaultParameters"
}
],
"DescribeEvents": [
{
"input": {
"Duration": 360,
"SourceType": "cache-cluster"
},
"output": {
"Events": [
{
"Date": "2016-12-22T16:27:56.088Z",
"Message": "Added cache node 0001 in availability zone us-east-1e",
"SourceIdentifier": "redis-cluster",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:27:56.078Z",
"Message": "Cache cluster created",
"SourceIdentifier": "redis-cluster",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:05:17.326Z",
"Message": "Added cache node 0002 in availability zone us-east-1c",
"SourceIdentifier": "my-memcached2",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:05:17.323Z",
"Message": "Added cache node 0001 in availability zone us-east-1e",
"SourceIdentifier": "my-memcached2",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:05:17.314Z",
"Message": "Cache cluster created",
"SourceIdentifier": "my-memcached2",
"SourceType": "cache-cluster"
}
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Describes all the cache-cluster events for the past 120 minutes.",
"id": "describeevents-1481843894757",
"title": "DescribeEvents"
},
{
"input": {
"StartTime": "2016-12-22T15:00:00.000Z"
},
"output": {
"Events": [
{
"Date": "2016-12-22T21:35:46.674Z",
"Message": "Snapshot succeeded for snapshot with ID 'cr-bkup' of replication group with ID 'clustered-redis'",
"SourceIdentifier": "clustered-redis-0001-001",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:27:56.088Z",
"Message": "Added cache node 0001 in availability zone us-east-1e",
"SourceIdentifier": "redis-cluster",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:27:56.078Z",
"Message": "Cache cluster created",
"SourceIdentifier": "redis-cluster",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:05:17.326Z",
"Message": "Added cache node 0002 in availability zone us-east-1c",
"SourceIdentifier": "my-memcached2",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:05:17.323Z",
"Message": "Added cache node 0001 in availability zone us-east-1e",
"SourceIdentifier": "my-memcached2",
"SourceType": "cache-cluster"
},
{
"Date": "2016-12-22T16:05:17.314Z",
"Message": "Cache cluster created",
"SourceIdentifier": "my-memcached2",
"SourceType": "cache-cluster"
}
],
"Marker": ""
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.",
"id": "describeevents-1481843894757",
"title": "DescribeEvents"
}
],
"DescribeReplicationGroups": [
{
"input": {
},
"output": {
"Marker": "",
"ReplicationGroups": [
{
"AutomaticFailover": "enabled",
"Description": "Test cluster",
"MemberClusters": [
"clustered-redis-0001-001",
"clustered-redis-0001-002",
"clustered-redis-0002-001",
"clustered-redis-0002-002"
],
"NodeGroups": [
{
"NodeGroupId": "0001",
"NodeGroupMembers": [
{
"CacheClusterId": "clustered-redis-0001-001",
"CacheNodeId": "0001",
"PreferredAvailabilityZone": "us-east-1e"
},
{
"CacheClusterId": "clustered-redis-0001-002",
"CacheNodeId": "0001",
"PreferredAvailabilityZone": "us-east-1c"
}
],
"Status": "available"
},
{
"NodeGroupId": "0002",
"NodeGroupMembers": [
{
"CacheClusterId": "clustered-redis-0002-001",
"CacheNodeId": "0001",
"PreferredAvailabilityZone": "us-east-1c"
},
{
"CacheClusterId": "clustered-redis-0002-002",
"CacheNodeId": "0001",
"PreferredAvailabilityZone": "us-east-1b"
}
],
"Status": "available"
}
],
"PendingModifiedValues": {
},
"ReplicationGroupId": "clustered-redis",
"Status": "available"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the replication group myreplgroup.",
"id": "describereplicationgroups-1481742639427",
"title": "DescribeReplicationGroups"
}
],
"DescribeReservedCacheNodes": [
{
"input": {
"MaxRecords": 25
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the account has no reserved cache nodes, the operation returns an empty list, as shown here.",
"id": "describereservedcachenodes-1481742348045",
"title": "DescribeReservedCacheNodes"
}
],
"DescribeReservedCacheNodesOfferings": [
{
"input": {
"MaxRecords": 20
},
"output": {
"Marker": "1ef01f5b-433f-94ff-a530-61a56bfc8e7a",
"ReservedCacheNodesOfferings": [
{
"CacheNodeType": "cache.m1.small",
"Duration": 94608000,
"FixedPrice": 157.0,
"OfferingType": "Medium Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "0167633d-37f6-4222-b872-b1f22eb79ba4",
"UsagePrice": 0.017
},
{
"CacheNodeType": "cache.m4.xlarge",
"Duration": 94608000,
"FixedPrice": 1248.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.077,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "02c04e13-baca-4e71-9ceb-620eed94827d",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.m2.4xlarge",
"Duration": 94608000,
"FixedPrice": 2381.0,
"OfferingType": "Medium Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "02e1755e-76e8-48e3-8d82-820a5726a458",
"UsagePrice": 0.276
},
{
"CacheNodeType": "cache.m1.small",
"Duration": 94608000,
"FixedPrice": 188.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.013,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "03315215-7b87-421a-a3dd-785021e4113f",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.m4.10xlarge",
"Duration": 31536000,
"FixedPrice": 6158.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
{
"RecurringChargeAmount": 1.125,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "05ffbb44-2ace-4476-a2a5-8ec99f866fb3",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.m1.small",
"Duration": 31536000,
"FixedPrice": 101.0,
"OfferingType": "Medium Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "065c71ae-4a4e-4f1e-bebf-37525f4c6cb2",
"UsagePrice": 0.023
},
{
"CacheNodeType": "cache.m1.medium",
"Duration": 94608000,
"FixedPrice": 314.0,
"OfferingType": "Medium Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "06774b12-7f5e-48c1-907a-f286c63f327d",
"UsagePrice": 0.034
},
{
"CacheNodeType": "cache.m2.xlarge",
"Duration": 31536000,
"FixedPrice": 163.0,
"OfferingType": "Light Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "0924ac6b-847f-4761-ba6b-4290b2adf719",
"UsagePrice": 0.137
},
{
"CacheNodeType": "cache.m2.xlarge",
"Duration": 94608000,
"FixedPrice": 719.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.049,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "09eeb126-69b6-4d3f-8f94-ca3510629f53",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.r3.2xlarge",
"Duration": 94608000,
"FixedPrice": 4132.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.182,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "0a516ad8-557f-4310-9dd0-2448c2ff4d62",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.c1.xlarge",
"Duration": 94608000,
"FixedPrice": 875.0,
"OfferingType": "Light Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "0b0c1cc5-2177-4150-95d7-c67ec34dcb19",
"UsagePrice": 0.363
},
{
"CacheNodeType": "cache.m4.10xlarge",
"Duration": 94608000,
"FixedPrice": 12483.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.76,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "0c2b139b-1cff-43d0-8fba-0c753f9b1950",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.c1.xlarge",
"Duration": 31536000,
"FixedPrice": 1620.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.207,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "0c52115b-38cb-47a2-8dbc-e02e40b6a13f",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.m2.4xlarge",
"Duration": 94608000,
"FixedPrice": 2381.0,
"OfferingType": "Medium Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "12fcb19c-5416-4e1d-934f-28f1e2cb8599",
"UsagePrice": 0.276
},
{
"CacheNodeType": "cache.m4.xlarge",
"Duration": 31536000,
"FixedPrice": 616.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.112,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "13af20ad-914d-4d8b-9763-fa2e565f3549",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.r3.8xlarge",
"Duration": 94608000,
"FixedPrice": 16528.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.729,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "14da3d3f-b526-4dbf-b09b-355578b2a576",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.m1.medium",
"Duration": 94608000,
"FixedPrice": 140.0,
"OfferingType": "Light Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "15d7018c-71fb-4717-8409-4bdcdca18da7",
"UsagePrice": 0.052
},
{
"CacheNodeType": "cache.m4.4xlarge",
"Duration": 94608000,
"FixedPrice": 4993.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.304,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "1ae7ec5f-a76e-49b6-822b-629b1768a13a",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.m3.2xlarge",
"Duration": 31536000,
"FixedPrice": 1772.0,
"OfferingType": "Heavy Utilization",
"ProductDescription": "redis",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.25,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedCacheNodesOfferingId": "1d31242b-3925-48d1-b882-ce03204e6013",
"UsagePrice": 0.0
},
{
"CacheNodeType": "cache.t1.micro",
"Duration": 31536000,
"FixedPrice": 54.0,
"OfferingType": "Medium Utilization",
"ProductDescription": "memcached",
"RecurringCharges": [
],
"ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a",
"UsagePrice": 0.008
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists available reserved cache node offerings.",
"id": "describereseredcachenodeofferings-1481742869998",
"title": "DescribeReseredCacheNodeOfferings"
},
{
"input": {
"CacheNodeType": "cache.r3.large",
"Duration": "3",
"MaxRecords": 25,
"OfferingType": "Light Utilization",
"ReservedCacheNodesOfferingId": ""
},
"output": {
"Marker": "",
"ReservedCacheNodesOfferings": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.",
"id": "describereseredcachenodeofferings-1481742869998",
"title": "DescribeReseredCacheNodeOfferings"
},
{
"input": {
"CacheNodeType": "",
"Duration": "",
"Marker": "",
"MaxRecords": 25,
"OfferingType": "",
"ProductDescription": "",
"ReservedCacheNodesOfferingId": "438012d3-4052-4cc7-b2e3-8d3372e0e706"
},
"output": {
"Marker": "",
"ReservedCacheNodesOfferings": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists available reserved cache node offerings.",
"id": "describereseredcachenodeofferings-1481742869998",
"title": "DescribeReseredCacheNodeOfferings"
}
],
"DescribeSnapshots": [
{
"input": {
"SnapshotName": "snapshot-20161212"
},
"output": {
"Marker": "",
"Snapshots": [
{
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-21T22:27:12.543Z",
"CacheClusterId": "my-redis5",
"CacheNodeType": "cache.m3.large",
"CacheParameterGroupName": "default.redis3.2",
"CacheSubnetGroupName": "default",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NodeSnapshots": [
{
"CacheNodeCreateTime": "2016-12-21T22:27:12.543Z",
"CacheNodeId": "0001",
"CacheSize": "3 MB",
"SnapshotCreateTime": "2016-12-21T22:30:26Z"
}
],
"NumCacheNodes": 1,
"Port": 6379,
"PreferredAvailabilityZone": "us-east-1c",
"PreferredMaintenanceWindow": "fri:05:30-fri:06:30",
"SnapshotName": "snapshot-20161212",
"SnapshotRetentionLimit": 7,
"SnapshotSource": "manual",
"SnapshotStatus": "available",
"SnapshotWindow": "10:00-11:00",
"VpcId": "vpc-91280df6"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns information about the snapshot mysnapshot. By default.",
"id": "describesnapshots-1481743399584",
"title": "DescribeSnapshots"
}
],
"ListAllowedNodeTypeModifications": [
{
"input": {
"ReplicationGroupId": "myreplgroup"
},
"output": {
"ScaleUpModifications": [
"cache.m4.10xlarge",
"cache.m4.2xlarge",
"cache.m4.4xlarge",
"cache.m4.xlarge",
"cache.r3.2xlarge",
"cache.r3.4xlarge",
"cache.r3.8xlarge",
"cache.r3.xlarge"
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.",
"id": "listallowednodetypemodifications-1481748494872",
"title": "ListAllowedNodeTypeModifications"
},
{
"input": {
"CacheClusterId": "mycluster"
},
"output": {
"ScaleUpModifications": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.",
"id": "listallowednodetypemodifications-1481748494872",
"title": "ListAllowedNodeTypeModifications"
}
],
"ListTagsForResource": [
{
"input": {
"ResourceName": "arn:aws:elasticache:us-west-2:<my-account-id>:cluster:mycluster"
},
"output": {
"TagList": [
{
"Key": "APIVersion",
"Value": "20150202"
},
{
"Key": "Service",
"Value": "ElastiCache"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.",
"id": "listtagsforresource-1481748784584",
"title": "ListTagsForResource"
}
],
"ModifyCacheCluster": [
{
"input": {
"ApplyImmediately": true,
"CacheClusterId": "redis-cluster",
"SnapshotRetentionLimit": 14
},
"output": {
"CacheCluster": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-22T16:27:56.078Z",
"CacheClusterId": "redis-cluster",
"CacheClusterStatus": "available",
"CacheNodeType": "cache.r3.large",
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.redis3.2",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
"Engine": "redis",
"EngineVersion": "3.2.4",
"NumCacheNodes": 1,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "us-east-1e",
"PreferredMaintenanceWindow": "fri:09:00-fri:10:00",
"SnapshotRetentionLimit": 14,
"SnapshotWindow": "07:00-08:00"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Copies a snapshot to a specified name.",
"id": "modifycachecluster-1482962725919",
"title": "ModifyCacheCluster"
}
],
"ModifyCacheParameterGroup": [
{
"input": {
"CacheParameterGroupName": "custom-mem1-4",
"ParameterNameValues": [
{
"ParameterName": "binding_protocol",
"ParameterValue": "ascii"
},
{
"ParameterName": "chunk_size",
"ParameterValue": "96"
}
]
},
"output": {
"CacheParameterGroupName": "custom-mem1-4"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.",
"id": "modifycacheparametergroup-1482966746787",
"title": "ModifyCacheParameterGroup"
}
],
"ModifyCacheSubnetGroup": [
{
"input": {
"CacheSubnetGroupName": "my-sn-grp",
"SubnetIds": [
"subnet-bcde2345"
]
},
"output": {
"CacheSubnetGroup": {
"CacheSubnetGroupDescription": "My subnet group.",
"CacheSubnetGroupName": "my-sn-grp",
"Subnets": [
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-a1b2c3d4"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetIdentifier": "subnet-1a2b3c4d"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetIdentifier": "subnet-bcde2345"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetIdentifier": "subnet-1234abcd"
},
{
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetIdentifier": "subnet-abcd1234"
}
],
"VpcId": "vpc-91280df6"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Modifies an existing ElastiCache subnet group.",
"id": "modifycachesubnetgroup-1483043446226",
"title": "ModifyCacheSubnetGroup"
}
],
"ModifyReplicationGroup": [
{
"input": {
"ApplyImmediately": true,
"ReplicationGroupDescription": "Modified replication group",
"ReplicationGroupId": "my-redis-rg",
"SnapshotRetentionLimit": 30,
"SnapshottingClusterId": "my-redis-rg-001"
},
"output": {
"ReplicationGroup": {
"AutomaticFailover": "enabled",
"Description": "Modified replication group",
"MemberClusters": [
"my-redis-rg-001",
"my-redis-rg-002",
"my-redis-rg-003"
],
"NodeGroups": [
{
"NodeGroupId": "0001",
"NodeGroupMembers": [
{
"CacheClusterId": "my-redis-rg-001",
"CacheNodeId": "0001",
"CurrentRole": "primary",
"PreferredAvailabilityZone": "us-east-1b",
"ReadEndpoint": {
"Address": "my-redis-rg-001.abcdef.0001.use1.cache.amazonaws.com",
"Port": 6379
}
},
{
"CacheClusterId": "my-redis-rg-002",
"CacheNodeId": "0001",
"CurrentRole": "replica",
"PreferredAvailabilityZone": "us-east-1a",
"ReadEndpoint": {
"Address": "my-redis-rg-002.abcdef.0001.use1.cache.amazonaws.com",
"Port": 6379
}
},
{
"CacheClusterId": "my-redis-rg-003",
"CacheNodeId": "0001",
"CurrentRole": "replica",
"PreferredAvailabilityZone": "us-east-1c",
"ReadEndpoint": {
"Address": "my-redis-rg-003.abcdef.0001.use1.cache.amazonaws.com",
"Port": 6379
}
}
],
"PrimaryEndpoint": {
"Address": "my-redis-rg.abcdef.ng.0001.use1.cache.amazonaws.com",
"Port": 6379
},
"Status": "available"
}
],
"PendingModifiedValues": {
},
"ReplicationGroupId": "my-redis-rg",
"SnapshottingClusterId": "my-redis-rg-002",
"Status": "available"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "modifyreplicationgroup-1483039689581",
"title": "ModifyReplicationGroup"
}
],
"PurchaseReservedCacheNodesOffering": [
{
"input": {
"ReservedCacheNodesOfferingId": "1ef01f5b-94ff-433f-a530-61a56bfc8e7a"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Allows you to purchase a reserved cache node offering.",
"id": "purchasereservedcachenodesofferings-1483040798484",
"title": "PurchaseReservedCacheNodesOfferings"
}
],
"RebootCacheCluster": [
{
"input": {
"CacheClusterId": "custom-mem1-4 ",
"CacheNodeIdsToReboot": [
"0001",
"0002"
]
},
"output": {
"CacheCluster": {
"AutoMinorVersionUpgrade": true,
"CacheClusterCreateTime": "2016-12-21T21:59:43.794Z",
"CacheClusterId": "my-mem-cluster",
"CacheClusterStatus": "rebooting cache cluster nodes",
"CacheNodeType": "cache.t2.medium",
"CacheParameterGroup": {
"CacheNodeIdsToReboot": [
],
"CacheParameterGroupName": "default.memcached1.4",
"ParameterApplyStatus": "in-sync"
},
"CacheSecurityGroups": [
],
"CacheSubnetGroupName": "default",
"ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:",
"ConfigurationEndpoint": {
"Address": "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com",
"Port": 11211
},
"Engine": "memcached",
"EngineVersion": "1.4.24",
"NumCacheNodes": 2,
"PendingModifiedValues": {
},
"PreferredAvailabilityZone": "Multiple",
"PreferredMaintenanceWindow": "wed:06:00-wed:07:00"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Reboots the specified nodes in the names cluster.",
"id": "rebootcachecluster-1482969019505",
"title": "RebootCacheCluster"
}
],
"RemoveTagsFromResource": [
{
"input": {
"ResourceName": "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster",
"TagKeys": [
"A",
"C",
"E"
]
},
"output": {
"TagList": [
{
"Key": "B",
"Value": "Banana"
},
{
"Key": "D",
"Value": "Dog"
},
{
"Key": "F",
"Value": "Fox"
},
{
"Key": "I",
"Value": ""
},
{
"Key": "K",
"Value": "Kite"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Removes tags identified by a list of tag keys from the list of tags on the specified resource.",
"id": "removetagsfromresource-1483037920947",
"title": "RemoveTagsFromResource"
}
],
"ResetCacheParameterGroup": [
{
"input": {
"CacheParameterGroupName": "custom-mem1-4",
"ResetAllParameters": true
},
"output": {
"CacheParameterGroupName": "custom-mem1-4"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Modifies the parameters of a cache parameter group to the engine or system default value.",
"id": "resetcacheparametergroup-1483038334014",
"title": "ResetCacheParameterGroup"
}
],
"RevokeCacheSecurityGroupIngress": [
{
"input": {
"CacheSecurityGroupName": "my-sec-grp",
"EC2SecurityGroupName": "my-ec2-sec-grp",
"EC2SecurityGroupOwnerId": "1234567890"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.",
"id": "describecachesecuritygroups-1483047200801",
"title": "DescribeCacheSecurityGroups"
}
]
}
}

View file

@ -85,7 +85,7 @@
"errors":[
{"shape":"TooManyApplicationsException"}
],
"documentation":"<p> Creates an application that has one configuration template named <code>default</code> and no application versions. </p>"
"documentation":"<p>Creates an application that has one configuration template named <code>default</code> and no application versions.</p>"
},
"CreateApplicationVersion":{
"name":"CreateApplicationVersion",
@ -105,7 +105,7 @@
{"shape":"S3LocationNotInServiceRegionException"},
{"shape":"CodeBuildNotInServiceRegionException"}
],
"documentation":"<p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:</p> <p>Specify a commit in an AWS CodeCommit repository with <code>SourceBuildInformation</code>.</p> <p>Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and <code>BuildConfiguration</code>.</p> <p>Specify a source bundle in S3 with <code>SourceBundle</code> </p> <p>Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample application.</p> <note> <p>Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.</p> </note>"
"documentation":"<p>Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:</p> <p>Specify a commit in an AWS CodeCommit repository with <code>SourceBuildInformation</code>.</p> <p>Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and <code>BuildConfiguration</code>.</p> <p>Specify a source bundle in S3 with <code>SourceBundle</code> </p> <p>Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample application.</p> <note> <p>After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.</p> </note>"
},
"CreateConfigurationTemplate":{
"name":"CreateConfigurationTemplate",
@ -123,7 +123,7 @@
{"shape":"TooManyBucketsException"},
{"shape":"TooManyConfigurationTemplatesException"}
],
"documentation":"<p>Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.</p> <p>Templates aren't associated with any environment. The <code>EnvironmentName</code> response element is always <code>null</code>.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>"
"documentation":"<p>Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.</p> <p>Templates aren't associated with any environment. The <code>EnvironmentName</code> response element is always <code>null</code>.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>"
},
"CreateEnvironment":{
"name":"CreateEnvironment",
@ -140,7 +140,7 @@
{"shape":"TooManyEnvironmentsException"},
{"shape":"InsufficientPrivilegesException"}
],
"documentation":"<p>Launches an environment for the specified application using the specified configuration.</p>"
"documentation":"<p>Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.</p>"
},
"CreatePlatformVersion":{
"name":"CreatePlatformVersion",
@ -440,7 +440,7 @@
{"shape":"InsufficientPrivilegesException"},
{"shape":"ElasticBeanstalkServiceException"}
],
"documentation":"<p>Describes the version of the platform.</p>"
"documentation":"<p>Describes a platform version. Provides full details. Compare to <a>ListPlatformVersions</a>, which provides summary information about a list of platform versions.</p> <p>For definitions of platform version and other platform-related terms, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html\">AWS Elastic Beanstalk Platforms Glossary</a>.</p>"
},
"ListAvailableSolutionStacks":{
"name":"ListAvailableSolutionStacks",
@ -454,6 +454,19 @@
},
"documentation":"<p>Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.</p>"
},
"ListPlatformBranches":{
"name":"ListPlatformBranches",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListPlatformBranchesRequest"},
"output":{
"shape":"ListPlatformBranchesResult",
"resultWrapper":"ListPlatformBranchesResult"
},
"documentation":"<p>Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.</p> <p>For definitions of platform branch and other platform-related terms, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html\">AWS Elastic Beanstalk Platforms Glossary</a>.</p>"
},
"ListPlatformVersions":{
"name":"ListPlatformVersions",
"http":{
@ -469,7 +482,7 @@
{"shape":"InsufficientPrivilegesException"},
{"shape":"ElasticBeanstalkServiceException"}
],
"documentation":"<p>Lists the available platforms.</p>"
"documentation":"<p>Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to <a>DescribePlatformVersion</a>, which provides full details about a single platform version.</p> <p>For definitions of platform version and other platform-related terms, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html\">AWS Elastic Beanstalk Platforms Glossary</a>.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -487,7 +500,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceTypeNotSupportedException"}
],
"documentation":"<p>Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html\">Tagging Resources in Your Elastic Beanstalk Environment</a>.</p>"
"documentation":"<p>Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html\">Tagging Application Resources</a>.</p>"
},
"RebuildEnvironment":{
"name":"RebuildEnvironment",
@ -647,7 +660,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceTypeNotSupportedException"}
],
"documentation":"<p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>TagsToRemove</code>.</p> <p>Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html\">Tagging Resources in Your Elastic Beanstalk Environment</a>.</p> <p>If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:</p> <dl> <dt>elasticbeanstalk:AddTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tags to add in the <code>TagsToAdd</code> parameter.</p> </dd> <dt>elasticbeanstalk:RemoveTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tag keys to remove in the <code>TagsToRemove</code> parameter.</p> </dd> </dl> <p>For details about creating a custom user policy, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies\">Creating a Custom User Policy</a>.</p>"
"documentation":"<p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>TagsToRemove</code>.</p> <p>Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html\">Tagging Application Resources</a>.</p> <p>If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:</p> <dl> <dt>elasticbeanstalk:AddTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tags to add in the <code>TagsToAdd</code> parameter.</p> </dd> <dt>elasticbeanstalk:RemoveTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tag keys to remove in the <code>TagsToRemove</code> parameter.</p> </dd> </dl> <p>For details about creating a custom user policy, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies\">Creating a Custom User Policy</a>.</p>"
},
"ValidateConfigurationSettings":{
"name":"ValidateConfigurationSettings",
@ -812,10 +825,10 @@
},
"VersionLifecycleConfig":{
"shape":"ApplicationVersionLifecycleConfig",
"documentation":"<p>The application version lifecycle configuration.</p>"
"documentation":"<p>Defines lifecycle settings for application versions.</p>"
}
},
"documentation":"<p>The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.</p>"
"documentation":"<p>The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.</p>"
},
"ApplicationResourceLifecycleDescriptionMessage":{
"type":"structure",
@ -996,6 +1009,8 @@
},
"BoxedBoolean":{"type":"boolean"},
"BoxedInt":{"type":"integer"},
"BranchName":{"type":"string"},
"BranchOrder":{"type":"integer"},
"BuildConfiguration":{
"type":"structure",
"required":[
@ -1221,11 +1236,11 @@
"members":{
"ResourceName":{
"shape":"ResourceName",
"documentation":"<p>A unique resource name for a time-based scaling configuration option.</p>"
"documentation":"<p>A unique resource name for the option setting. Use it for a timebased scaling configuration option.</p>"
},
"Namespace":{
"shape":"OptionNamespace",
"documentation":"<p>A unique namespace identifying the option's associated AWS resource.</p>"
"documentation":"<p>A unique namespace that identifies the option's associated AWS resource.</p>"
},
"OptionName":{
"shape":"ConfigurationOptionName",
@ -1236,7 +1251,7 @@
"documentation":"<p>The current value for the configuration option.</p>"
}
},
"documentation":"<p> A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html\">Option Values</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>. </p>"
"documentation":"<p>A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html\">Option Values</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>. </p>"
},
"ConfigurationOptionSettingsList":{
"type":"list",
@ -1260,7 +1275,7 @@
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
},
"Options":{
"shape":"ConfigurationOptionDescriptionsList",
@ -1278,7 +1293,7 @@
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
},
"ApplicationName":{
"shape":"ApplicationName",
@ -1354,15 +1369,15 @@
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of the application.</p> <p>Constraint: This name must be unique within your account. If the specified name already exists, the action returns an <code>InvalidParameterValue</code> error.</p>"
"documentation":"<p>The name of the application. Must be unique within your account.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>Describes the application.</p>"
"documentation":"<p>Your description of the application.</p>"
},
"ResourceLifecycleConfig":{
"shape":"ApplicationResourceLifecycleConfig",
"documentation":"<p>Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions.</p>"
"documentation":"<p>Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.</p>"
},
"Tags":{
"shape":"Tags",
@ -1388,7 +1403,7 @@
},
"Description":{
"shape":"Description",
"documentation":"<p>Describes this version.</p>"
"documentation":"<p>A description of this application version.</p>"
},
"SourceBuildInformation":{
"shape":"SourceBuildInformation",
@ -1426,35 +1441,35 @@
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>"
"documentation":"<p>The name of the Elastic Beanstalk application to associate with this configuration template.</p>"
},
"TemplateName":{
"shape":"ConfigurationTemplateName",
"documentation":"<p>The name of the configuration template.</p> <p>Constraint: This name must be unique per application.</p> <p>Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>"
"documentation":"<p>The name of the configuration template.</p> <p>Constraint: This name must be unique per application.</p>"
},
"SolutionStackName":{
"shape":"SolutionStackName",
"documentation":"<p>The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.</p> <p> Use <a>ListAvailableSolutionStacks</a> to obtain a list of available solution stacks. </p> <p> A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.</p>"
"documentation":"<p>The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, <code>64bit Amazon Linux 2013.09 running Tomcat 7 Java 7</code>. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html\">Supported Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p> <p>You must specify <code>SolutionStackName</code> if you don't specify <code>PlatformArn</code>, <code>EnvironmentId</code>, or <code>SourceConfiguration</code>.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html\"> <code>ListAvailableSolutionStacks</code> </a> API to obtain a list of available solution stacks.</p>"
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the custom platform.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the custom platform. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html\"> Custom Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p> <note> <p>If you specify <code>PlatformArn</code>, then don't specify <code>SolutionStackName</code>.</p> </note>"
},
"SourceConfiguration":{
"shape":"SourceConfiguration",
"documentation":"<p>If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.</p> <p> Values specified in the <code>OptionSettings</code> parameter of this call overrides any values obtained from the <code>SourceConfiguration</code>. </p> <p> If no configuration template is found, returns an <code>InvalidParameterValue</code> error. </p> <p> Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p>"
"documentation":"<p>An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.</p> <p>Values specified in <code>OptionSettings</code> override any values obtained from the <code>SourceConfiguration</code>.</p> <p>You must specify <code>SourceConfiguration</code> if you don't specify <code>PlatformArn</code>, <code>EnvironmentId</code>, or <code>SolutionStackName</code>.</p> <p>Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.</p>"
},
"EnvironmentId":{
"shape":"EnvironmentId",
"documentation":"<p>The ID of the environment used with this configuration template.</p>"
"documentation":"<p>The ID of an environment whose settings you want to use to create the configuration template. You must specify <code>EnvironmentId</code> if you don't specify <code>PlatformArn</code>, <code>SolutionStackName</code>, or <code>SourceConfiguration</code>.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>Describes this configuration.</p>"
"documentation":"<p>An optional description for this configuration.</p>"
},
"OptionSettings":{
"shape":"ConfigurationOptionSettingsList",
"documentation":"<p>If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.</p>"
"documentation":"<p>Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html\">Option Values</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p>"
},
"Tags":{
"shape":"Tags",
@ -1469,11 +1484,11 @@
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of the application that contains the version to be deployed.</p> <p> If no application is found with this name, <code>CreateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </p>"
"documentation":"<p>The name of the application that is associated with this environment.</p>"
},
"EnvironmentName":{
"shape":"EnvironmentName",
"documentation":"<p>A unique name for the deployment environment. Used in the application URL.</p> <p>Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.</p>"
"documentation":"<p>A unique name for the environment.</p> <p>Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>If you don't specify the <code>CNAMEPrefix</code> parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.</p>"
},
"GroupName":{
"shape":"GroupName",
@ -1481,15 +1496,15 @@
},
"Description":{
"shape":"Description",
"documentation":"<p>Describes this environment.</p>"
"documentation":"<p>Your description for this environment.</p>"
},
"CNAMEPrefix":{
"shape":"DNSCnamePrefix",
"documentation":"<p>If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.</p>"
"documentation":"<p>If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.</p>"
},
"Tier":{
"shape":"EnvironmentTier",
"documentation":"<p>This specifies the tier to use for creating this environment.</p>"
"documentation":"<p>Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.</p>"
},
"Tags":{
"shape":"Tags",
@ -1497,19 +1512,19 @@
},
"VersionLabel":{
"shape":"VersionLabel",
"documentation":"<p>The name of the application version to deploy.</p> <p> If the specified application has no associated application versions, AWS Elastic Beanstalk <code>UpdateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </p> <p>Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.</p>"
"documentation":"<p>The name of the application version to deploy.</p> <p>Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.</p>"
},
"TemplateName":{
"shape":"ConfigurationTemplateName",
"documentation":"<p> The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>"
"documentation":"<p>The name of the Elastic Beanstalk configuration template to use with the environment.</p> <note> <p>If you specify <code>TemplateName</code>, then don't specify <code>SolutionStackName</code>.</p> </note>"
},
"SolutionStackName":{
"shape":"SolutionStackName",
"documentation":"<p>This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.</p> <p>For a list of current solution stacks, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html\">Elastic Beanstalk Supported Platforms</a>.</p>"
"documentation":"<p>The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html\">Elastic Beanstalk Supported Platforms</a> in the <i>AWS Elastic Beanstalk Platforms</i> guide.</p> <note> <p>If you specify <code>SolutionStackName</code>, don't specify <code>PlatformArn</code> or <code>TemplateName</code>.</p> </note>"
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see <a href=\"https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html\"> Custom Platforms</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>.</p> <note> <p>If you specify <code>PlatformArn</code>, don't specify <code>SolutionStackName</code>.</p> </note>"
},
"OptionSettings":{
"shape":"ConfigurationOptionSettingsList",
@ -2011,7 +2026,7 @@
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the version of the custom platform.</p>"
"documentation":"<p>The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.</p>"
},
"RequestId":{
"shape":"RequestId",
@ -2085,7 +2100,7 @@
"members":{
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the version of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
}
}
},
@ -2094,7 +2109,7 @@
"members":{
"PlatformDescription":{
"shape":"PlatformDescription",
"documentation":"<p>Detailed information about the version of the platform.</p>"
"documentation":"<p>Detailed information about the platform version.</p>"
}
}
},
@ -2141,7 +2156,7 @@
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
},
"TemplateName":{
"shape":"ConfigurationTemplateName",
@ -2441,7 +2456,7 @@
},
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
},
"RequestId":{
"shape":"RequestId",
@ -2698,20 +2713,50 @@
},
"documentation":"<p>A list of available AWS Elastic Beanstalk solution stacks.</p>"
},
"ListPlatformBranchesRequest":{
"type":"structure",
"members":{
"Filters":{
"shape":"SearchFilters",
"documentation":"<p>Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate <code>SearchFilter</code> terms.</p> <p>The following list shows valid attribute values for each of the <code>SearchFilter</code> terms. Most operators take a single value. The <code>in</code> and <code>not_in</code> operators can take multiple values.</p> <ul> <li> <p> <code>Attribute = BranchName</code>:</p> <ul> <li> <p> <code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code> </p> </li> </ul> </li> <li> <p> <code>Attribute = LifecycleState</code>:</p> <ul> <li> <p> <code>Operator</code>: <code>=</code> | <code>!=</code> | <code>in</code> | <code>not_in</code> </p> </li> <li> <p> <code>Values</code>: <code>beta</code> | <code>supported</code> | <code>deprecated</code> | <code>retired</code> </p> </li> </ul> </li> <li> <p> <code>Attribute = PlatformName</code>:</p> <ul> <li> <p> <code>Operator</code>: <code>=</code> | <code>!=</code> | <code>begins_with</code> | <code>ends_with</code> | <code>contains</code> | <code>in</code> | <code>not_in</code> </p> </li> </ul> </li> <li> <p> <code>Attribute = TierType</code>:</p> <ul> <li> <p> <code>Operator</code>: <code>=</code> | <code>!=</code> </p> </li> <li> <p> <code>Values</code>: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code> </p> </li> </ul> </li> </ul> <p>Array size: limited to 10 <code>SearchFilter</code> objects.</p> <p>Within each <code>SearchFilter</code> item, the <code>Values</code> array is limited to 10 items.</p>"
},
"MaxRecords":{
"shape":"PlatformBranchMaxRecords",
"documentation":"<p>The maximum number of platform branch values returned in one call.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p> <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>"
}
}
},
"ListPlatformBranchesResult":{
"type":"structure",
"members":{
"PlatformBranchSummaryList":{
"shape":"PlatformBranchSummaryList",
"documentation":"<p>Summary information about the platform branches.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>In a paginated request, if this value isn't <code>null</code>, it's the token that you can pass in a subsequent request to get the next response page.</p>"
}
}
},
"ListPlatformVersionsRequest":{
"type":"structure",
"members":{
"Filters":{
"shape":"PlatformFilters",
"documentation":"<p>List only the platforms where the platform member value relates to one of the supplied values.</p>"
"documentation":"<p>Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate <code>PlatformFilter</code> terms.</p>"
},
"MaxRecords":{
"shape":"PlatformMaxRecords",
"documentation":"<p>The maximum number of platform values returned in one call.</p>"
"documentation":"<p>The maximum number of platform version values returned in one call.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>The starting index into the remaining list of platforms. Use the <code>NextToken</code> value from a previous <code>ListPlatformVersion</code> call.</p>"
"documentation":"<p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p> <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>"
}
}
},
@ -2720,11 +2765,11 @@
"members":{
"PlatformSummaryList":{
"shape":"PlatformSummaryList",
"documentation":"<p>Detailed information about the platforms.</p>"
"documentation":"<p>Summary information about the platform versions.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>The starting index into the remaining list of platforms. if this value is not <code>null</code>, you can use it in a subsequent <code>ListPlatformVersion</code> call. </p>"
"documentation":"<p>In a paginated request, if this value isn't <code>null</code>, it's the token that you can pass in a subsequent request to get the next response page.</p>"
}
}
},
@ -2734,7 +2779,7 @@
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.</p> <p>Must be the ARN of an Elastic Beanstalk environment.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.</p> <p>Must be the ARN of an Elastic Beanstalk resource.</p>"
}
}
},
@ -2993,102 +3038,149 @@
"member":{"shape":"OptionSpecification"}
},
"PlatformArn":{"type":"string"},
"PlatformBranchLifecycleState":{"type":"string"},
"PlatformBranchMaxRecords":{
"type":"integer",
"min":1
},
"PlatformBranchSummary":{
"type":"structure",
"members":{
"PlatformName":{
"shape":"PlatformName",
"documentation":"<p>The name of the platform to which this platform branch belongs.</p>"
},
"BranchName":{
"shape":"BranchName",
"documentation":"<p>The name of the platform branch.</p>"
},
"LifecycleState":{
"shape":"PlatformBranchLifecycleState",
"documentation":"<p>The support life cycle state of the platform branch.</p> <p>Possible values: <code>beta</code> | <code>supported</code> | <code>deprecated</code> | <code>retired</code> </p>"
},
"BranchOrder":{
"shape":"BranchOrder",
"documentation":"<p>An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the <code>ListPlatformBranches</code> action and then displays a list of platform branches.</p> <p>A larger <code>BranchOrder</code> value designates a newer platform branch within the platform.</p>"
},
"SupportedTierList":{
"shape":"SupportedTierList",
"documentation":"<p>The environment tiers that platform versions in this branch support.</p> <p>Possible values: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code> </p>"
}
},
"documentation":"<p>Summary information about a platform branch.</p>"
},
"PlatformBranchSummaryList":{
"type":"list",
"member":{"shape":"PlatformBranchSummary"}
},
"PlatformCategory":{"type":"string"},
"PlatformDescription":{
"type":"structure",
"members":{
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
},
"PlatformOwner":{
"shape":"PlatformOwner",
"documentation":"<p>The AWS account ID of the person who created the platform.</p>"
"documentation":"<p>The AWS account ID of the person who created the platform version.</p>"
},
"PlatformName":{
"shape":"PlatformName",
"documentation":"<p>The name of the platform.</p>"
"documentation":"<p>The name of the platform version.</p>"
},
"PlatformVersion":{
"shape":"PlatformVersion",
"documentation":"<p>The version of the platform.</p>"
"documentation":"<p>The version of the platform version.</p>"
},
"SolutionStackName":{
"shape":"SolutionStackName",
"documentation":"<p>The name of the solution stack used by the platform.</p>"
"documentation":"<p>The name of the solution stack used by the platform version.</p>"
},
"PlatformStatus":{
"shape":"PlatformStatus",
"documentation":"<p>The status of the platform.</p>"
"documentation":"<p>The status of the platform version.</p>"
},
"DateCreated":{
"shape":"CreationDate",
"documentation":"<p>The date when the platform was created.</p>"
"documentation":"<p>The date when the platform version was created.</p>"
},
"DateUpdated":{
"shape":"UpdateDate",
"documentation":"<p>The date when the platform was last updated.</p>"
"documentation":"<p>The date when the platform version was last updated.</p>"
},
"PlatformCategory":{
"shape":"PlatformCategory",
"documentation":"<p>The category of the platform.</p>"
"documentation":"<p>The category of the platform version.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description of the platform.</p>"
"documentation":"<p>The description of the platform version.</p>"
},
"Maintainer":{
"shape":"Maintainer",
"documentation":"<p>Information about the maintainer of the platform.</p>"
"documentation":"<p>Information about the maintainer of the platform version.</p>"
},
"OperatingSystemName":{
"shape":"OperatingSystemName",
"documentation":"<p>The operating system used by the platform.</p>"
"documentation":"<p>The operating system used by the platform version.</p>"
},
"OperatingSystemVersion":{
"shape":"OperatingSystemVersion",
"documentation":"<p>The version of the operating system used by the platform.</p>"
"documentation":"<p>The version of the operating system used by the platform version.</p>"
},
"ProgrammingLanguages":{
"shape":"PlatformProgrammingLanguages",
"documentation":"<p>The programming languages supported by the platform.</p>"
"documentation":"<p>The programming languages supported by the platform version.</p>"
},
"Frameworks":{
"shape":"PlatformFrameworks",
"documentation":"<p>The frameworks supported by the platform.</p>"
"documentation":"<p>The frameworks supported by the platform version.</p>"
},
"CustomAmiList":{
"shape":"CustomAmiList",
"documentation":"<p>The custom AMIs supported by the platform.</p>"
"documentation":"<p>The custom AMIs supported by the platform version.</p>"
},
"SupportedTierList":{
"shape":"SupportedTierList",
"documentation":"<p>The tiers supported by the platform.</p>"
"documentation":"<p>The tiers supported by the platform version.</p>"
},
"SupportedAddonList":{
"shape":"SupportedAddonList",
"documentation":"<p>The additions supported by the platform.</p>"
"documentation":"<p>The additions supported by the platform version.</p>"
},
"PlatformLifecycleState":{
"shape":"PlatformLifecycleState",
"documentation":"<p>The state of the platform version in its lifecycle.</p> <p>Possible values: <code>Recommended</code> | <code>null</code> </p> <p>If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.</p>"
},
"PlatformBranchName":{
"shape":"BranchName",
"documentation":"<p>The platform branch to which the platform version belongs.</p>"
},
"PlatformBranchLifecycleState":{
"shape":"PlatformBranchLifecycleState",
"documentation":"<p>The state of the platform version's branch in its lifecycle.</p> <p>Possible values: <code>Beta</code> | <code>Supported</code> | <code>Deprecated</code> | <code>Retired</code> </p>"
}
},
"documentation":"<p>Detailed information about a platform.</p>"
"documentation":"<p>Detailed information about a platform version.</p>"
},
"PlatformFilter":{
"type":"structure",
"members":{
"Type":{
"shape":"PlatformFilterType",
"documentation":"<p>The custom platform attribute to which the filter values are applied.</p> <p>Valid Values: <code>PlatformName</code> | <code>PlatformVersion</code> | <code>PlatformStatus</code> | <code>PlatformOwner</code> </p>"
"documentation":"<p>The platform version attribute to which the filter values are applied.</p> <p>Valid values: <code>PlatformName</code> | <code>PlatformVersion</code> | <code>PlatformStatus</code> | <code>PlatformBranchName</code> | <code>PlatformLifecycleState</code> | <code>PlatformOwner</code> | <code>SupportedTier</code> | <code>SupportedAddon</code> | <code>ProgrammingLanguageName</code> | <code>OperatingSystemName</code> </p>"
},
"Operator":{
"shape":"PlatformFilterOperator",
"documentation":"<p>The operator to apply to the <code>Type</code> with each of the <code>Values</code>.</p> <p> Valid Values: <code>=</code> (equal to) | <code>!=</code> (not equal to) | <code>&lt;</code> (less than) | <code>&lt;=</code> (less than or equal to) | <code>&gt;</code> (greater than) | <code>&gt;=</code> (greater than or equal to) | <code>contains</code> | <code>begins_with</code> | <code>ends_with</code> </p>"
"documentation":"<p>The operator to apply to the <code>Type</code> with each of the <code>Values</code>.</p> <p>Valid values: <code>=</code> | <code>!=</code> | <code>&lt;</code> | <code>&lt;=</code> | <code>&gt;</code> | <code>&gt;=</code> | <code>contains</code> | <code>begins_with</code> | <code>ends_with</code> </p>"
},
"Values":{
"shape":"PlatformFilterValueList",
"documentation":"<p>The list of values applied to the custom platform attribute.</p>"
"documentation":"<p>The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.</p> <p>The following list shows valid filter values for some filter attributes.</p> <ul> <li> <p> <code>PlatformStatus</code>: <code>Creating</code> | <code>Failed</code> | <code>Ready</code> | <code>Deleting</code> | <code>Deleted</code> </p> </li> <li> <p> <code>PlatformLifecycleState</code>: <code>recommended</code> </p> </li> <li> <p> <code>SupportedTier</code>: <code>WebServer/Standard</code> | <code>Worker/SQS/HTTP</code> </p> </li> <li> <p> <code>SupportedAddon</code>: <code>Log/S3</code> | <code>Monitoring/Healthd</code> | <code>WorkerDaemon/SQSD</code> </p> </li> </ul>"
}
},
"documentation":"<p>Specify criteria to restrict the results when listing custom platforms.</p> <p>The filter is evaluated as the expression:</p> <p> <code>Type</code> <code>Operator</code> <code>Values[i]</code> </p>"
"documentation":"<p>Describes criteria to restrict the results when listing platform versions.</p> <p>The filter is evaluated as follows: <code>Type Operator Values[1]</code> </p>"
},
"PlatformFilterOperator":{"type":"string"},
"PlatformFilterType":{"type":"string"},
@ -3113,12 +3205,13 @@
"documentation":"<p>The version of the framework.</p>"
}
},
"documentation":"<p>A framework supported by the custom platform.</p>"
"documentation":"<p>A framework supported by the platform.</p>"
},
"PlatformFrameworks":{
"type":"list",
"member":{"shape":"PlatformFramework"}
},
"PlatformLifecycleState":{"type":"string"},
"PlatformMaxRecords":{
"type":"integer",
"min":1
@ -3158,38 +3251,54 @@
"members":{
"PlatformArn":{
"shape":"PlatformArn",
"documentation":"<p>The ARN of the platform.</p>"
"documentation":"<p>The ARN of the platform version.</p>"
},
"PlatformOwner":{
"shape":"PlatformOwner",
"documentation":"<p>The AWS account ID of the person who created the platform.</p>"
"documentation":"<p>The AWS account ID of the person who created the platform version.</p>"
},
"PlatformStatus":{
"shape":"PlatformStatus",
"documentation":"<p>The status of the platform. You can create an environment from the platform once it is ready.</p>"
"documentation":"<p>The status of the platform version. You can create an environment from the platform version once it is ready.</p>"
},
"PlatformCategory":{
"shape":"PlatformCategory",
"documentation":"<p>The category of platform.</p>"
"documentation":"<p>The category of platform version.</p>"
},
"OperatingSystemName":{
"shape":"OperatingSystemName",
"documentation":"<p>The operating system used by the platform.</p>"
"documentation":"<p>The operating system used by the platform version.</p>"
},
"OperatingSystemVersion":{
"shape":"OperatingSystemVersion",
"documentation":"<p>The version of the operating system used by the platform.</p>"
"documentation":"<p>The version of the operating system used by the platform version.</p>"
},
"SupportedTierList":{
"shape":"SupportedTierList",
"documentation":"<p>The tiers in which the platform runs.</p>"
"documentation":"<p>The tiers in which the platform version runs.</p>"
},
"SupportedAddonList":{
"shape":"SupportedAddonList",
"documentation":"<p>The additions associated with the platform.</p>"
"documentation":"<p>The additions associated with the platform version.</p>"
},
"PlatformLifecycleState":{
"shape":"PlatformLifecycleState",
"documentation":"<p>The state of the platform version in its lifecycle.</p> <p>Possible values: <code>recommended</code> | empty</p> <p>If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.</p>"
},
"PlatformVersion":{
"shape":"PlatformVersion",
"documentation":"<p>The version string of the platform version.</p>"
},
"PlatformBranchName":{
"shape":"BranchName",
"documentation":"<p>The platform branch to which the platform version belongs.</p>"
},
"PlatformBranchLifecycleState":{
"shape":"PlatformBranchLifecycleState",
"documentation":"<p>The state of the platform version's branch in its lifecycle.</p> <p>Possible values: <code>beta</code> | <code>supported</code> | <code>deprecated</code> | <code>retired</code> </p>"
}
},
"documentation":"<p>Detailed information about a platform.</p>"
"documentation":"<p>Summary information about a platform version.</p>"
},
"PlatformSummaryList":{
"type":"list",
@ -3324,7 +3433,7 @@
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resouce for which a tag list was requested.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource for which a tag list was requested.</p>"
},
"ResourceTags":{
"shape":"TagList",
@ -3434,6 +3543,35 @@
"exception":true
},
"SampleTimestamp":{"type":"timestamp"},
"SearchFilter":{
"type":"structure",
"members":{
"Attribute":{
"shape":"SearchFilterAttribute",
"documentation":"<p>The result attribute to which the filter values are applied. Valid values vary by API action.</p>"
},
"Operator":{
"shape":"SearchFilterOperator",
"documentation":"<p>The operator to apply to the <code>Attribute</code> with each of the <code>Values</code>. Valid values vary by <code>Attribute</code>.</p>"
},
"Values":{
"shape":"SearchFilterValues",
"documentation":"<p>The list of values applied to the <code>Attribute</code> and <code>Operator</code> attributes. Number of values and valid values vary by <code>Attribute</code>.</p>"
}
},
"documentation":"<p>Describes criteria to restrict a list of results.</p> <p>For operators that apply a single value to the attribute, the filter is evaluated as follows: <code>Attribute Operator Values[1]</code> </p> <p>Some operators, e.g. <code>in</code>, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: <code>(Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...</code> </p> <p>The valid values for attributes of <code>SearchFilter</code> depend on the API action. For valid values, see the reference page for the API action you're calling that takes a <code>SearchFilter</code> parameter.</p>"
},
"SearchFilterAttribute":{"type":"string"},
"SearchFilterOperator":{"type":"string"},
"SearchFilterValue":{"type":"string"},
"SearchFilterValues":{
"type":"list",
"member":{"shape":"SearchFilterValue"}
},
"SearchFilters":{
"type":"list",
"member":{"shape":"SearchFilter"}
},
"SingleInstanceHealth":{
"type":"structure",
"members":{
@ -3546,7 +3684,7 @@
"documentation":"<p>The name of the configuration template.</p>"
}
},
"documentation":"<p>A specification for an environment configuration</p>"
"documentation":"<p>A specification for an environment configuration.</p>"
},
"SourceLocation":{
"type":"string",
@ -3939,7 +4077,7 @@
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resouce to be updated.</p> <p>Must be the ARN of an Elastic Beanstalk environment.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resouce to be updated.</p> <p>Must be the ARN of an Elastic Beanstalk resource.</p>"
},
"TagsToAdd":{
"shape":"TagList",

View file

@ -179,6 +179,16 @@
],
"documentation":"<p>Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html\">Configure Block Public Access for Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p>"
},
"GetManagedScalingPolicy":{
"name":"GetManagedScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetManagedScalingPolicyInput"},
"output":{"shape":"GetManagedScalingPolicyOutput"},
"documentation":"<p> Fetches the attached managed scaling policy for an Amazon EMR cluster. </p>"
},
"ListBootstrapActions":{
"name":"ListBootstrapActions",
"http":{
@ -340,6 +350,16 @@
],
"documentation":"<p>Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html\">Configure Block Public Access for Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p>"
},
"PutManagedScalingPolicy":{
"name":"PutManagedScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutManagedScalingPolicyInput"},
"output":{"shape":"PutManagedScalingPolicyOutput"},
"documentation":"<p> Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
},
"RemoveAutoScalingPolicy":{
"name":"RemoveAutoScalingPolicy",
"http":{
@ -350,6 +370,16 @@
"output":{"shape":"RemoveAutoScalingPolicyOutput"},
"documentation":"<p>Removes an automatic scaling policy from a specified instance group within an EMR cluster.</p>"
},
"RemoveManagedScalingPolicy":{
"name":"RemoveManagedScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveManagedScalingPolicyInput"},
"output":{"shape":"RemoveManagedScalingPolicyOutput"},
"documentation":"<p> Removes a managed scaling policy from a specified EMR cluster. </p>"
},
"RemoveTags":{
"name":"RemoveTags",
"http":{
@ -955,13 +985,13 @@
"shape":"ArnType",
"documentation":"<p>The Amazon Resource Name of the cluster.</p>"
},
"StepConcurrencyLevel":{
"shape":"Integer",
"documentation":"<p>Specifies the number of steps that can be executed concurrently.</p>"
},
"OutpostArn":{
"shape":"OptionalArnType",
"documentation":"<p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>"
},
"StepConcurrencyLevel":{
"shape":"Integer",
"documentation":"<p>Specifies the number of steps that can be executed concurrently.</p>"
}
},
"documentation":"<p>The detailed description of the cluster.</p>"
@ -1111,6 +1141,41 @@
"LESS_THAN_OR_EQUAL"
]
},
"ComputeLimits":{
"type":"structure",
"required":[
"UnitType",
"MinimumCapacityUnits",
"MaximumCapacityUnits"
],
"members":{
"UnitType":{
"shape":"ComputeLimitsUnitType",
"documentation":"<p> The unit type used for specifying a managed scaling policy. </p>"
},
"MinimumCapacityUnits":{
"shape":"Integer",
"documentation":"<p> The lower boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
},
"MaximumCapacityUnits":{
"shape":"Integer",
"documentation":"<p> The upper boundary of EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. Managed scaling activities are not allowed beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
},
"MaximumOnDemandCapacityUnits":{
"shape":"Integer",
"documentation":"<p> The upper boundary of on-demand EC2 units. It is measured through VCPU cores or instances for instance groups and measured through units for instance fleets. The on-demand units are not allowed to scale beyond this boundary. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
}
},
"documentation":"<p> The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not be above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
},
"ComputeLimitsUnitType":{
"type":"string",
"enum":[
"InstanceFleetUnits",
"Instances",
"VCPU"
]
},
"Configuration":{
"type":"structure",
"members":{
@ -1456,7 +1521,7 @@
"members":{
"BlockPublicAccessConfiguration":{
"shape":"BlockPublicAccessConfiguration",
"documentation":"<p>A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code> in the <code>BlockPublicAccessConfiguration</code>. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.</p>"
"documentation":"<p>A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code> in the <code>BlockPublicAccessConfiguration</code>. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.</p> <note> <p>For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.</p> </note>"
},
"BlockPublicAccessConfigurationMetadata":{
"shape":"BlockPublicAccessConfigurationMetadata",
@ -1464,6 +1529,25 @@
}
}
},
"GetManagedScalingPolicyInput":{
"type":"structure",
"required":["ClusterId"],
"members":{
"ClusterId":{
"shape":"ClusterId",
"documentation":"<p> Specifies the ID of the cluster for which the managed scaling policy will be fetched. </p>"
}
}
},
"GetManagedScalingPolicyOutput":{
"type":"structure",
"members":{
"ManagedScalingPolicy":{
"shape":"ManagedScalingPolicy",
"documentation":"<p> Specifies the managed scaling policy that is attached to an Amazon EMR cluster. </p>"
}
}
},
"HadoopJarStepConfig":{
"type":"structure",
"required":["Jar"],
@ -2850,6 +2934,16 @@
"documentation":"<p>This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.</p>"
},
"Long":{"type":"long"},
"ManagedScalingPolicy":{
"type":"structure",
"members":{
"ComputeLimits":{
"shape":"ComputeLimits",
"documentation":"<p> The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is not allowed to go above or below these limits. The limit only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
}
},
"documentation":"<p> Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that can be added or terminated from a cluster. The policy only applies to the core and task nodes. The master node cannot be scaled after initial configuration. </p>"
},
"Marker":{"type":"string"},
"MarketType":{
"type":"string",
@ -3030,7 +3124,7 @@
"members":{
"BlockPublicAccessConfiguration":{
"shape":"BlockPublicAccessConfiguration",
"documentation":"<p>A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code> in the <code>BlockPublicAccessConfiguration</code>. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating <code>BlockPublicSecurityGroupRules</code> to remove the exception.</p>"
"documentation":"<p>A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code> in the <code>BlockPublicAccessConfiguration</code>. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating <code>BlockPublicSecurityGroupRules</code> to remove the exception.</p> <note> <p>For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an EMR cluster in a Region before this date, block public access is enabled by default in that Region.</p> </note>"
}
}
},
@ -3039,6 +3133,28 @@
"members":{
}
},
"PutManagedScalingPolicyInput":{
"type":"structure",
"required":[
"ClusterId",
"ManagedScalingPolicy"
],
"members":{
"ClusterId":{
"shape":"ClusterId",
"documentation":"<p> Specifies the ID of an EMR cluster where the managed scaling policy is attached. </p>"
},
"ManagedScalingPolicy":{
"shape":"ManagedScalingPolicy",
"documentation":"<p> Specifies the constraints for the managed scaling policy. </p>"
}
}
},
"PutManagedScalingPolicyOutput":{
"type":"structure",
"members":{
}
},
"RemoveAutoScalingPolicyInput":{
"type":"structure",
"required":[
@ -3061,6 +3177,21 @@
"members":{
}
},
"RemoveManagedScalingPolicyInput":{
"type":"structure",
"required":["ClusterId"],
"members":{
"ClusterId":{
"shape":"ClusterId",
"documentation":"<p> Specifies the ID of the cluster from which the managed scaling policy will be removed. </p>"
}
}
},
"RemoveManagedScalingPolicyOutput":{
"type":"structure",
"members":{
}
},
"RemoveTagsInput":{
"type":"structure",
"required":[
@ -3195,6 +3326,10 @@
"StepConcurrencyLevel":{
"shape":"Integer",
"documentation":"<p>Specifies the number of steps that can be executed concurrently. The default value is <code>1</code>. The maximum value is <code>256</code>.</p>"
},
"ManagedScalingPolicy":{
"shape":"ManagedScalingPolicy",
"documentation":"<p> The specified managed scaling policy for an Amazon EMR cluster. </p>"
}
},
"documentation":"<p> Input to the <a>RunJobFlow</a> operation. </p>"

View file

@ -8,8 +8,11 @@
"dnsSuffix" : "amazonaws.com",
"partition" : "aws",
"partitionName" : "AWS Standard",
"regionRegex" : "^(us|eu|ap|sa|ca|me)\\-\\w+\\-\\d+$",
"regionRegex" : "^(us|eu|ap|sa|ca|me|af)\\-\\w+\\-\\d+$",
"regions" : {
"af-south-1" : {
"description" : "Africa (Cape Town)"
},
"ap-east-1" : {
"description" : "Asia Pacific (Hong Kong)"
},
@ -73,6 +76,7 @@
},
"access-analyzer" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -95,6 +99,7 @@
},
"acm" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -202,6 +207,12 @@
},
"api.ecr" : {
"endpoints" : {
"af-south-1" : {
"credentialScope" : {
"region" : "af-south-1"
},
"hostname" : "api.ecr.af-south-1.amazonaws.com"
},
"ap-east-1" : {
"credentialScope" : {
"region" : "ap-east-1"
@ -274,6 +285,30 @@
},
"hostname" : "api.ecr.eu-west-3.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ecr-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ecr-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ecr-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ecr-fips.us-west-2.amazonaws.com"
},
"me-south-1" : {
"credentialScope" : {
"region" : "me-south-1"
@ -312,6 +347,28 @@
}
}
},
"api.elastic-inference" : {
"endpoints" : {
"ap-northeast-1" : {
"hostname" : "api.elastic-inference.ap-northeast-1.amazonaws.com"
},
"ap-northeast-2" : {
"hostname" : "api.elastic-inference.ap-northeast-2.amazonaws.com"
},
"eu-west-1" : {
"hostname" : "api.elastic-inference.eu-west-1.amazonaws.com"
},
"us-east-1" : {
"hostname" : "api.elastic-inference.us-east-1.amazonaws.com"
},
"us-east-2" : {
"hostname" : "api.elastic-inference.us-east-2.amazonaws.com"
},
"us-west-2" : {
"hostname" : "api.elastic-inference.us-west-2.amazonaws.com"
}
}
},
"api.mediatailor" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -382,6 +439,7 @@
},
"apigateway" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -407,6 +465,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -515,6 +574,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -591,6 +651,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "fips.batch.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "fips.batch.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "fips.batch.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "fips.batch.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -672,6 +756,7 @@
},
"cloudformation" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -687,9 +772,33 @@
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-1-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "cloudformation-fips.us-east-1.amazonaws.com"
},
"us-east-2" : { },
"us-east-2-fips" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "cloudformation-fips.us-east-2.amazonaws.com"
},
"us-west-1" : { },
"us-west-2" : { }
"us-west-1-fips" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "cloudformation-fips.us-west-1.amazonaws.com"
},
"us-west-2" : { },
"us-west-2-fips" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "cloudformation-fips.us-west-2.amazonaws.com"
}
}
},
"cloudfront" : {
@ -762,6 +871,7 @@
},
"cloudtrail" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -774,6 +884,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "cloudtrail-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "cloudtrail-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "cloudtrail-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "cloudtrail-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -858,6 +992,7 @@
},
"codedeploy" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -915,6 +1050,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "codepipeline-fips.ca-central-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "codepipeline-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "codepipeline-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "codepipeline-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "codepipeline-fips.us-west-2.amazonaws.com"
},
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -948,6 +1113,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -1055,6 +1221,24 @@
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "comprehend-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "comprehend-fips.us-east-2.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "comprehend-fips.us-west-2.amazonaws.com"
},
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -1145,6 +1329,7 @@
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -1249,6 +1434,7 @@
},
"directconnect" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1261,6 +1447,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "directconnect-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "directconnect-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "directconnect-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "directconnect-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1271,12 +1481,14 @@
},
"discovery" : {
"endpoints" : {
"ap-southeast-2" : { },
"eu-central-1" : { },
"us-west-2" : { }
}
},
"dms" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1399,6 +1611,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "ds-fips.ca-central-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ds-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ds-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ds-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ds-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1412,6 +1654,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1474,6 +1717,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1486,6 +1730,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "ec2-fips.ca-central-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ec2-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ec2-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ec2-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ec2-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1496,6 +1770,7 @@
},
"ecs" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1508,6 +1783,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ecs-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ecs-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ecs-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ecs-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1518,6 +1817,7 @@
},
"elasticache" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1546,6 +1846,7 @@
},
"elasticbeanstalk" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1558,6 +1859,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "elasticbeanstalk-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "elasticbeanstalk-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "elasticbeanstalk-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "elasticbeanstalk-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1580,6 +1905,114 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ap-east-1" : {
"credentialScope" : {
"region" : "ap-east-1"
},
"hostname" : "elasticfilesystem-fips.ap-east-1.amazonaws.com"
},
"fips-ap-northeast-1" : {
"credentialScope" : {
"region" : "ap-northeast-1"
},
"hostname" : "elasticfilesystem-fips.ap-northeast-1.amazonaws.com"
},
"fips-ap-northeast-2" : {
"credentialScope" : {
"region" : "ap-northeast-2"
},
"hostname" : "elasticfilesystem-fips.ap-northeast-2.amazonaws.com"
},
"fips-ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
},
"hostname" : "elasticfilesystem-fips.ap-south-1.amazonaws.com"
},
"fips-ap-southeast-1" : {
"credentialScope" : {
"region" : "ap-southeast-1"
},
"hostname" : "elasticfilesystem-fips.ap-southeast-1.amazonaws.com"
},
"fips-ap-southeast-2" : {
"credentialScope" : {
"region" : "ap-southeast-2"
},
"hostname" : "elasticfilesystem-fips.ap-southeast-2.amazonaws.com"
},
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "elasticfilesystem-fips.ca-central-1.amazonaws.com"
},
"fips-eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
},
"hostname" : "elasticfilesystem-fips.eu-central-1.amazonaws.com"
},
"fips-eu-north-1" : {
"credentialScope" : {
"region" : "eu-north-1"
},
"hostname" : "elasticfilesystem-fips.eu-north-1.amazonaws.com"
},
"fips-eu-west-1" : {
"credentialScope" : {
"region" : "eu-west-1"
},
"hostname" : "elasticfilesystem-fips.eu-west-1.amazonaws.com"
},
"fips-eu-west-2" : {
"credentialScope" : {
"region" : "eu-west-2"
},
"hostname" : "elasticfilesystem-fips.eu-west-2.amazonaws.com"
},
"fips-eu-west-3" : {
"credentialScope" : {
"region" : "eu-west-3"
},
"hostname" : "elasticfilesystem-fips.eu-west-3.amazonaws.com"
},
"fips-me-south-1" : {
"credentialScope" : {
"region" : "me-south-1"
},
"hostname" : "elasticfilesystem-fips.me-south-1.amazonaws.com"
},
"fips-sa-east-1" : {
"credentialScope" : {
"region" : "sa-east-1"
},
"hostname" : "elasticfilesystem-fips.sa-east-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "elasticfilesystem-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "elasticfilesystem-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "elasticfilesystem-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "elasticfilesystem-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1593,6 +2026,7 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1605,6 +2039,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "elasticloadbalancing-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "elasticloadbalancing-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "elasticloadbalancing-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "elasticloadbalancing-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1619,6 +2077,7 @@
"sslCommonName" : "{region}.{service}.{dnsSuffix}"
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1633,6 +2092,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "elasticmapreduce-fips.ca-central-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "elasticmapreduce-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "elasticmapreduce-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "elasticmapreduce-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "elasticmapreduce-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : {
@ -1677,6 +2166,7 @@
},
"es" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1705,6 +2195,7 @@
},
"events" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1717,6 +2208,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "events-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "events-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "events-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "events-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1739,6 +2254,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "firehose-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "firehose-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "firehose-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "firehose-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -1890,7 +2429,9 @@
},
"fsx" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
@ -1926,6 +2467,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -1990,6 +2532,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "glue-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "glue-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "glue-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "glue-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2019,7 +2585,9 @@
},
"groundstation" : {
"endpoints" : {
"ap-southeast-2" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"me-south-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -2087,6 +2655,12 @@
"region" : "us-east-1"
},
"hostname" : "iam.amazonaws.com"
},
"iam-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "iam-fips.amazonaws.com"
}
},
"isRegionalized" : false,
@ -2116,6 +2690,30 @@
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "inspector-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "inspector-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "inspector-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "inspector-fips.us-west-2.amazonaws.com"
},
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -2298,6 +2896,7 @@
},
"kinesis" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2310,6 +2909,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "kinesis-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "kinesis-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "kinesis-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "kinesis-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2360,6 +2983,7 @@
},
"kms" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2399,6 +3023,7 @@
},
"lambda" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2411,6 +3036,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "lambda-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "lambda-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "lambda-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "lambda-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2433,6 +3082,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "license-manager-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "license-manager-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "license-manager-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "license-manager-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2460,6 +3133,7 @@
},
"logs" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2489,6 +3163,7 @@
"managedblockchain" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"eu-west-1" : { },
"us-east-1" : { }
@ -2564,6 +3239,7 @@
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2581,6 +3257,7 @@
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -2592,6 +3269,7 @@
}
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2614,6 +3292,7 @@
},
"mgh" : {
"endpoints" : {
"ap-southeast-2" : { },
"eu-central-1" : { },
"us-west-2" : { }
}
@ -2630,8 +3309,11 @@
}
},
"endpoints" : {
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -2641,6 +3323,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -2653,6 +3336,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "monitoring-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "monitoring-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "monitoring-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "monitoring-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2907,6 +3614,12 @@
"region" : "us-east-1"
},
"hostname" : "organizations.us-east-1.amazonaws.com"
},
"fips-aws-global" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "organizations-fips.us-east-1.amazonaws.com"
}
},
"isRegionalized" : false,
@ -2983,6 +3696,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "polly-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "polly-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "polly-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "polly-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -3097,6 +3834,7 @@
},
"rds" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3121,6 +3859,7 @@
},
"redshift" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3133,6 +3872,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "redshift-fips.ca-central-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "redshift-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "redshift-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "redshift-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "redshift-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -3159,6 +3928,7 @@
},
"resource-groups" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3248,6 +4018,8 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -3261,8 +4033,11 @@
}
},
"endpoints" : {
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -3319,6 +4094,7 @@
"signatureVersions" : [ "s3v4" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : {
"hostname" : "s3.ap-northeast-1.amazonaws.com",
@ -3782,12 +4558,24 @@
"sslCommonName" : "shield.us-east-1.amazonaws.com"
},
"endpoints" : {
"us-east-1" : { }
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "shield-fips.us-east-1.amazonaws.com"
},
"us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "shield.us-east-1.amazonaws.com"
}
},
"isRegionalized" : false
},
"sms" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3844,6 +4632,96 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ap-northeast-1" : {
"credentialScope" : {
"region" : "ap-northeast-1"
},
"hostname" : "snowball-fips.ap-northeast-1.amazonaws.com"
},
"fips-ap-northeast-2" : {
"credentialScope" : {
"region" : "ap-northeast-2"
},
"hostname" : "snowball-fips.ap-northeast-2.amazonaws.com"
},
"fips-ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
},
"hostname" : "snowball-fips.ap-south-1.amazonaws.com"
},
"fips-ap-southeast-1" : {
"credentialScope" : {
"region" : "ap-southeast-1"
},
"hostname" : "snowball-fips.ap-southeast-1.amazonaws.com"
},
"fips-ap-southeast-2" : {
"credentialScope" : {
"region" : "ap-southeast-2"
},
"hostname" : "snowball-fips.ap-southeast-2.amazonaws.com"
},
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "snowball-fips.ca-central-1.amazonaws.com"
},
"fips-eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
},
"hostname" : "snowball-fips.eu-central-1.amazonaws.com"
},
"fips-eu-west-1" : {
"credentialScope" : {
"region" : "eu-west-1"
},
"hostname" : "snowball-fips.eu-west-1.amazonaws.com"
},
"fips-eu-west-2" : {
"credentialScope" : {
"region" : "eu-west-2"
},
"hostname" : "snowball-fips.eu-west-2.amazonaws.com"
},
"fips-eu-west-3" : {
"credentialScope" : {
"region" : "eu-west-3"
},
"hostname" : "snowball-fips.eu-west-3.amazonaws.com"
},
"fips-sa-east-1" : {
"credentialScope" : {
"region" : "sa-east-1"
},
"hostname" : "snowball-fips.sa-east-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "snowball-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "snowball-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "snowball-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "snowball-fips.us-west-2.amazonaws.com"
},
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -3856,6 +4734,7 @@
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3868,6 +4747,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "sns-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "sns-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "sns-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "sns-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -3882,6 +4785,7 @@
"sslCommonName" : "{region}.queue.{dnsSuffix}"
},
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3930,6 +4834,7 @@
},
"ssm" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3942,8 +4847,56 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ssm-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ssm-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ssm-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ssm-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"ssm-facade-fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ssm-facade-fips.us-east-1.amazonaws.com"
},
"ssm-facade-fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ssm-facade-fips.us-east-2.amazonaws.com"
},
"ssm-facade-fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ssm-facade-fips.us-west-1.amazonaws.com"
},
"ssm-facade-fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ssm-facade-fips.us-west-2.amazonaws.com"
},
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -3952,6 +4905,7 @@
},
"states" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -3964,6 +4918,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "states-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "states-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "states-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "states-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -4060,6 +5038,7 @@
},
"sts" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -4124,6 +5103,7 @@
},
"swf" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -4136,6 +5116,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "swf-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "swf-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "swf-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "swf-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -4146,6 +5150,7 @@
},
"tagging" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -4182,6 +5187,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "fips.transcribe.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "fips.transcribe.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "fips.transcribe.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "fips.transcribe.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -4263,6 +5292,12 @@
},
"waf" : {
"endpoints" : {
"aws-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "waf-fips.amazonaws.com"
},
"aws-global" : {
"credentialScope" : {
"region" : "us-east-1"
@ -4275,22 +5310,222 @@
},
"waf-regional" : {
"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" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
"ap-east-1" : {
"credentialScope" : {
"region" : "ap-east-1"
},
"hostname" : "waf-regional.ap-east-1.amazonaws.com"
},
"ap-northeast-1" : {
"credentialScope" : {
"region" : "ap-northeast-1"
},
"hostname" : "waf-regional.ap-northeast-1.amazonaws.com"
},
"ap-northeast-2" : {
"credentialScope" : {
"region" : "ap-northeast-2"
},
"hostname" : "waf-regional.ap-northeast-2.amazonaws.com"
},
"ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
},
"hostname" : "waf-regional.ap-south-1.amazonaws.com"
},
"ap-southeast-1" : {
"credentialScope" : {
"region" : "ap-southeast-1"
},
"hostname" : "waf-regional.ap-southeast-1.amazonaws.com"
},
"ap-southeast-2" : {
"credentialScope" : {
"region" : "ap-southeast-2"
},
"hostname" : "waf-regional.ap-southeast-2.amazonaws.com"
},
"ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "waf-regional.ca-central-1.amazonaws.com"
},
"eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
},
"hostname" : "waf-regional.eu-central-1.amazonaws.com"
},
"eu-north-1" : {
"credentialScope" : {
"region" : "eu-north-1"
},
"hostname" : "waf-regional.eu-north-1.amazonaws.com"
},
"eu-west-1" : {
"credentialScope" : {
"region" : "eu-west-1"
},
"hostname" : "waf-regional.eu-west-1.amazonaws.com"
},
"eu-west-2" : {
"credentialScope" : {
"region" : "eu-west-2"
},
"hostname" : "waf-regional.eu-west-2.amazonaws.com"
},
"eu-west-3" : {
"credentialScope" : {
"region" : "eu-west-3"
},
"hostname" : "waf-regional.eu-west-3.amazonaws.com"
},
"fips-ap-east-1" : {
"credentialScope" : {
"region" : "ap-east-1"
},
"hostname" : "waf-regional-fips.ap-east-1.amazonaws.com"
},
"fips-ap-northeast-1" : {
"credentialScope" : {
"region" : "ap-northeast-1"
},
"hostname" : "waf-regional-fips.ap-northeast-1.amazonaws.com"
},
"fips-ap-northeast-2" : {
"credentialScope" : {
"region" : "ap-northeast-2"
},
"hostname" : "waf-regional-fips.ap-northeast-2.amazonaws.com"
},
"fips-ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
},
"hostname" : "waf-regional-fips.ap-south-1.amazonaws.com"
},
"fips-ap-southeast-1" : {
"credentialScope" : {
"region" : "ap-southeast-1"
},
"hostname" : "waf-regional-fips.ap-southeast-1.amazonaws.com"
},
"fips-ap-southeast-2" : {
"credentialScope" : {
"region" : "ap-southeast-2"
},
"hostname" : "waf-regional-fips.ap-southeast-2.amazonaws.com"
},
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "waf-regional-fips.ca-central-1.amazonaws.com"
},
"fips-eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
},
"hostname" : "waf-regional-fips.eu-central-1.amazonaws.com"
},
"fips-eu-north-1" : {
"credentialScope" : {
"region" : "eu-north-1"
},
"hostname" : "waf-regional-fips.eu-north-1.amazonaws.com"
},
"fips-eu-west-1" : {
"credentialScope" : {
"region" : "eu-west-1"
},
"hostname" : "waf-regional-fips.eu-west-1.amazonaws.com"
},
"fips-eu-west-2" : {
"credentialScope" : {
"region" : "eu-west-2"
},
"hostname" : "waf-regional-fips.eu-west-2.amazonaws.com"
},
"fips-eu-west-3" : {
"credentialScope" : {
"region" : "eu-west-3"
},
"hostname" : "waf-regional-fips.eu-west-3.amazonaws.com"
},
"fips-me-south-1" : {
"credentialScope" : {
"region" : "me-south-1"
},
"hostname" : "waf-regional-fips.me-south-1.amazonaws.com"
},
"fips-sa-east-1" : {
"credentialScope" : {
"region" : "sa-east-1"
},
"hostname" : "waf-regional-fips.sa-east-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "waf-regional-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "waf-regional-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "waf-regional-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "waf-regional-fips.us-west-2.amazonaws.com"
},
"me-south-1" : {
"credentialScope" : {
"region" : "me-south-1"
},
"hostname" : "waf-regional.me-south-1.amazonaws.com"
},
"sa-east-1" : {
"credentialScope" : {
"region" : "sa-east-1"
},
"hostname" : "waf-regional.sa-east-1.amazonaws.com"
},
"us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "waf-regional.us-east-1.amazonaws.com"
},
"us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "waf-regional.us-east-2.amazonaws.com"
},
"us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "waf-regional.us-west-1.amazonaws.com"
},
"us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "waf-regional.us-west-2.amazonaws.com"
}
}
},
"workdocs" : {
@ -4299,6 +5534,18 @@
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-west-1" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "workdocs-fips.us-east-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "workdocs-fips.us-west-2.amazonaws.com"
},
"us-east-1" : { },
"us-west-2" : { }
}
@ -4330,6 +5577,7 @@
},
"xray" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
@ -4392,6 +5640,12 @@
}
}
},
"api.sagemaker" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"apigateway" : {
"endpoints" : {
"cn-north-1" : { },
@ -4414,6 +5668,7 @@
},
"athena" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
@ -4560,7 +5815,19 @@
"elasticfilesystem" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
"cn-northwest-1" : { },
"fips-cn-north-1" : {
"credentialScope" : {
"region" : "cn-north-1"
},
"hostname" : "elasticfilesystem-fips.cn-north-1.amazonaws.com.cn"
},
"fips-cn-northwest-1" : {
"credentialScope" : {
"region" : "cn-northwest-1"
},
"hostname" : "elasticfilesystem-fips.cn-northwest-1.amazonaws.com.cn"
}
}
},
"elasticloadbalancing" : {
@ -4615,6 +5882,7 @@
},
"glue" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
@ -4662,6 +5930,12 @@
"cn-northwest-1" : { }
}
},
"kafka" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"kinesis" : {
"endpoints" : {
"cn-north-1" : { },
@ -4738,6 +6012,12 @@
"cn-northwest-1" : { }
}
},
"runtime.sagemaker" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"s3" : {
"defaults" : {
"protocols" : [ "http", "https" ],
@ -4797,7 +6077,13 @@
},
"snowball" : {
"endpoints" : {
"cn-north-1" : { }
"cn-north-1" : { },
"fips-cn-north-1" : {
"credentialScope" : {
"region" : "cn-north-1"
},
"hostname" : "snowball-fips.cn-north-1.amazonaws.com.cn"
}
}
},
"sns" : {
@ -4951,6 +6237,18 @@
},
"api.ecr" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "ecr-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "ecr-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
@ -5039,6 +6337,18 @@
},
"batch" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "batch.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "batch.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5079,11 +6389,29 @@
"codebuild" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1-fips" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "codebuild-fips.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : { },
"us-gov-west-1-fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "codebuild-fips.us-gov-west-1.amazonaws.com"
}
}
},
"codecommit" : {
"endpoints" : {
"fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "codecommit-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5106,11 +6434,28 @@
}
}
},
"codepipeline" : {
"endpoints" : {
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "codepipeline-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-west-1" : { }
}
},
"comprehend" : {
"defaults" : {
"protocols" : [ "https" ]
},
"endpoints" : {
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "comprehend-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-west-1" : { }
}
},
@ -5156,8 +6501,18 @@
},
"directconnect" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "directconnect.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "directconnect.us-gov-west-1.amazonaws.com"
}
}
},
"dms" : {
@ -5174,6 +6529,18 @@
},
"ds" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "ds-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "ds-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5198,12 +6565,34 @@
},
"ec2" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "ec2.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "ec2.us-gov-west-1.amazonaws.com"
}
}
},
"ecs" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "ecs-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "ecs-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5222,12 +6611,34 @@
},
"elasticbeanstalk" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "elasticbeanstalk.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "elasticbeanstalk.us-gov-west-1.amazonaws.com"
}
}
},
"elasticfilesystem" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "elasticfilesystem-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "elasticfilesystem-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5268,6 +6679,18 @@
},
"firehose" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "firehose-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "firehose-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5291,6 +6714,18 @@
},
"glue" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "glue-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "glue-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5332,6 +6767,18 @@
},
"inspector" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "inspector-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "inspector-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5371,12 +6818,36 @@
},
"lambda" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "lambda-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "lambda-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"license-manager" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "license-manager-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "license-manager-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5405,6 +6876,18 @@
},
"monitoring" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "monitoring.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "monitoring.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5437,8 +6920,20 @@
"isRegionalized" : false,
"partitionEndpoint" : "aws-us-gov-global"
},
"outposts" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"polly" : {
"endpoints" : {
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "polly-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-west-1" : { }
}
},
@ -5456,8 +6951,18 @@
},
"redshift" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "redshift.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "redshift.us-gov-west-1.amazonaws.com"
}
}
},
"rekognition" : {
@ -5581,6 +7086,12 @@
}
}
},
"securityhub" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"serverlessrepo" : {
"defaults" : {
"protocols" : [ "https" ]
@ -5596,6 +7107,13 @@
},
"servicecatalog" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-east-1-fips" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "servicecatalog-fips.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : { },
"us-gov-west-1-fips" : {
"credentialScope" : {
@ -5625,6 +7143,18 @@
},
"snowball" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "snowball-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "snowball-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5654,6 +7184,18 @@
},
"states" : {
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "states-fips.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "states.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5706,8 +7248,18 @@
},
"swf" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "swf.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "swf.us-gov-west-1.amazonaws.com"
}
}
},
"tagging" : {
@ -5721,6 +7273,18 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"fips-us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "fips.transcribe.us-gov-east-1.amazonaws.com"
},
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "fips.transcribe.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -5741,7 +7305,18 @@
},
"waf-regional" : {
"endpoints" : {
"us-gov-west-1" : { }
"fips-us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "waf-regional-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "waf-regional.us-gov-west-1.amazonaws.com"
}
}
},
"workspaces" : {
@ -5822,6 +7397,14 @@
"us-iso-east-1" : { }
}
},
"comprehend" : {
"defaults" : {
"protocols" : [ "https" ]
},
"endpoints" : {
"us-iso-east-1" : { }
}
},
"config" : {
"endpoints" : {
"us-iso-east-1" : { }

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -25,6 +25,24 @@
],
"documentation":"<p>Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging\" target=\"_blank\"> Tagging Amazon Elasticsearch Service Domains for more information.</a></p>"
},
"AssociatePackage":{
"name":"AssociatePackage",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/packages/associate/{PackageID}/{DomainName}"
},
"input":{"shape":"AssociatePackageRequest"},
"output":{"shape":"AssociatePackageResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Associates a package with an Amazon ES domain.</p>"
},
"CancelElasticsearchServiceSoftwareUpdate":{
"name":"CancelElasticsearchServiceSoftwareUpdate",
"http":{
@ -60,6 +78,25 @@
],
"documentation":"<p>Creates a new Elasticsearch domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains\" target=\"_blank\">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>"
},
"CreatePackage":{
"name":"CreatePackage",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/packages"
},
"input":{"shape":"CreatePackageRequest"},
"output":{"shape":"CreatePackageResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidTypeException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Create a package for use with Amazon ES domains.</p>"
},
"DeleteElasticsearchDomain":{
"name":"DeleteElasticsearchDomain",
"http":{
@ -89,6 +126,24 @@
],
"documentation":"<p>Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr\" target=\"_blank\">Deleting Elasticsearch Service Role</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i>.</p>"
},
"DeletePackage":{
"name":"DeletePackage",
"http":{
"method":"DELETE",
"requestUri":"/2015-01-01/packages/{PackageID}"
},
"input":{"shape":"DeletePackageRequest"},
"output":{"shape":"DeletePackageResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Delete the package.</p>"
},
"DescribeElasticsearchDomain":{
"name":"DescribeElasticsearchDomain",
"http":{
@ -154,6 +209,23 @@
],
"documentation":"<p> Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the <code> <a>DomainName</a> </code> to know what Limits are supported for modifying. </p>"
},
"DescribePackages":{
"name":"DescribePackages",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/packages/describe"
},
"input":{"shape":"DescribePackagesRequest"},
"output":{"shape":"DescribePackagesResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.</p>"
},
"DescribeReservedElasticsearchInstanceOfferings":{
"name":"DescribeReservedElasticsearchInstanceOfferings",
"http":{
@ -186,6 +258,24 @@
],
"documentation":"<p>Returns information about reserved Elasticsearch instances for this account.</p>"
},
"DissociatePackage":{
"name":"DissociatePackage",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/packages/dissociate/{PackageID}/{DomainName}"
},
"input":{"shape":"DissociatePackageRequest"},
"output":{"shape":"DissociatePackageResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Dissociates a package from the Amazon ES domain.</p>"
},
"GetCompatibleElasticsearchVersions":{
"name":"GetCompatibleElasticsearchVersions",
"http":{
@ -250,6 +340,23 @@
],
"documentation":"<p>Returns the name of all Elasticsearch domains owned by the current user's account. </p>"
},
"ListDomainsForPackage":{
"name":"ListDomainsForPackage",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/packages/{PackageID}/domains"
},
"input":{"shape":"ListDomainsForPackageRequest"},
"output":{"shape":"ListDomainsForPackageResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all Amazon ES domains associated with the package.</p>"
},
"ListElasticsearchInstanceTypes":{
"name":"ListElasticsearchInstanceTypes",
"http":{
@ -282,6 +389,23 @@
],
"documentation":"<p>List all supported Elasticsearch versions</p>"
},
"ListPackagesForDomain":{
"name":"ListPackagesForDomain",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/domain/{DomainName}/packages"
},
"input":{"shape":"ListPackagesForDomainRequest"},
"output":{"shape":"ListPackagesForDomainResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Lists all packages associated with the Amazon ES domain.</p>"
},
"ListTags":{
"name":"ListTags",
"http":{
@ -388,6 +512,14 @@
"type":"string",
"documentation":"<p>The Amazon Resource Name (ARN) of the Elasticsearch domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>"
},
"AccessDeniedException":{
"type":"structure",
"members":{
},
"documentation":"<p>An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"AccessPoliciesStatus":{
"type":"structure",
"required":[
@ -516,6 +648,38 @@
},
"documentation":"<p> Specifies the status of advanced security options for the specified Elasticsearch domain.</p>"
},
"AssociatePackageRequest":{
"type":"structure",
"required":[
"PackageID",
"DomainName"
],
"members":{
"PackageID":{
"shape":"PackageID",
"documentation":"<p>Internal ID of the package that you want to associate with a domain. Use <code>DescribePackages</code> to find this value.</p>",
"location":"uri",
"locationName":"PackageID"
},
"DomainName":{
"shape":"DomainName",
"documentation":"<p>Name of the domain that you want to associate the package with.</p>",
"location":"uri",
"locationName":"DomainName"
}
},
"documentation":"<p> Container for request parameters to <code> <a>AssociatePackage</a> </code> operation. </p>"
},
"AssociatePackageResponse":{
"type":"structure",
"members":{
"DomainPackageDetails":{
"shape":"DomainPackageDetails",
"documentation":"<p><code>DomainPackageDetails</code></p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>AssociatePackage</a> </code> operation. </p>"
},
"BaseException":{
"type":"structure",
"members":{
@ -608,6 +772,14 @@
},
"documentation":"<p> A map from an <code> <a>ElasticsearchVersion</a> </code> to a list of compatible <code> <a>ElasticsearchVersion</a> </code> s to which the domain can be upgraded. </p>"
},
"ConflictException":{
"type":"structure",
"members":{
},
"documentation":"<p>An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"CreateElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
@ -680,6 +852,44 @@
},
"documentation":"<p>The result of a <code>CreateElasticsearchDomain</code> operation. Contains the status of the newly created Elasticsearch domain.</p>"
},
"CreatePackageRequest":{
"type":"structure",
"required":[
"PackageName",
"PackageType",
"PackageSource"
],
"members":{
"PackageName":{
"shape":"PackageName",
"documentation":"<p>Unique identifier for the package.</p>"
},
"PackageType":{
"shape":"PackageType",
"documentation":"<p>Type of package. Currently supports only TXT-DICTIONARY.</p>"
},
"PackageDescription":{
"shape":"PackageDescription",
"documentation":"<p>Description of the package.</p>"
},
"PackageSource":{
"shape":"PackageSource",
"documentation":"<p>The customer S3 location <code>PackageSource</code> for importing the package.</p>"
}
},
"documentation":"<p> Container for request parameters to <code> <a>CreatePackage</a> </code> operation. </p>"
},
"CreatePackageResponse":{
"type":"structure",
"members":{
"PackageDetails":{
"shape":"PackageDetails",
"documentation":"<p>Information about the package <code>PackageDetails</code>.</p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>CreatePackage</a> </code> operation. </p>"
},
"CreatedAt":{"type":"timestamp"},
"DeleteElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
@ -703,6 +913,29 @@
},
"documentation":"<p>The result of a <code>DeleteElasticsearchDomain</code> request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.</p>"
},
"DeletePackageRequest":{
"type":"structure",
"required":["PackageID"],
"members":{
"PackageID":{
"shape":"PackageID",
"documentation":"<p>Internal ID of the package that you want to delete. Use <code>DescribePackages</code> to find this value.</p>",
"location":"uri",
"locationName":"PackageID"
}
},
"documentation":"<p> Container for request parameters to <code> <a>DeletePackage</a> </code> operation. </p>"
},
"DeletePackageResponse":{
"type":"structure",
"members":{
"PackageDetails":{
"shape":"PackageDetails",
"documentation":"<p><code>PackageDetails</code></p>"
}
},
"documentation":"<p> Container for response parameters to <code> <a>DeletePackage</a> </code> operation. </p>"
},
"DeploymentCloseDateTimeStamp":{"type":"timestamp"},
"DeploymentStatus":{
"type":"string",
@ -819,6 +1052,70 @@
},
"documentation":"<p> Container for the parameters received from <code> <a>DescribeElasticsearchInstanceTypeLimits</a> </code> operation. </p>"
},
"DescribePackagesFilter":{
"type":"structure",
"members":{
"Name":{
"shape":"DescribePackagesFilterName",
"documentation":"<p>Any field from <code>PackageDetails</code>.</p>"
},
"Value":{
"shape":"DescribePackagesFilterValues",
"documentation":"<p>A list of values for the specified field.</p>"
}
},
"documentation":"<p>Filter to apply in <code>DescribePackage</code> response.</p>"
},
"DescribePackagesFilterList":{
"type":"list",
"member":{"shape":"DescribePackagesFilter"},
"documentation":"<p>A list of <code>DescribePackagesFilter</code> to filter the packages included in a <code>DescribePackages</code> response.</p>"
},
"DescribePackagesFilterName":{
"type":"string",
"enum":[
"PackageID",
"PackageName",
"PackageStatus"
]
},
"DescribePackagesFilterValue":{
"type":"string",
"pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?-]*$"
},
"DescribePackagesFilterValues":{
"type":"list",
"member":{"shape":"DescribePackagesFilterValue"}
},
"DescribePackagesRequest":{
"type":"structure",
"members":{
"Filters":{
"shape":"DescribePackagesFilterList",
"documentation":"<p>Only returns packages that match the <code>DescribePackagesFilterList</code> values.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Limits results to a maximum number of packages.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>"
}
},
"documentation":"<p> Container for request parameters to <code> <a>DescribePackage</a> </code> operation. </p>"
},
"DescribePackagesResponse":{
"type":"structure",
"members":{
"PackageDetailsList":{
"shape":"PackageDetailsList",
"documentation":"<p>List of <code>PackageDetails</code> objects.</p>"
},
"NextToken":{"shape":"String"}
},
"documentation":"<p> Container for response returned by <code> <a>DescribePackages</a> </code> operation. </p>"
},
"DescribeReservedElasticsearchInstanceOfferingsRequest":{
"type":"structure",
"members":{
@ -903,6 +1200,38 @@
"error":{"httpStatusCode":409},
"exception":true
},
"DissociatePackageRequest":{
"type":"structure",
"required":[
"PackageID",
"DomainName"
],
"members":{
"PackageID":{
"shape":"PackageID",
"documentation":"<p>Internal ID of the package that you want to associate with a domain. Use <code>DescribePackages</code> to find this value.</p>",
"location":"uri",
"locationName":"PackageID"
},
"DomainName":{
"shape":"DomainName",
"documentation":"<p>Name of the domain that you want to associate the package with.</p>",
"location":"uri",
"locationName":"DomainName"
}
},
"documentation":"<p> Container for request parameters to <code> <a>DissociatePackage</a> </code> operation. </p>"
},
"DissociatePackageResponse":{
"type":"structure",
"members":{
"DomainPackageDetails":{
"shape":"DomainPackageDetails",
"documentation":"<p><code>DomainPackageDetails</code></p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>DissociatePackage</a> </code> operation. </p>"
},
"DomainEndpointOptions":{
"type":"structure",
"members":{
@ -967,6 +1296,58 @@
"member":{"shape":"DomainName"},
"documentation":"<p>A list of Elasticsearch domain names.</p>"
},
"DomainPackageDetails":{
"type":"structure",
"members":{
"PackageID":{
"shape":"PackageID",
"documentation":"<p>Internal ID of the package.</p>"
},
"PackageName":{
"shape":"PackageName",
"documentation":"<p>User specified name of the package.</p>"
},
"PackageType":{
"shape":"PackageType",
"documentation":"<p>Currently supports only TXT-DICTIONARY.</p>"
},
"LastUpdated":{
"shape":"LastUpdated",
"documentation":"<p>Timestamp of the most-recent update to the association status.</p>"
},
"DomainName":{
"shape":"DomainName",
"documentation":"<p>Name of the domain you've associated a package with.</p>"
},
"DomainPackageStatus":{
"shape":"DomainPackageStatus",
"documentation":"<p>State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.</p>"
},
"ReferencePath":{
"shape":"ReferencePath",
"documentation":"<p>The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.</p>"
},
"ErrorDetails":{
"shape":"ErrorDetails",
"documentation":"<p>Additional information if the package is in an error state. Null otherwise.</p>"
}
},
"documentation":"<p>Information on a package that is associated with a domain.</p>"
},
"DomainPackageDetailsList":{
"type":"list",
"member":{"shape":"DomainPackageDetails"}
},
"DomainPackageStatus":{
"type":"string",
"enum":[
"ASSOCIATING",
"ASSOCIATION_FAILED",
"ACTIVE",
"DISSOCIATING",
"DISSOCIATION_FAILED"
]
},
"Double":{"type":"double"},
"EBSOptions":{
"type":"structure",
@ -1372,7 +1753,15 @@
"key":{"shape":"String"},
"value":{"shape":"ServiceUrl"}
},
"ErrorDetails":{
"type":"structure",
"members":{
"ErrorType":{"shape":"ErrorType"},
"ErrorMessage":{"shape":"ErrorMessage"}
}
},
"ErrorMessage":{"type":"string"},
"ErrorType":{"type":"string"},
"GUID":{
"type":"string",
"pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}"
@ -1519,6 +1908,7 @@
"max":500,
"min":1
},
"LastUpdated":{"type":"timestamp"},
"LimitExceededException":{
"type":"structure",
"members":{
@ -1564,6 +1954,42 @@
},
"documentation":"<p>The result of a <code>ListDomainNames</code> operation. Contains the names of all Elasticsearch domains owned by this account.</p>"
},
"ListDomainsForPackageRequest":{
"type":"structure",
"required":["PackageID"],
"members":{
"PackageID":{
"shape":"PackageID",
"documentation":"<p>The package for which to list domains.</p>",
"location":"uri",
"locationName":"PackageID"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Limits results to a maximum number of domains.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p> Container for request parameters to <code> <a>ListDomainsForPackage</a> </code> operation. </p>"
},
"ListDomainsForPackageResponse":{
"type":"structure",
"members":{
"DomainPackageDetailsList":{
"shape":"DomainPackageDetailsList",
"documentation":"<p>List of <code>DomainPackageDetails</code> objects.</p>"
},
"NextToken":{"shape":"String"}
},
"documentation":"<p> Container for response parameters to <code> <a>ListDomainsForPackage</a> </code> operation. </p>"
},
"ListElasticsearchInstanceTypesRequest":{
"type":"structure",
"required":["ElasticsearchVersion"],
@ -1634,6 +2060,45 @@
},
"documentation":"<p> Container for the parameters for response received from <code> <a>ListElasticsearchVersions</a> </code> operation. </p>"
},
"ListPackagesForDomainRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of the domain for which you want to list associated packages.</p>",
"location":"uri",
"locationName":"DomainName"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Limits results to a maximum number of packages.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p> Container for request parameters to <code> <a>ListPackagesForDomain</a> </code> operation. </p>"
},
"ListPackagesForDomainResponse":{
"type":"structure",
"members":{
"DomainPackageDetailsList":{
"shape":"DomainPackageDetailsList",
"documentation":"<p>List of <code>DomainPackageDetails</code> objects.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token that needs to be supplied to the next call to get the next page of results.</p>"
}
},
"documentation":"<p> Container for response parameters to <code> <a>ListPackagesForDomain</a> </code> operation. </p>"
},
"ListTagsRequest":{
"type":"structure",
"required":["ARN"],
@ -1799,6 +2264,86 @@
},
"documentation":"<p>Provides the current status of the entity.</p>"
},
"PackageDescription":{
"type":"string",
"max":1024
},
"PackageDetails":{
"type":"structure",
"members":{
"PackageID":{
"shape":"PackageID",
"documentation":"<p>Internal ID of the package.</p>"
},
"PackageName":{
"shape":"PackageName",
"documentation":"<p>User specified name of the package.</p>"
},
"PackageType":{
"shape":"PackageType",
"documentation":"<p>Currently supports only TXT-DICTIONARY.</p>"
},
"PackageDescription":{
"shape":"PackageDescription",
"documentation":"<p>User-specified description of the package.</p>"
},
"PackageStatus":{
"shape":"PackageStatus",
"documentation":"<p>Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED</p>"
},
"CreatedAt":{
"shape":"CreatedAt",
"documentation":"<p>Timestamp which tells creation date of the package.</p>"
},
"ErrorDetails":{
"shape":"ErrorDetails",
"documentation":"<p>Additional information if the package is in an error state. Null otherwise.</p>"
}
},
"documentation":"<p>Basic information about a package.</p>"
},
"PackageDetailsList":{
"type":"list",
"member":{"shape":"PackageDetails"}
},
"PackageID":{"type":"string"},
"PackageName":{
"type":"string",
"max":28,
"min":3,
"pattern":"[a-z][a-z0-9\\-]+"
},
"PackageSource":{
"type":"structure",
"members":{
"S3BucketName":{
"shape":"S3BucketName",
"documentation":"<p>Name of the bucket containing the package.</p>"
},
"S3Key":{
"shape":"S3Key",
"documentation":"<p>Key (file name) of the package.</p>"
}
},
"documentation":"<p>The S3 location for importing the package specified as <code>S3BucketName</code> and <code>S3Key</code></p>"
},
"PackageStatus":{
"type":"string",
"enum":[
"COPYING",
"COPY_FAILED",
"VALIDATING",
"VALIDATION_FAILED",
"AVAILABLE",
"DELETING",
"DELETED",
"DELETE_FAILED"
]
},
"PackageType":{
"type":"string",
"enum":["TXT-DICTIONARY"]
},
"Password":{
"type":"string",
"min":8,
@ -1862,6 +2407,7 @@
"type":"list",
"member":{"shape":"RecurringCharge"}
},
"ReferencePath":{"type":"string"},
"RemoveTagsRequest":{
"type":"structure",
"required":[
@ -2018,6 +2564,12 @@
"max":2048,
"min":20
},
"S3BucketName":{
"type":"string",
"max":63,
"min":3
},
"S3Key":{"type":"string"},
"ServiceSoftwareOptions":{
"type":"structure",
"members":{
@ -2048,6 +2600,10 @@
"AutomatedUpdateDate":{
"shape":"DeploymentCloseDateTimeStamp",
"documentation":"<p>Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.</p>"
},
"OptionalDeployment":{
"shape":"Boolean",
"documentation":"<p><code>True</code> if a service software is never automatically updated. <code>False</code> if a service software is automatically updated after <code>AutomatedUpdateDate</code>. </p>"
}
},
"documentation":"<p>The current options of an Elasticsearch domain service software options.</p>"

View file

@ -1,5 +1,5 @@
{
"version":"1.0",
"examples":{
"version": "1.0",
"examples": {
}
}

View file

@ -128,7 +128,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidKMSResourceException"}
],
"documentation":"<p>Enables server-side encryption (SSE) for the delivery stream. </p> <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to <code>ENABLING</code>, and then to <code>ENABLED</code>. The encryption status of a delivery stream is the <code>Status</code> property in <a>DeliveryStreamEncryptionConfiguration</a>. If the operation fails, the encryption status changes to <code>ENABLING_FAILED</code>. You can continue to read and write data to your delivery stream while the encryption status is <code>ENABLING</code>, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to <code>ENABLED</code> before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements <a>PutRecordOutput$Encrypted</a> and <a>PutRecordBatchOutput$Encrypted</a>, respectively.</p> <p>To check the encryption status of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. In this case, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement and creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.</p> <p>If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get <code>ENABLING_FAILED</code>, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.</p> <p>If the encryption status of your delivery stream is <code>ENABLING_FAILED</code>, you can invoke this operation again. </p> <p>You can only enable SSE for a delivery stream that uses <code>DirectPut</code> as its source. </p> <p>The <code>StartDeliveryStreamEncryption</code> and <code>StopDeliveryStreamEncryption</code> operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call <code>StartDeliveryStreamEncryption</code> 13 times and <code>StopDeliveryStreamEncryption</code> 12 times for the same delivery stream in a 24-hour period.</p>"
"documentation":"<p>Enables server-side encryption (SSE) for the delivery stream. </p> <p>This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to <code>ENABLING</code>, and then to <code>ENABLED</code>. The encryption status of a delivery stream is the <code>Status</code> property in <a>DeliveryStreamEncryptionConfiguration</a>. If the operation fails, the encryption status changes to <code>ENABLING_FAILED</code>. You can continue to read and write data to your delivery stream while the encryption status is <code>ENABLING</code>, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to <code>ENABLED</code> before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements <a>PutRecordOutput$Encrypted</a> and <a>PutRecordBatchOutput$Encrypted</a>, respectively.</p> <p>To check the encryption status of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type <code>CUSTOMER_MANAGED_CMK</code>, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type <code>CUSTOMER_MANAGED_CMK</code>, Kinesis Data Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.</p> <p>If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get <code>ENABLING_FAILED</code>, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.</p> <p>If the encryption status of your delivery stream is <code>ENABLING_FAILED</code>, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt operations.</p> <p>You can enable SSE for a delivery stream only if it's a delivery stream that uses <code>DirectPut</code> as its source. </p> <p>The <code>StartDeliveryStreamEncryption</code> and <code>StopDeliveryStreamEncryption</code> operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call <code>StartDeliveryStreamEncryption</code> 13 times and <code>StopDeliveryStreamEncryption</code> 12 times for the same delivery stream in a 24-hour period.</p>"
},
"StopDeliveryStreamEncryption":{
"name":"StopDeliveryStreamEncryption",
@ -247,6 +247,7 @@
},
"ClusterJDBCURL":{
"type":"string",
"max":512,
"min":1,
"pattern":"jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)+redshift\\.([a-zA-Z0-9\\.]+):\\d{1,5}/[a-zA-Z0-9_$]+"
},
@ -261,7 +262,8 @@
"UNCOMPRESSED",
"GZIP",
"ZIP",
"Snappy"
"Snappy",
"HADOOP_SNAPPY"
]
},
"ConcurrentModificationException":{
@ -294,7 +296,12 @@
},
"documentation":"<p>Describes a <code>COPY</code> command for Amazon Redshift.</p>"
},
"CopyOptions":{"type":"string"},
"CopyOptions":{
"type":"string",
"max":204800,
"min":0,
"pattern":".*"
},
"CreateDeliveryStreamInput":{
"type":"structure",
"required":["DeliveryStreamName"],
@ -361,15 +368,15 @@
"members":{
"SchemaConfiguration":{
"shape":"SchemaConfiguration",
"documentation":"<p>Specifies the AWS Glue Data Catalog table that contains the column information.</p>"
"documentation":"<p>Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if <code>Enabled</code> is set to true.</p>"
},
"InputFormatConfiguration":{
"shape":"InputFormatConfiguration",
"documentation":"<p>Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.</p>"
"documentation":"<p>Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if <code>Enabled</code> is set to true.</p>"
},
"OutputFormatConfiguration":{
"shape":"OutputFormatConfiguration",
"documentation":"<p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.</p>"
"documentation":"<p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if <code>Enabled</code> is set to true.</p>"
},
"Enabled":{
"shape":"BooleanObject",
@ -378,10 +385,17 @@
},
"documentation":"<p>Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html\">Kinesis Data Firehose Record Format Conversion</a>.</p>"
},
"DataTableColumns":{"type":"string"},
"DataTableColumns":{
"type":"string",
"max":204800,
"min":0,
"pattern":".*"
},
"DataTableName":{
"type":"string",
"min":1
"max":512,
"min":1,
"pattern":".*"
},
"DeleteDeliveryStreamInput":{
"type":"structure",
@ -504,10 +518,10 @@
},
"KeyType":{
"shape":"KeyType",
"documentation":"<p>Indicates the type of customer master key (CMK) to use for encryption. The default setting is <code>AWS_OWNED_CMK</code>. For more information about CMKs, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">Customer Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> with <code>KeyType</code> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html\">CreateGrant</a> to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant. </p> <p>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a delivery stream that is already encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.</p>"
"documentation":"<p>Indicates the type of customer master key (CMK) to use for encryption. The default setting is <code>AWS_OWNED_CMK</code>. For more information about CMKs, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">Customer Master Keys (CMKs)</a>. When you invoke <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> with <code>KeyType</code> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html\">CreateGrant</a> to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant. </p> <p>When you invoke <a>StartDeliveryStreamEncryption</a> to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.</p> <p>You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a <a>CreateDeliveryStream</a> or <a>StartDeliveryStreamEncryption</a> operation exceeds this limit, Kinesis Data Firehose throws a <code>LimitExceededException</code>. </p> <important> <p>To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html\">About Symmetric and Asymmetric CMKs</a> in the AWS Key Management Service developer guide.</p> </important>"
}
},
"documentation":"<p>Used to specify the type and Amazon Resource Name (ARN) of the CMK needed for Server-Side Encryption (SSE). </p>"
"documentation":"<p>Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). </p>"
},
"DeliveryStreamEncryptionStatus":{
"type":"string",
@ -530,6 +544,13 @@
"INVALID_KMS_KEY",
"KMS_KEY_NOT_FOUND",
"KMS_OPT_IN_REQUIRED",
"CREATE_ENI_FAILED",
"DELETE_ENI_FAILED",
"SUBNET_NOT_FOUND",
"SECURITY_GROUP_NOT_FOUND",
"ENI_ACCESS_DENIED",
"SUBNET_ACCESS_DENIED",
"SECURITY_GROUP_ACCESS_DENIED",
"UNKNOWN_ERROR"
]
},
@ -651,7 +672,8 @@
"DestinationId":{
"type":"string",
"max":100,
"min":1
"min":1,
"pattern":"[a-zA-Z0-9-]+"
},
"ElasticsearchBufferingHints":{
"type":"structure",
@ -738,6 +760,10 @@
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
},
"VpcConfiguration":{
"shape":"VpcConfiguration",
"documentation":"<p>The details of the VPC of the Amazon ES destination.</p>"
}
},
"documentation":"<p>Describes the configuration of a destination in Amazon ES.</p>"
@ -792,6 +818,10 @@
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The Amazon CloudWatch logging options.</p>"
},
"VpcConfigurationDescription":{
"shape":"VpcConfigurationDescription",
"documentation":"<p>The details of the VPC of the Amazon ES destination.</p>"
}
},
"documentation":"<p>The destination description in Amazon ES.</p>"
@ -855,7 +885,8 @@
"ElasticsearchIndexName":{
"type":"string",
"max":80,
"min":1
"min":1,
"pattern":".*"
},
"ElasticsearchIndexRotationPeriod":{
"type":"string",
@ -892,7 +923,8 @@
"ElasticsearchTypeName":{
"type":"string",
"max":100,
"min":0
"min":0,
"pattern":".*"
},
"EncryptionConfiguration":{
"type":"structure",
@ -910,7 +942,12 @@
},
"ErrorCode":{"type":"string"},
"ErrorMessage":{"type":"string"},
"ErrorOutputPrefix":{"type":"string"},
"ErrorOutputPrefix":{
"type":"string",
"max":1024,
"min":0,
"pattern":".*"
},
"ExtendedS3DestinationConfiguration":{
"type":"structure",
"required":[
@ -1107,7 +1144,12 @@
"max":600,
"min":180
},
"HECEndpoint":{"type":"string"},
"HECEndpoint":{
"type":"string",
"max":2048,
"min":0,
"pattern":".*"
},
"HECEndpointType":{
"type":"string",
"enum":[
@ -1115,7 +1157,12 @@
"Event"
]
},
"HECToken":{"type":"string"},
"HECToken":{
"type":"string",
"max":2048,
"min":0,
"pattern":".*"
},
"HiveJsonSerDe":{
"type":"structure",
"members":{
@ -1134,7 +1181,7 @@
"documentation":"<p>Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.</p>"
}
},
"documentation":"<p>Specifies the deserializer you want to use to convert the format of the input data.</p>"
"documentation":"<p>Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if <code>Enabled</code> is set to true.</p>"
},
"IntervalInSeconds":{
"type":"integer",
@ -1325,18 +1372,32 @@
"max":50,
"min":0
},
"LogGroupName":{"type":"string"},
"LogStreamName":{"type":"string"},
"LogGroupName":{
"type":"string",
"max":512,
"min":0,
"pattern":"[\\.\\-_/#A-Za-z0-9]*"
},
"LogStreamName":{
"type":"string",
"max":512,
"min":0,
"pattern":"[^:*]*"
},
"NoEncryptionConfig":{
"type":"string",
"enum":["NoEncryption"]
},
"NonEmptyString":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^(?!\\s*$).+"
},
"NonEmptyStringWithoutWhitespace":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^\\S+$"
},
"NonNegativeIntegerObject":{
@ -1438,7 +1499,7 @@
"documentation":"<p>Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.</p>"
}
},
"documentation":"<p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.</p>"
"documentation":"<p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.</p>"
},
"ParquetCompression":{
"type":"string",
@ -1491,10 +1552,17 @@
},
"Password":{
"type":"string",
"max":512,
"min":6,
"pattern":".*",
"sensitive":true
},
"Prefix":{"type":"string"},
"Prefix":{
"type":"string",
"max":1024,
"min":0,
"pattern":".*"
},
"ProcessingConfiguration":{
"type":"structure",
"members":{
@ -1563,7 +1631,8 @@
"ProcessorParameterValue":{
"type":"string",
"max":512,
"min":1
"min":1,
"pattern":"^(?!\\s*$).+"
},
"ProcessorType":{
"type":"string",
@ -2059,7 +2128,13 @@
"documentation":"<p>Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to <code>LATEST</code>, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.</p>"
}
},
"documentation":"<p>Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.</p>"
"documentation":"<p>Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if <code>Enabled</code> is set to true.</p>"
},
"SecurityGroupIdList":{
"type":"list",
"member":{"shape":"NonEmptyStringWithoutWhitespace"},
"max":5,
"min":1
},
"Serializer":{
"type":"structure",
@ -2290,6 +2365,12 @@
"members":{
}
},
"SubnetIdList":{
"type":"list",
"member":{"shape":"NonEmptyStringWithoutWhitespace"},
"max":16,
"min":1
},
"Tag":{
"type":"structure",
"required":["Key"],
@ -2336,7 +2417,8 @@
"TagKey":{
"type":"string",
"max":128,
"min":1
"min":1,
"pattern":"^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$"
},
"TagKeyList":{
"type":"list",
@ -2347,7 +2429,8 @@
"TagValue":{
"type":"string",
"max":256,
"min":0
"min":0,
"pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$"
},
"Timestamp":{"type":"timestamp"},
"UntagDeliveryStreamInput":{
@ -2422,8 +2505,61 @@
},
"Username":{
"type":"string",
"max":512,
"min":1,
"pattern":".*",
"sensitive":true
},
"VpcConfiguration":{
"type":"structure",
"required":[
"SubnetIds",
"RoleARN",
"SecurityGroupIds"
],
"members":{
"SubnetIds":{
"shape":"SubnetIdList",
"documentation":"<p>The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis\">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIdList",
"documentation":"<p>The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination.</p>"
}
},
"documentation":"<p>The details of the VPC of the Amazon ES destination.</p>"
},
"VpcConfigurationDescription":{
"type":"structure",
"required":[
"SubnetIds",
"RoleARN",
"SecurityGroupIds",
"VpcId"
],
"members":{
"SubnetIds":{
"shape":"SubnetIdList",
"documentation":"<p>The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis\">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIdList",
"documentation":"<p>The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.</p>"
},
"VpcId":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>The ID of the Amazon ES destination's VPC.</p>"
}
},
"documentation":"<p>The details of the VPC of the Amazon ES destination.</p>"
}
},
"documentation":"<fullname>Amazon Kinesis Data Firehose API Reference</fullname> <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.</p>"

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -235,7 +235,7 @@
{"shape":"InternalErrorException"},
{"shape":"InvalidTypeException"}
],
"documentation":"<p>Creates an AWS Firewall Manager policy.</p> <p>Firewall Manager provides the following types of policies: </p> <ul> <li> <p>A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources</p> </li> <li> <p>An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group</p> </li> <li> <p>A security group policy, which manages VPC security groups across your AWS organization. </p> </li> </ul> <p>Each policy is specific to one of the three types. If you want to enforce more than one policy type across accounts, you can create multiple policies. You can create multiple policies for each type.</p> <p>You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see <a href=\"https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html\">CreateSubscription</a>.</p>"
"documentation":"<p>Creates an AWS Firewall Manager policy.</p> <p>Firewall Manager provides the following types of policies: </p> <ul> <li> <p>A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources</p> </li> <li> <p>An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.</p> </li> <li> <p>An AWS WAF Classic policy (type WAF), which defines a rule group. </p> </li> <li> <p>A security group policy, which manages VPC security groups across your AWS organization. </p> </li> </ul> <p>Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.</p> <p>You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see <a href=\"https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html\">CreateSubscription</a>.</p>"
},
"TagResource":{
"name":"TagResource",
@ -294,7 +294,7 @@
"members":{
"AdminAccount":{
"shape":"AWSAccountId",
"documentation":"<p>The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html\">Managing the AWS Accounts in Your Organization</a>.</p>"
"documentation":"<p>The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html\">Managing the AWS Accounts in Your Organization</a>. </p>"
}
}
},
@ -333,7 +333,10 @@
},
"CustomerPolicyScopeIdType":{
"type":"string",
"enum":["ACCOUNT"]
"enum":[
"ACCOUNT",
"ORG_UNIT"
]
},
"CustomerPolicyScopeMap":{
"type":"map",
@ -687,8 +690,9 @@
},
"ManagedServiceData":{
"type":"string",
"max":1024,
"min":1
"max":4096,
"min":1,
"pattern":".*"
},
"MemberAccounts":{
"type":"list",
@ -753,11 +757,11 @@
},
"IncludeMap":{
"shape":"CustomerPolicyScopeMap",
"documentation":"<p>Specifies the AWS account IDs to include in the policy. If <code>IncludeMap</code> is null, all accounts in the organization in AWS Organizations are included in the policy. If <code>IncludeMap</code> is not null, only values listed in <code>IncludeMap</code> are included in the policy.</p> <p>The key to the map is <code>ACCOUNT</code>. For example, a valid <code>IncludeMap</code> would be <code>{“ACCOUNT” : [“accountID1”, “accountID2”]}</code>.</p>"
"documentation":"<p>Specifies the AWS account IDs and AWS 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>, AWS 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>"
},
"ExcludeMap":{
"shape":"CustomerPolicyScopeMap",
"documentation":"<p>Specifies the AWS account IDs to exclude from the policy. The <code>IncludeMap</code> values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in <code>ExcludeMap</code> are removed, resulting in the final list of accounts to add to the policy.</p> <p>The key to the map is <code>ACCOUNT</code>. For example, a valid <code>ExcludeMap</code> would be <code>{“ACCOUNT” : [“accountID1”, “accountID2”]}</code>.</p>"
"documentation":"<p>Specifies the AWS account IDs and AWS 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>, AWS 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>An AWS Firewall Manager policy.</p>"
@ -1014,7 +1018,7 @@
},
"ManagedServiceData":{
"shape":"ManagedServiceData",
"documentation":"<p>Details about the service that are specific to the service type, in JSON format. For service type <code>SHIELD_ADVANCED</code>, this is an empty string.</p> <ul> <li> <p>Example: <code>WAF</code> </p> <p> <code>ManagedServiceData\": \"{\\\"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>\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_COMMON\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}</code> </p> </li> <li> <p>Example: <code>SECURITY_GROUPS_CONTENT_AUDIT</code> </p> <p> <code>\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd \\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}</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>\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"},\"RemediationEnabled\":false,\"Resou rceType\":\"AWS::EC2::SecurityGroup\"}</code> </p> </li> </ul>"
"documentation":"<p>Details about the service that are specific to the service type, in JSON format. For service type <code>SHIELD_ADVANCED</code>, this is an empty string.</p> <ul> <li> <p>Example: <code>WAFV2</code> </p> <p> <code>\"ManagedServiceData\": \"{\\\"type\\\":\\\"WAFV2\\\",\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"preProcessRuleGroups\\\":[{\\\"managedRuleGroupIdentifier\\\":null,\\\"ruleGroupArn\\\":\\\"rulegrouparn\\\",\\\"overrideAction\\\":{\\\"type\\\":\\\"COUNT\\\"},\\\"excludedRules\\\":[{\\\"name\\\":\\\"EntityName\\\"}],\\\"ruleGroupType\\\":\\\"RuleGroup\\\"}],\\\"postProcessRuleGroups\\\":[{\\\"managedRuleGroupIdentifier\\\":{\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\",\\\"vendor\\\":\\\"AWS\\\"},\\\"ruleGroupArn\\\":\\\"rulegrouparn\\\",\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"excludedRules\\\":[],\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\"}],\\\"overrideCustomerWebACLAssociation\\\":false}\"</code> </p> </li> <li> <p>Example: <code>WAF Classic</code> </p> <p> <code>\"ManagedServiceData\": \"{\\\"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>\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_COMMON\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}</code> </p> </li> <li> <p>Example: <code>SECURITY_GROUPS_CONTENT_AUDIT</code> </p> <p> <code>\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd \\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}</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>\"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"},\"RemediationEnabled\":false,\"Resou rceType\":\"AWS::EC2::SecurityGroup\"}</code> </p> </li> </ul>"
}
},
"documentation":"<p>Details about the security service that is being used to protect the resources.</p>"
@ -1023,6 +1027,7 @@
"type":"string",
"enum":[
"WAF",
"WAFV2",
"SHIELD_ADVANCED",
"SECURITY_GROUPS_COMMON",
"SECURITY_GROUPS_CONTENT_AUDIT",

View file

@ -68,6 +68,7 @@
"output":{"shape":"CreateModelVersionResult"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"}
],
@ -103,6 +104,22 @@
],
"documentation":"<p>Creates a variable.</p>"
},
"DeleteDetector":{
"name":"DeleteDetector",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDetectorRequest"},
"output":{"shape":"DeleteDetectorResult"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.</p>"
},
"DeleteDetectorVersion":{
"name":"DeleteDetectorVersion",
"http":{
@ -115,9 +132,10 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"}
{"shape":"ThrottlingException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Deletes the detector version.</p>"
"documentation":"<p>Deletes the detector version. You cannot delete detector versions that are in <code>ACTIVE</code> status.</p>"
},
"DeleteEvent":{
"name":"DeleteEvent",
@ -133,6 +151,22 @@
],
"documentation":"<p>Deletes the specified event.</p>"
},
"DeleteRuleVersion":{
"name":"DeleteRuleVersion",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRuleVersionRequest"},
"output":{"shape":"DeleteRuleVersionResult"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes the rule version. You cannot delete a rule version if it is used by an <code>ACTIVE</code> or <code>INACTIVE</code> detector version.</p>"
},
"DescribeDetector":{
"name":"DescribeDetector",
"http":{
@ -568,6 +602,15 @@
}
}
},
"ConflictException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"string"}
},
"documentation":"<p>An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:</p> <ul> <li> <p>DeleteDetector: A conflict exception will occur if the detector has associated <code>Rules</code> or <code>DetectorVersions</code>. You can only delete a detector if it has no <code>Rules</code> or <code>DetectorVersions</code>.</p> </li> <li> <p>DeleteDetectorVersion: A conflict exception will occur if the <code>DetectorVersion</code> status is <code>ACTIVE</code>.</p> </li> <li> <p>DeleteRuleVersion: A conflict exception will occur if the <code>RuleVersion</code> is in use by an associated <code>ACTIVE</code> or <code>INACTIVE DetectorVersion</code>.</p> </li> </ul>",
"exception":true
},
"CreateDetectorVersionRequest":{
"type":"structure",
"required":[
@ -594,6 +637,10 @@
"modelVersions":{
"shape":"ListOfModelVersions",
"documentation":"<p>The model versions to include in the detector version.</p>"
},
"ruleExecutionMode":{
"shape":"RuleExecutionMode",
"documentation":"<p>The rule execution mode for the rules included in the detector version.</p> <p>You can define and edit the rule mode at the detector version level, when it is in draft status.</p> <p>If you specify <code>FIRST_MATCHED</code>, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p> <p>If you specifiy <code>ALL_MATCHED</code>, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. </p> <p>The default behavior is <code>FIRST_MATCHED</code>.</p>"
}
}
},
@ -763,6 +810,21 @@
"BOOLEAN"
]
},
"DeleteDetectorRequest":{
"type":"structure",
"required":["detectorId"],
"members":{
"detectorId":{
"shape":"identifier",
"documentation":"<p>The ID of the detector to delete.</p>"
}
}
},
"DeleteDetectorResult":{
"type":"structure",
"members":{
}
},
"DeleteDetectorVersionRequest":{
"type":"structure",
"required":[
@ -800,6 +862,33 @@
"members":{
}
},
"DeleteRuleVersionRequest":{
"type":"structure",
"required":[
"detectorId",
"ruleId",
"ruleVersion"
],
"members":{
"detectorId":{
"shape":"identifier",
"documentation":"<p>The ID of the detector that includes the rule version to delete.</p>"
},
"ruleId":{
"shape":"identifier",
"documentation":"<p>The rule ID of the rule version to delete.</p>"
},
"ruleVersion":{
"shape":"nonEmptyString",
"documentation":"<p>The rule version to delete.</p>"
}
}
},
"DeleteRuleVersionResult":{
"type":"structure",
"members":{
}
},
"DescribeDetectorRequest":{
"type":"structure",
"required":["detectorId"],
@ -1059,6 +1148,10 @@
"createdTime":{
"shape":"time",
"documentation":"<p>The timestamp when the detector version was created. </p>"
},
"ruleExecutionMode":{
"shape":"RuleExecutionMode",
"documentation":"<p>The execution mode of the rule in the dectector</p> <p> <code>FIRST_MATCHED</code> indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p> <p> <code>ALL_MATCHED</code> indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.</p>"
}
}
},
@ -1272,6 +1365,10 @@
"modelScores":{
"shape":"ListOfModelScores",
"documentation":"<p>The model scores for models used in the detector version.</p>"
},
"ruleResults":{
"shape":"ListOfRuleResults",
"documentation":"<p>The rule results in the prediction.</p>"
}
}
},
@ -1395,6 +1492,10 @@
"type":"list",
"member":{"shape":"ModelVersion"}
},
"ListOfRuleResults":{
"type":"list",
"member":{"shape":"RuleResult"}
},
"ListOfStrings":{
"type":"list",
"member":{"shape":"string"}
@ -1930,10 +2031,31 @@
"type":"list",
"member":{"shape":"RuleDetail"}
},
"RuleExecutionMode":{
"type":"string",
"enum":[
"ALL_MATCHED",
"FIRST_MATCHED"
]
},
"RuleList":{
"type":"list",
"member":{"shape":"Rule"}
},
"RuleResult":{
"type":"structure",
"members":{
"ruleId":{
"shape":"string",
"documentation":"<p>The rule ID that was matched, based on the rule execution mode.</p>"
},
"outcomes":{
"shape":"ListOfStrings",
"documentation":"<p>The outcomes of the matched rule, based on the rule execution mode.</p>"
}
},
"documentation":"<p>The rule results.</p>"
},
"RulesMaxResults":{
"type":"integer",
"box":true,
@ -2026,6 +2148,10 @@
"modelVersions":{
"shape":"ListOfModelVersions",
"documentation":"<p>The model versions to include in the detector version.</p>"
},
"ruleExecutionMode":{
"shape":"RuleExecutionMode",
"documentation":"<p>The rule execution mode to add to the detector.</p> <p>If you specify <code>FIRST_MATCHED</code>, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.</p> <p>If you specifiy <code>ALL_MATCHED</code>, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.</p> <p>The default behavior is <code>FIRST_MATCHED</code>.</p>"
}
}
},
@ -2329,7 +2455,7 @@
"type":"string",
"max":512,
"min":1,
"pattern":"^s3:\\/\\/[^\\s]+$"
"pattern":"^s3:\\/\\/(.+)$"
},
"string":{"type":"string"},
"time":{"type":"string"}

View file

@ -8,6 +8,7 @@
"serviceFullName":"Amazon FSx",
"serviceId":"FSx",
"signatureVersion":"v4",
"signingName":"fsx",
"targetPrefix":"AWSSimbaAPIService_v20180301",
"uid":"fsx-2018-03-01"
},
@ -67,7 +68,7 @@
{"shape":"InternalServerError"},
{"shape":"DataRepositoryTaskExecuting"}
],
"documentation":"<p>Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A <code>CreateDataRepositoryTask</code> operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html\">Using Data Repository Tasks</a>. To learn more about linking a data repository to your file system, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/getting-started-step1.html\">Step 1: Create Your Amazon FSx for Lustre File System</a>.</p>",
"documentation":"<p>Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A <code>CreateDataRepositoryTask</code> operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html\">Using Data Repository Tasks</a>. To learn more about linking a data repository to your file system, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repository.html#export-prefix\">Setting the Export Prefix</a>.</p>",
"idempotent":true
},
"CreateFileSystem":{
@ -570,12 +571,12 @@
},
"Paths":{
"shape":"DataRepositoryTaskPaths",
"documentation":"<p>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The default path is the file system root directory.</p>"
"documentation":"<p>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is <code>/mnt/fsx</code> and <code>/mnt/fsx/path1</code> is a directory or file on the file system you want to export, then the path to provide is <code>path1</code>. If a path that you provide isn't valid, the task fails.</p>"
},
"FileSystemId":{"shape":"FileSystemId"},
"Report":{
"shape":"CompletionReport",
"documentation":"<p>Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the <code>Scope</code> parameter. </p>"
"documentation":"<p>Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the <code>Scope</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html\">Working with Task Completion Reports</a>.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
@ -608,11 +609,11 @@
},
"SubnetIds":{
"shape":"SubnetIds",
"documentation":"<p>A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also launched in that subnet's Availability Zone.</p>"
"documentation":"<p>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <code>MULTI_AZ_1</code> file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the <code>WindowsConfiguration &gt; PreferredSubnetID</code> property.</p> <p>For Windows <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p>A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later describe requests.</p>"
"documentation":"<p>A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.</p>"
},
"Tags":{
"shape":"Tags",
@ -621,6 +622,10 @@
"WindowsConfiguration":{
"shape":"CreateFileSystemWindowsConfiguration",
"documentation":"<p>The configuration for this Microsoft Windows file system.</p>"
},
"StorageType":{
"shape":"StorageType",
"documentation":"<p>Sets the storage type for the Windows file system you're creating from a backup. Valid values are <code>SSD</code> and <code>HDD</code>.</p> <ul> <li> <p>Set to <code>SSD</code> to use solid state drive storage. Supported on all Windows deployment types.</p> </li> <li> <p>Set to <code>HDD</code> to use hard disk drive storage. Supported on <code>SINGLE_AZ_2</code> and <code>MULTI_AZ_1</code> Windows file system deployment types. </p> </li> </ul> <p> Default value is <code>SSD</code>. </p> <note> <p>HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. </p> </note>"
}
},
"documentation":"<p>The request object for the <code>CreateFileSystemFromBackup</code> operation.</p>"
@ -660,10 +665,10 @@
},
"PerUnitStorageThroughput":{
"shape":"PerUnitStorageThroughput",
"documentation":"<p> (Optional) For the <code>PERSISTENT_1</code> deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision. (Default = 200 MB/s/TiB) </p> <p>Valid values are 50, 100, 200.</p>"
"documentation":"<p> Required for the <code>PERSISTENT_1</code> deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 117 MB/s of file system throughput. You pay for the amount of throughput that you provision. </p> <p>Valid values are 50, 100, 200.</p>"
}
},
"documentation":"<p>The Lustre configuration for the file system being created. This value is required if <code>FileSystemType</code> is set to <code>LUSTRE</code>.</p>"
"documentation":"<p>The Lustre configuration for the file system being created. </p>"
},
"CreateFileSystemRequest":{
"type":"structure",
@ -684,11 +689,15 @@
},
"StorageCapacity":{
"shape":"StorageCapacity",
"documentation":"<p>The storage capacity of the file system being created.</p> <p>For Windows file systems, valid values are 32 GiB - 65,536 GiB.</p> <p>For <code>SCRATCH_1</code> Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB. For <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> file systems, valid values are 1200, 2400, then continuing in increments of 2400 GiB.</p>"
"documentation":"<p>Sets the storage capacity of the file system that you're creating.</p> <p>For Lustre file systems:</p> <ul> <li> <p>For <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> deployment types, valid values are 1.2, 2.4, and increments of 2.4 TiB.</p> </li> <li> <p>For <code>SCRATCH_1</code> deployment type, valid values are 1.2, 2.4, and increments of 3.6 TiB.</p> </li> </ul> <p>For Windows file systems:</p> <ul> <li> <p>If <code>StorageType=SSD</code>, valid values are 32 GiB - 65,536 GiB (64 TiB).</p> </li> <li> <p>If <code>StorageType=HDD</code>, valid values are 2000 GiB - 65,536 GiB (64 TiB).</p> </li> </ul>"
},
"StorageType":{
"shape":"StorageType",
"documentation":"<p>Sets the storage type for the Amazon FSx for Windows file system you're creating. Valid values are <code>SSD</code> and <code>HDD</code>.</p> <ul> <li> <p>Set to <code>SSD</code> to use solid state drive storage. SSD is supported on all Windows deployment types.</p> </li> <li> <p>Set to <code>HDD</code> to use hard disk drive storage. HDD is supported on <code>SINGLE_AZ_2</code> and <code>MULTI_AZ_1</code> Windows file system deployment types. </p> </li> </ul> <p> Default value is <code>SSD</code>. For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-tco.html#saz-maz-storage-type\"> Storage Type Options</a> in the <i>Amazon FSx for Windows User Guide</i>. </p>"
},
"SubnetIds":{
"shape":"SubnetIds",
"documentation":"<p>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <code>MULTI_AZ_1</code> file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the <code>WindowsConfiguration &gt; PreferredSubnetID</code> property.</p> <p>For Windows <code>SINGLE_AZ_1</code> file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.</p>"
"documentation":"<p>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <code>MULTI_AZ_1</code> file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the <code>WindowsConfiguration &gt; PreferredSubnetID</code> property.</p> <p>For Windows <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIds",
@ -701,7 +710,7 @@
"KmsKeyId":{"shape":"KmsKeyId"},
"WindowsConfiguration":{
"shape":"CreateFileSystemWindowsConfiguration",
"documentation":"<p>The Microsoft Windows configuration for the file system being created. This value is required if <code>FileSystemType</code> is set to <code>WINDOWS</code>.</p>"
"documentation":"<p>The Microsoft Windows configuration for the file system being created. </p>"
},
"LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"}
},
@ -728,7 +737,7 @@
"SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryConfiguration"},
"DeploymentType":{
"shape":"WindowsDeploymentType",
"documentation":"<p>Specifies the file system deployment type, valid values are the following:</p> <ul> <li> <p>MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones.</p> </li> <li> <p>SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.</p> </li> </ul> <p>To learn more about high availability Multi-AZ file systems, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html\"> High Availability for Amazon FSx for Windows File Server</a>.</p>"
"documentation":"<p>Specifies the file system deployment type, valid values are the following:</p> <ul> <li> <p> <code>MULTI_AZ_1</code> - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type</p> </li> <li> <p> <code>SINGLE_AZ_1</code> - (Default) Choose to deploy a file system that is configured for single AZ redundancy.</p> </li> <li> <p> <code>SINGLE_AZ_2</code> - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html\"> Availability and Durability: Single-AZ and Multi-AZ File Systems</a>.</p>"
},
"PreferredSubnetId":{
"shape":"SubnetId",
@ -1208,13 +1217,17 @@
"shape":"StorageCapacity",
"documentation":"<p>The storage capacity of the file system in gigabytes (GB).</p>"
},
"StorageType":{
"shape":"StorageType",
"documentation":"<p>The storage type of the file system. Valid values are <code>SSD</code> and <code>HDD</code>. If set to <code>SSD</code>, the file system uses solid state drive storage. If set to <code>HDD</code>, the file system uses hard disk drive storage. </p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The ID of the primary VPC for the file system.</p>"
},
"SubnetIds":{
"shape":"SubnetIds",
"documentation":"<p>The ID of the subnet to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.</p>"
"documentation":"<p>Specifies the IDs of the subnets that the file system is accessible from. For Windows <code>MULTI_AZ_1</code> file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the <code>PreferredSubnetID</code> property. All other file systems have only one subnet ID.</p> <p>For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For <code>MULTI_AZ_1</code> Windows file systems, the endpoint for the file system is available in the <code>PreferredSubnetID</code>.</p>"
},
"NetworkInterfaceIds":{
"shape":"NetworkInterfaceIds",
@ -1430,7 +1443,7 @@
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre <code>PERSISTENT_1</code> file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre <code>SCRATCH_1</code> and <code>SCRATCH_2</code> file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html\">Encrypt</a> in the <i>AWS Key Management Service API Reference</i>.</p>",
"max":2048,
"min":1,
"pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|arn:aws[a-z-]{0,7}:kms:[a-z]{2}-[a-z-]{4,}-\\d+:\\d{12}:(key|alias)\\/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|[a-zA-Z0-9:\\/_-]+)|alias\\/[a-zA-Z0-9:\\/_-]+$"
"pattern":"^.{1,2048}$"
},
"LastUpdatedTime":{"type":"timestamp"},
"ListTagsForResourceRequest":{
@ -1595,7 +1608,7 @@
"documentation":"<p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
"max":512,
"min":8,
"pattern":"^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$"
"pattern":"^arn:(?=[^:]+:fsx:[^:]+:\\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\\d{1,3}(\\.\\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\\.)(?![^:]*\\.-)[a-z0-9].*(?<!-)):){4}(?!/).{0,1024}$"
},
"ResourceDoesNotSupportTagging":{
"type":"structure",
@ -1745,6 +1758,14 @@
"documentation":"<p>The storage capacity for your Amazon FSx file system, in gibibytes.</p>",
"min":0
},
"StorageType":{
"type":"string",
"documentation":"<p>The storage type for your Amazon FSx file system.</p>",
"enum":[
"SSD",
"HDD"
]
},
"SubnetId":{
"type":"string",
"documentation":"<p>The ID for a subnet. A <i>subnet</i> is a range of IP addresses in your virtual private cloud (VPC). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">VPC and Subnets</a> in the <i>Amazon VPC User Guide.</i> </p>",
@ -1947,7 +1968,8 @@
"type":"string",
"enum":[
"MULTI_AZ_1",
"SINGLE_AZ_1"
"SINGLE_AZ_1",
"SINGLE_AZ_2"
]
},
"WindowsFileSystemConfiguration":{
@ -1960,19 +1982,19 @@
"SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryAttributes"},
"DeploymentType":{
"shape":"WindowsDeploymentType",
"documentation":"<p>Specifies the file system deployment type, valid values are the following:</p> <ul> <li> <p> <code>MULTI_AZ_1</code> - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.</p> </li> <li> <p> <code>SINGLE_AZ_1</code> - (Default) Specifies a file system that is configured for single AZ redundancy.</p> </li> </ul>"
"documentation":"<p>Specifies the file system deployment type, valid values are the following:</p> <ul> <li> <p> <code>MULTI_AZ_1</code> - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.</p> </li> <li> <p> <code>SINGLE_AZ_1</code> - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.</p> </li> <li> <p> <code>SINGLE_AZ_2</code> - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html\">Single-AZ and Multi-AZ File Systems</a>.</p>"
},
"RemoteAdministrationEndpoint":{
"shape":"DNSName",
"documentation":"<p>For <code>MULTI_AZ_1</code> deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.</p> <p>For <code>SINGLE_AZ_1</code> deployment types, this is the DNS name of the file system.</p> <p>This endpoint is temporarily unavailable when the file system is undergoing maintenance.</p>"
"documentation":"<p>For <code>MULTI_AZ_1</code> deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.</p> <p>For <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> deployment types, this is the DNS name of the file system.</p> <p>This endpoint is temporarily unavailable when the file system is undergoing maintenance.</p>"
},
"PreferredSubnetId":{
"shape":"SubnetId",
"documentation":"<p>For <code>MULTI_AZ_1</code> deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in <code>SubnetIds</code> property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.</p> <p>For <code>SINGLE_AZ_1</code> deployment types, this value is the same as that for <code>SubnetIDs</code>.</p>"
"documentation":"<p>For <code>MULTI_AZ_1</code> deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in <code>SubnetIds</code> property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.</p> <p>For <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> deployment types, this value is the same as that for <code>SubnetIDs</code>. For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources\">Availability and Durability: Single-AZ and Multi-AZ File Systems</a> </p>"
},
"PreferredFileServerIp":{
"shape":"IpAddress",
"documentation":"<p>For <code>MULTI_AZ_1</code> deployment types, the IP address of the primary, or preferred, file server.</p> <p>Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for both <code>SINGLE_AZ_1</code> and <code>MULTI_AZ_1</code> deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information and instruction on mapping and mounting file shares, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html\">https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html</a>.</p>"
"documentation":"<p>For <code>MULTI_AZ_1</code> deployment types, the IP address of the primary, or preferred, file server.</p> <p>Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see <a href=\"https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html\">Accessing File Shares</a>.</p>"
},
"ThroughputCapacity":{
"shape":"MegabytesPerSecond",

File diff suppressed because one or more lines are too long

View file

@ -186,7 +186,7 @@
{"shape":"EndpointGroupNotFoundException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Describe an endpoint group.</p>"
"documentation":"<p>Describe an endpoint group. To see an AWS CLI example of describing an endpoint group, scroll down to <b>Example</b>.</p>"
},
"DescribeListener":{
"name":"DescribeListener",
@ -232,7 +232,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the IP address ranges that were specified in calls to <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html\">ProvisionByoipCidr</a>.</p> <p>To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to <b>Example</b>.</p>"
"documentation":"<p>Lists the IP address ranges that were specified in calls to <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html\">ProvisionByoipCidr</a>, including the current state and a history of state changes.</p> <p>To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to <b>Example</b>.</p>"
},
"ListEndpointGroups":{
"name":"ListEndpointGroups",
@ -552,9 +552,31 @@
"State":{
"shape":"ByoipCidrState",
"documentation":"<p>The state of the address pool.</p>"
},
"Events":{
"shape":"ByoipCidrEvents",
"documentation":"<p>A history of status changes for an IP address range that that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).</p>"
}
},
"documentation":"<p>Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).</p> <p>The following describes each BYOIP <code>State</code> that your IP address range can be in.</p> <ul> <li> <p> <b>PENDING_PROVISIONING</b> — Youve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.</p> </li> <li> <p> <b>READY</b> — The address range is provisioned with AWS Global Accelerator and can be advertised.</p> </li> <li> <p> <b>PENDING_ADVERTISING</b> — Youve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.</p> </li> <li> <p> <b>ADVERTISING</b> — The address range is being advertised by AWS Global Accelerator.</p> </li> <li> <p> <b>PENDING_WITHDRAWING</b> — Youve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.</p> </li> <li> <p> <b>PENDING_DEPROVISIONING</b> — Youve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.</p> </li> <li> <p> <b>DEPROVISIONED</b> — The address range is deprovisioned from AWS Global Accelerator.</p> </li> <li> <p> <b>FAILED_PROVISION </b> — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> <li> <p> <b>FAILED_ADVERTISING</b> — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> <li> <p> <b>FAILED_WITHDRAW</b> — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> <li> <p> <b>FAILED_DEPROVISION </b> — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> </ul>"
"documentation":"<p>Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).</p> <p>The following describes each BYOIP <code>State</code> that your IP address range can be in.</p> <ul> <li> <p> <b>PENDING_PROVISIONING</b> — Youve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.</p> </li> <li> <p> <b>READY</b> — The address range is provisioned with AWS Global Accelerator and can be advertised.</p> </li> <li> <p> <b>PENDING_ADVERTISING</b> — Youve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.</p> </li> <li> <p> <b>ADVERTISING</b> — The address range is being advertised by AWS Global Accelerator.</p> </li> <li> <p> <b>PENDING_WITHDRAWING</b> — Youve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.</p> </li> <li> <p> <b>PENDING_DEPROVISIONING</b> — Youve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.</p> </li> <li> <p> <b>DEPROVISIONED</b> — The address range is deprovisioned from AWS Global Accelerator.</p> </li> <li> <p> <b>FAILED_PROVISION </b> — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> <li> <p> <b>FAILED_ADVERTISING</b> — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> <li> <p> <b>FAILED_WITHDRAW</b> — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> <li> <p> <b>FAILED_DEPROVISION </b> — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.</p> </li> </ul>"
},
"ByoipCidrEvent":{
"type":"structure",
"members":{
"Message":{
"shape":"GenericString",
"documentation":"<p>A string that contains an <code>Event</code> message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).</p>"
},
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).</p>"
}
},
"documentation":"<p>A complex type that contains a <code>Message</code> and a <code>Timestamp</code> value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).</p>"
},
"ByoipCidrEvents":{
"type":"list",
"member":{"shape":"ByoipCidrEvent"}
},
"ByoipCidrNotFoundException":{
"type":"structure",
@ -891,7 +913,7 @@
},
"ClientIPPreservationEnabled":{
"shape":"GenericBoolean",
"documentation":"<p>Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/introduction-how-it-works-client-ip.html\"> Viewing Client IP Addresses in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
"documentation":"<p>Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html\"> Preserve Client IP Addresses in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type for endpoints.</p>"

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -2934,7 +2934,7 @@
},
"ConnectionProperties":{
"shape":"ConnectionProperties",
"documentation":"<p>These key-value pairs define parameters for the connection:</p> <ul> <li> <p> <code>HOST</code> - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.</p> </li> <li> <p> <code>PORT</code> - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.</p> </li> <li> <p> <code>USER_NAME</code> - The name under which to log in to the database. The value string for <code>USER_NAME</code> is \"<code>USERNAME</code>\".</p> </li> <li> <p> <code>PASSWORD</code> - A password, if one is used, for the user name.</p> </li> <li> <p> <code>ENCRYPTED_PASSWORD</code> - When you enable connection password protection by setting <code>ConnectionPasswordEncryption</code> in the Data Catalog encryption settings, this field stores the encrypted password.</p> </li> <li> <p> <code>JDBC_DRIVER_JAR_URI</code> - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_DRIVER_CLASS_NAME</code> - The class name of the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_ENGINE</code> - The name of the JDBC engine to use.</p> </li> <li> <p> <code>JDBC_ENGINE_VERSION</code> - The version of the JDBC engine to use.</p> </li> <li> <p> <code>CONFIG_FILES</code> - (Reserved for future use.)</p> </li> <li> <p> <code>INSTANCE_ID</code> - The instance ID to use.</p> </li> <li> <p> <code>JDBC_CONNECTION_URL</code> - The URL for the JDBC connection.</p> </li> <li> <p> <code>JDBC_ENFORCE_SSL</code> - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.</p> </li> <li> <p> <code>CUSTOM_JDBC_CERT</code> - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customers certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.</p> </li> <li> <p> <code>SKIP_CUSTOM_JDBC_CERT_VALIDATION</code> - By default, this is <code>false</code>. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to <code>true</code> to skip AWS Glues validation of the customer certificate.</p> </li> <li> <p> <code>CUSTOM_JDBC_CERT_STRING</code> - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the <code>SSL_SERVER_CERT_DN</code>; in Microsoft SQL Server, this is used as the <code>hostNameInCertificate</code>.</p> </li> </ul>"
"documentation":"<p>These key-value pairs define parameters for the connection:</p> <ul> <li> <p> <code>HOST</code> - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.</p> </li> <li> <p> <code>PORT</code> - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.</p> </li> <li> <p> <code>USER_NAME</code> - The name under which to log in to the database. The value string for <code>USER_NAME</code> is \"<code>USERNAME</code>\".</p> </li> <li> <p> <code>PASSWORD</code> - A password, if one is used, for the user name.</p> </li> <li> <p> <code>ENCRYPTED_PASSWORD</code> - When you enable connection password protection by setting <code>ConnectionPasswordEncryption</code> in the Data Catalog encryption settings, this field stores the encrypted password.</p> </li> <li> <p> <code>JDBC_DRIVER_JAR_URI</code> - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_DRIVER_CLASS_NAME</code> - The class name of the JDBC driver to use.</p> </li> <li> <p> <code>JDBC_ENGINE</code> - The name of the JDBC engine to use.</p> </li> <li> <p> <code>JDBC_ENGINE_VERSION</code> - The version of the JDBC engine to use.</p> </li> <li> <p> <code>CONFIG_FILES</code> - (Reserved for future use.)</p> </li> <li> <p> <code>INSTANCE_ID</code> - The instance ID to use.</p> </li> <li> <p> <code>JDBC_CONNECTION_URL</code> - The URL for connecting to a JDBC data source.</p> </li> <li> <p> <code>JDBC_ENFORCE_SSL</code> - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.</p> </li> <li> <p> <code>CUSTOM_JDBC_CERT</code> - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customers certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.</p> </li> <li> <p> <code>SKIP_CUSTOM_JDBC_CERT_VALIDATION</code> - By default, this is <code>false</code>. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to <code>true</code> to skip AWS Glues validation of the customer certificate.</p> </li> <li> <p> <code>CUSTOM_JDBC_CERT_STRING</code> - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the <code>SSL_SERVER_CERT_DN</code>; in Microsoft SQL Server, this is used as the <code>hostNameInCertificate</code>.</p> </li> <li> <p> <code>CONNECTION_URL</code> - The URL for connecting to a general (non-JDBC) data source.</p> </li> <li> <p> <code>KAFKA_BOOTSTRAP_SERVERS</code> - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.</p> </li> </ul>"
},
"PhysicalConnectionRequirements":{
"shape":"PhysicalConnectionRequirements",
@ -2973,7 +2973,7 @@
},
"ConnectionType":{
"shape":"ConnectionType",
"documentation":"<p>The type of the connection. Currently, only JDBC is supported; SFTP is not supported.</p>"
"documentation":"<p>The type of the connection. Currently, these types are supported:</p> <ul> <li> <p> <code>JDBC</code> - Designates a connection to a database through Java Database Connectivity (JDBC).</p> </li> <li> <p> <code>KAFKA</code> - Designates a connection to an Apache Kafka streaming platform.</p> </li> <li> <p> <code>MONGODB</code> - Designates a connection to a MongoDB document database.</p> </li> </ul> <p>SFTP is not supported.</p>"
},
"MatchCriteria":{
"shape":"MatchCriteria",
@ -3035,14 +3035,18 @@
"JDBC_ENFORCE_SSL",
"CUSTOM_JDBC_CERT",
"SKIP_CUSTOM_JDBC_CERT_VALIDATION",
"CUSTOM_JDBC_CERT_STRING"
"CUSTOM_JDBC_CERT_STRING",
"CONNECTION_URL",
"KAFKA_BOOTSTRAP_SERVERS"
]
},
"ConnectionType":{
"type":"string",
"enum":[
"JDBC",
"SFTP"
"SFTP",
"MONGODB",
"KAFKA"
]
},
"ConnectionsList":{
@ -6129,10 +6133,7 @@
},
"GetUserDefinedFunctionsRequest":{
"type":"structure",
"required":[
"DatabaseName",
"Pattern"
],
"required":["Pattern"],
"members":{
"CatalogId":{
"shape":"CatalogIdString",

View file

@ -41,6 +41,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "FilterNames"
},
"ListOrganizationAdminAccounts": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "AdminAccounts"
}
}
}

View file

@ -40,7 +40,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Archives GuardDuty findings specified by the list of finding IDs.</p> <note> <p>Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.</p> </note>"
"documentation":"<p>Archives GuardDuty findings that are specified by the list of finding IDs.</p> <note> <p>Only the master account can archive findings. Member accounts don't have permission to archive findings from their accounts.</p> </note>"
},
"CreateDetector":{
"name":"CreateDetector",
@ -55,7 +55,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.</p>"
"documentation":"<p>Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region.</p>"
},
"CreateFilter":{
"name":"CreateFilter",
@ -85,7 +85,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Creates a new IPSet, called Trusted IP list in the consoler user interface. An IPSet is a list IP addresses trusted for secure communication with AWS infrastructure and applications. GuardDuty does not generate findings for IP addresses included in IPSets. Only users from the master account can use this operation.</p>"
"documentation":"<p>Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the master account can use this operation.</p>"
},
"CreateMembers":{
"name":"CreateMembers",
@ -115,7 +115,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Creates a publishing destination to send findings to. The resource to send findings to must exist before you use this operation.</p>"
"documentation":"<p>Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.</p>"
},
"CreateSampleFindings":{
"name":"CreateSampleFindings",
@ -145,7 +145,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.</p>"
"documentation":"<p>Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.</p>"
},
"DeclineInvitations":{
"name":"DeclineInvitations",
@ -160,7 +160,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Declines invitations sent to the current member account by AWS account specified by their account IDs.</p>"
"documentation":"<p>Declines invitations sent to the current member account by AWS accounts specified by their account IDs.</p>"
},
"DeleteDetector":{
"name":"DeleteDetector",
@ -175,7 +175,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes a Amazon GuardDuty detector specified by the detector ID.</p>"
"documentation":"<p>Deletes an Amazon GuardDuty detector that is specified by the detector ID.</p>"
},
"DeleteFilter":{
"name":"DeleteFilter",
@ -205,7 +205,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes the IPSet specified by the <code>ipSetId</code>. IPSets are called Trusted IP lists in the console user interface.</p>"
"documentation":"<p>Deletes the IPSet specified by the <code>ipSetId</code>. IPSets are called trusted IP lists in the console user interface.</p>"
},
"DeleteInvitations":{
"name":"DeleteInvitations",
@ -265,7 +265,22 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes ThreatIntelSet specified by the ThreatIntelSet ID.</p>"
"documentation":"<p>Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.</p>"
},
"DescribeOrganizationConfiguration":{
"name":"DescribeOrganizationConfiguration",
"http":{
"method":"GET",
"requestUri":"/detector/{detectorId}/admin",
"responseCode":200
},
"input":{"shape":"DescribeOrganizationConfigurationRequest"},
"output":{"shape":"DescribeOrganizationConfigurationResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns information about the account selected as the delegated administrator for GuardDuty.</p>"
},
"DescribePublishingDestination":{
"name":"DescribePublishingDestination",
@ -282,6 +297,21 @@
],
"documentation":"<p>Returns information about the publishing destination specified by the provided <code>destinationId</code>.</p>"
},
"DisableOrganizationAdminAccount":{
"name":"DisableOrganizationAdminAccount",
"http":{
"method":"POST",
"requestUri":"/admin/disable",
"responseCode":200
},
"input":{"shape":"DisableOrganizationAdminAccountRequest"},
"output":{"shape":"DisableOrganizationAdminAccountResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Disables GuardDuty administrator permissions for an AWS account within the Organization.</p>"
},
"DisassociateFromMasterAccount":{
"name":"DisassociateFromMasterAccount",
"http":{
@ -312,6 +342,21 @@
],
"documentation":"<p>Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.</p>"
},
"EnableOrganizationAdminAccount":{
"name":"EnableOrganizationAdminAccount",
"http":{
"method":"POST",
"requestUri":"/admin/enable",
"responseCode":200
},
"input":{"shape":"EnableOrganizationAdminAccountRequest"},
"output":{"shape":"EnableOrganizationAdminAccountResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Enables GuardDuty administrator permissions for an AWS account within the organization.</p>"
},
"GetDetector":{
"name":"GetDetector",
"http":{
@ -370,7 +415,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Lists Amazon GuardDuty findings' statistics for the specified detector ID.</p>"
"documentation":"<p>Lists Amazon GuardDuty findings statistics for the specified detector ID.</p>"
},
"GetIPSet":{
"name":"GetIPSet",
@ -460,7 +505,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.</p>"
"documentation":"<p>Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.</p>"
},
"ListDetectors":{
"name":"ListDetectors",
@ -550,7 +595,22 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Lists details about all member accounts for the current GuardDuty master account.</p>"
"documentation":"<p>Lists details about associated member accounts for the current GuardDuty master account.</p>"
},
"ListOrganizationAdminAccounts":{
"name":"ListOrganizationAdminAccounts",
"http":{
"method":"GET",
"requestUri":"/admin",
"responseCode":200
},
"input":{"shape":"ListOrganizationAdminAccountsRequest"},
"output":{"shape":"ListOrganizationAdminAccountsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Lists the accounts configured as AWS Organization delegated administrators.</p>"
},
"ListPublishingDestinations":{
"name":"ListPublishingDestinations",
@ -580,7 +640,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and Threat Intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource..</p>"
"documentation":"<p>Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.</p>"
},
"ListThreatIntelSets":{
"name":"ListThreatIntelSets",
@ -625,7 +685,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Stops GuardDuty monitoring for the specified member accounnts. Use the <code>StartMonitoringMembers</code> to restart monitoring for those accounts.</p>"
"documentation":"<p>Stops GuardDuty monitoring for the specified member accounts. Use the <code>StartMonitoringMembers</code> operation to restart monitoring for those accounts.</p>"
},
"TagResource":{
"name":"TagResource",
@ -732,6 +792,21 @@
],
"documentation":"<p>Updates the IPSet specified by the IPSet ID.</p>"
},
"UpdateOrganizationConfiguration":{
"name":"UpdateOrganizationConfiguration",
"http":{
"method":"POST",
"requestUri":"/detector/{detectorId}/admin",
"responseCode":200
},
"input":{"shape":"UpdateOrganizationConfigurationRequest"},
"output":{"shape":"UpdateOrganizationConfigurationResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Updates the delegated administrator account with the values provided.</p>"
},
"UpdatePublishingDestination":{
"name":"UpdatePublishingDestination",
"http":{
@ -760,7 +835,7 @@
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Updates the ThreatIntelSet specified by ThreatIntelSet ID.</p>"
"documentation":"<p>Updates the ThreatIntelSet specified by the ThreatIntelSet ID.</p>"
}
},
"shapes":{
@ -785,7 +860,7 @@
},
"InvitationId":{
"shape":"String",
"documentation":"<p>This value is used to validate the master account to the member account.</p>",
"documentation":"<p>The value that is used to validate the master account to the member account.</p>",
"locationName":"invitationId"
}
}
@ -800,7 +875,7 @@
"members":{
"AccessKeyId":{
"shape":"String",
"documentation":"<p>Access key ID of the user.</p>",
"documentation":"<p>The access key ID of the user.</p>",
"locationName":"accessKeyId"
},
"PrincipalId":{
@ -830,12 +905,12 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>Member account ID.</p>",
"documentation":"<p>The member account ID.</p>",
"locationName":"accountId"
},
"Email":{
"shape":"Email",
"documentation":"<p>Member account's email address.</p>",
"documentation":"<p>The email address of the member account.</p>",
"locationName":"email"
}
},
@ -863,7 +938,7 @@
"members":{
"ActionType":{
"shape":"String",
"documentation":"<p>GuardDuty Finding activity type.</p>",
"documentation":"<p>The GuardDuty finding activity type.</p>",
"locationName":"actionType"
},
"AwsApiCallAction":{
@ -887,7 +962,38 @@
"locationName":"portProbeAction"
}
},
"documentation":"<p>Contains information about action.</p>"
"documentation":"<p>Contains information about actions.</p>"
},
"AdminAccount":{
"type":"structure",
"members":{
"AdminAccountId":{
"shape":"String",
"documentation":"<p>The AWS account ID for the account.</p>",
"locationName":"adminAccountId"
},
"AdminStatus":{
"shape":"AdminStatus",
"documentation":"<p>Indicates whether the account is enabled as the delegated administrator.</p>",
"locationName":"adminStatus"
}
},
"documentation":"<p>The account within the organization specified as the GuardDuty delegated administrator.</p>"
},
"AdminAccounts":{
"type":"list",
"member":{"shape":"AdminAccount"},
"max":1,
"min":0
},
"AdminStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLE_IN_PROGRESS"
],
"max":300,
"min":1
},
"ArchiveFindingsRequest":{
"type":"structure",
@ -904,7 +1010,7 @@
},
"FindingIds":{
"shape":"FindingIds",
"documentation":"<p>IDs of the findings that you want to archive.</p>",
"documentation":"<p>The IDs of the findings that you want to archive.</p>",
"locationName":"findingIds"
}
}
@ -919,27 +1025,27 @@
"members":{
"Api":{
"shape":"String",
"documentation":"<p>AWS API name.</p>",
"documentation":"<p>The AWS API name.</p>",
"locationName":"api"
},
"CallerType":{
"shape":"String",
"documentation":"<p>AWS API caller type.</p>",
"documentation":"<p>The AWS API caller type.</p>",
"locationName":"callerType"
},
"DomainDetails":{
"shape":"DomainDetails",
"documentation":"<p>Domain information for the AWS API call.</p>",
"documentation":"<p>The domain information for the AWS API call.</p>",
"locationName":"domainDetails"
},
"RemoteIpDetails":{
"shape":"RemoteIpDetails",
"documentation":"<p>Remote IP information of the connection.</p>",
"documentation":"<p>The remote IP information of the connection.</p>",
"locationName":"remoteIpDetails"
},
"ServiceName":{
"shape":"String",
"documentation":"<p>AWS service name whose API was invoked.</p>",
"documentation":"<p>The AWS service name whose API was invoked.</p>",
"locationName":"serviceName"
}
},
@ -959,7 +1065,7 @@
"locationName":"__type"
}
},
"documentation":"<p>Bad request exception object.</p>",
"documentation":"<p>A bad request exception object.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -969,7 +1075,7 @@
"members":{
"CityName":{
"shape":"String",
"documentation":"<p>City name of the remote IP address.</p>",
"documentation":"<p>The city name of the remote IP address.</p>",
"locationName":"cityName"
}
},
@ -985,68 +1091,68 @@
"members":{
"Eq":{
"shape":"Eq",
"documentation":"<p>Represents the equal condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents the <i>equal</i> condition to be applied to a single field when querying for findings.</p>",
"deprecated":true,
"locationName":"eq"
},
"Neq":{
"shape":"Neq",
"documentation":"<p>Represents the not equal condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents the <i>not equal</i> condition to be applied to a single field when querying for findings.</p>",
"deprecated":true,
"locationName":"neq"
},
"Gt":{
"shape":"Integer",
"documentation":"<p>Represents a greater than condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>greater than</i> condition to be applied to a single field when querying for findings.</p>",
"deprecated":true,
"locationName":"gt"
},
"Gte":{
"shape":"Integer",
"documentation":"<p>Represents a greater than equal condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>greater than or equal</i> condition to be applied to a single field when querying for findings.</p>",
"deprecated":true,
"locationName":"gte"
},
"Lt":{
"shape":"Integer",
"documentation":"<p>Represents a less than condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>less than</i> condition to be applied to a single field when querying for findings.</p>",
"deprecated":true,
"locationName":"lt"
},
"Lte":{
"shape":"Integer",
"documentation":"<p>Represents a less than equal condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>less than or equal</i> condition to be applied to a single field when querying for findings.</p>",
"deprecated":true,
"locationName":"lte"
},
"Equals":{
"shape":"Equals",
"documentation":"<p>Represents an <b>equal</b> condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents an <i>equal</i> <b/> condition to be applied to a single field when querying for findings.</p>",
"locationName":"equals"
},
"NotEquals":{
"shape":"NotEquals",
"documentation":"<p>Represents an <b>not equal</b> condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>not equal</i> <b/> condition to be applied to a single field when querying for findings.</p>",
"locationName":"notEquals"
},
"GreaterThan":{
"shape":"Long",
"documentation":"<p>Represents a greater than condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>greater than</i> condition to be applied to a single field when querying for findings.</p>",
"locationName":"greaterThan"
},
"GreaterThanOrEqual":{
"shape":"Long",
"documentation":"<p>Represents a greater than equal condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>greater than or equal</i> condition to be applied to a single field when querying for findings.</p>",
"locationName":"greaterThanOrEqual"
},
"LessThan":{
"shape":"Long",
"documentation":"<p>Represents a less than condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>less than</i> condition to be applied to a single field when querying for findings.</p>",
"locationName":"lessThan"
},
"LessThanOrEqual":{
"shape":"Long",
"documentation":"<p>Represents a less than equal condition to be applied to a single field when querying for findings.</p>",
"documentation":"<p>Represents a <i>less than or equal</i> condition to be applied to a single field when querying for findings.</p>",
"locationName":"lessThanOrEqual"
}
},
@ -1062,16 +1168,16 @@
"members":{
"CountryCode":{
"shape":"String",
"documentation":"<p>Country code of the remote IP address.</p>",
"documentation":"<p>The country code of the remote IP address.</p>",
"locationName":"countryCode"
},
"CountryName":{
"shape":"String",
"documentation":"<p>Country name of the remote IP address.</p>",
"documentation":"<p>The country name of the remote IP address.</p>",
"locationName":"countryName"
}
},
"documentation":"<p>Contains information about the country in which the remote IP address is located.</p>"
"documentation":"<p>Contains information about the country where the remote IP address is located.</p>"
},
"CreateDetectorRequest":{
"type":"structure",
@ -1079,7 +1185,7 @@
"members":{
"Enable":{
"shape":"Boolean",
"documentation":"<p>A boolean value that specifies whether the detector is to be enabled.</p>",
"documentation":"<p>A Boolean value that specifies whether the detector is to be enabled.</p>",
"locationName":"enable"
},
"ClientToken":{
@ -1090,7 +1196,7 @@
},
"FindingPublishingFrequency":{
"shape":"FindingPublishingFrequency",
"documentation":"<p>A enum value that specifies how frequently customer got Finding updates published.</p>",
"documentation":"<p>An enum value that specifies how frequently updated findings are exported.</p>",
"locationName":"findingPublishingFrequency"
},
"Tags":{
@ -1120,7 +1226,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account for which you want to create a filter.</p>",
"documentation":"<p>The unique ID of the detector of the GuardDuty account that you want to create a filter for.</p>",
"location":"uri",
"locationName":"detectorId"
},
@ -1146,7 +1252,7 @@
},
"FindingCriteria":{
"shape":"FindingCriteria",
"documentation":"<p>Represents the criteria to be used in the filter for querying findings.</p>",
"documentation":"<p>Represents the criteria to be used in the filter for querying findings.</p> <p>You can only use the following attributes to query findings:</p> <ul> <li> <p>accountId</p> </li> <li> <p>region</p> </li> <li> <p>confidence</p> </li> <li> <p>id</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.outpostArn</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.archived</p> <p>When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>severity</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.</p> </li> </ul>",
"locationName":"findingCriteria"
},
"ClientToken":{
@ -1185,13 +1291,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.</p>",
"documentation":"<p>The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.</p>",
"location":"uri",
"locationName":"detectorId"
},
"Name":{
"shape":"Name",
"documentation":"<p>The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.</p>",
"documentation":"<p>The user-friendly name to identify the IPSet.</p> <p> Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).</p>",
"locationName":"name"
},
"Format":{
@ -1201,12 +1307,12 @@
},
"Location":{
"shape":"Location",
"documentation":"<p>The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)</p>",
"documentation":"<p>The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.</p>",
"locationName":"location"
},
"Activate":{
"shape":"Boolean",
"documentation":"<p>A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.</p>",
"documentation":"<p>A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.</p>",
"locationName":"activate"
},
"ClientToken":{
@ -1242,7 +1348,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account with which you want to associate member accounts.</p>",
"documentation":"<p>The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.</p>",
"location":"uri",
"locationName":"detectorId"
},
@ -1259,7 +1365,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that include the <code>accountIds</code> of the unprocessed accounts and a result string that explains why each was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -1280,12 +1386,12 @@
},
"DestinationType":{
"shape":"DestinationType",
"documentation":"<p>The type of resource for the publishing destination. Currently only S3 is supported.</p>",
"documentation":"<p>The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.</p>",
"locationName":"destinationType"
},
"DestinationProperties":{
"shape":"DestinationProperties",
"documentation":"<p>Properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.</p>",
"documentation":"<p>The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.</p>",
"locationName":"destinationProperties"
},
"ClientToken":{
@ -1302,7 +1408,7 @@
"members":{
"DestinationId":{
"shape":"String",
"documentation":"<p>The ID of the publishing destination created.</p>",
"documentation":"<p>The ID of the publishing destination that is created.</p>",
"locationName":"destinationId"
}
}
@ -1319,7 +1425,7 @@
},
"FindingTypes":{
"shape":"FindingTypes",
"documentation":"<p>Types of sample findings to generate.</p>",
"documentation":"<p>The types of sample findings to generate.</p>",
"locationName":"findingTypes"
}
}
@ -1341,13 +1447,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.</p>",
"documentation":"<p>The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.</p>",
"location":"uri",
"locationName":"detectorId"
},
"Name":{
"shape":"Name",
"documentation":"<p>A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.</p>",
"documentation":"<p>A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.</p>",
"locationName":"name"
},
"Format":{
@ -1357,12 +1463,12 @@
},
"Location":{
"shape":"Location",
"documentation":"<p>The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).</p>",
"documentation":"<p>The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.</p>",
"locationName":"location"
},
"Activate":{
"shape":"Boolean",
"documentation":"<p>A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.</p>",
"documentation":"<p>A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.</p>",
"locationName":"activate"
},
"ClientToken":{
@ -1373,7 +1479,7 @@
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags to be added to a new Threat List resource.</p>",
"documentation":"<p>The tags to be added to a new threat list resource.</p>",
"locationName":"tags"
}
}
@ -1411,7 +1517,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -1442,13 +1548,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the filter is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the filter is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
"FilterName":{
"shape":"String",
"documentation":"<p>The name of the filter you want to delete.</p>",
"documentation":"<p>The name of the filter that you want to delete.</p>",
"location":"uri",
"locationName":"filterName"
}
@ -1502,7 +1608,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -1573,13 +1679,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the threatIntelSet is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the threatIntelSet is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
"ThreatIntelSetId":{
"shape":"String",
"documentation":"<p>The unique ID of the threatIntelSet you want to delete.</p>",
"documentation":"<p>The unique ID of the threatIntelSet that you want to delete.</p>",
"location":"uri",
"locationName":"threatIntelSetId"
}
@ -1590,6 +1696,37 @@
"members":{
}
},
"DescribeOrganizationConfigurationRequest":{
"type":"structure",
"required":["DetectorId"],
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The ID of the detector to retrieve information about the delegated administrator from.</p>",
"location":"uri",
"locationName":"detectorId"
}
}
},
"DescribeOrganizationConfigurationResponse":{
"type":"structure",
"required":[
"AutoEnable",
"MemberAccountLimitReached"
],
"members":{
"AutoEnable":{
"shape":"Boolean",
"documentation":"<p>Indicates whether GuardDuty is automatically enabled for accounts added to the organization.</p>",
"locationName":"autoEnable"
},
"MemberAccountLimitReached":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator master account.</p>",
"locationName":"memberAccountLimitReached"
}
}
},
"DescribePublishingDestinationRequest":{
"type":"structure",
"required":[
@ -1628,7 +1765,7 @@
},
"DestinationType":{
"shape":"DestinationType",
"documentation":"<p>The type of the publishing destination. Currently, only S3 is supported.</p>",
"documentation":"<p>The type of publishing destination. Currently, only Amazon S3 buckets are supported.</p>",
"locationName":"destinationType"
},
"Status":{
@ -1663,7 +1800,7 @@
},
"DestinationType":{
"shape":"DestinationType",
"documentation":"<p>The type of resource used for the publishing destination. Currently, only S3 is supported.</p>",
"documentation":"<p>The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.</p>",
"locationName":"destinationType"
},
"Status":{
@ -1672,7 +1809,7 @@
"locationName":"status"
}
},
"documentation":"<p>Contains information about a publishing destination, including the ID, type, and status.</p>"
"documentation":"<p>Contains information about the publishing destination, including the ID, type, and status.</p>"
},
"DestinationProperties":{
"type":"structure",
@ -1688,7 +1825,7 @@
"locationName":"kmsKeyArn"
}
},
"documentation":"<p>Contains the ARN of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.</p>"
"documentation":"<p>Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.</p>"
},
"DestinationType":{
"type":"string",
@ -1720,6 +1857,22 @@
"max":300,
"min":1
},
"DisableOrganizationAdminAccountRequest":{
"type":"structure",
"required":["AdminAccountId"],
"members":{
"AdminAccountId":{
"shape":"String",
"documentation":"<p>The AWS Account ID for the Organizations account to be disabled as a GuardDuty delegated administrator.</p>",
"locationName":"adminAccountId"
}
}
},
"DisableOrganizationAdminAccountResponse":{
"type":"structure",
"members":{
}
},
"DisassociateFromMasterAccountRequest":{
"type":"structure",
"required":["DetectorId"],
@ -1746,13 +1899,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master.</p>",
"documentation":"<p>The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the master account.</p>",
"location":"uri",
"locationName":"detectorId"
},
"AccountIds":{
"shape":"AccountIds",
"documentation":"<p>A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.</p>",
"documentation":"<p>A list of account IDs of the GuardDuty member accounts that you want to disassociate from the master account.</p>",
"locationName":"accountIds"
}
}
@ -1763,7 +1916,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -1773,7 +1926,7 @@
"members":{
"Domain":{
"shape":"String",
"documentation":"<p>Domain information for the API request.</p>",
"documentation":"<p>The domain information for the API request.</p>",
"locationName":"domain"
}
},
@ -1784,7 +1937,7 @@
"members":{
"Domain":{
"shape":"String",
"documentation":"<p>Domain information for the AWS API call.</p>",
"documentation":"<p>The domain information for the AWS API call.</p>",
"locationName":"domain"
}
},
@ -1796,6 +1949,22 @@
"max":64,
"min":1
},
"EnableOrganizationAdminAccountRequest":{
"type":"structure",
"required":["AdminAccountId"],
"members":{
"AdminAccountId":{
"shape":"String",
"documentation":"<p>The AWS Account ID for the Organizations account to be enabled as a GuardDuty delegated administrator.</p>",
"locationName":"adminAccountId"
}
}
},
"EnableOrganizationAdminAccountResponse":{
"type":"structure",
"members":{
}
},
"Eq":{
"type":"list",
"member":{"shape":"String"}
@ -1874,7 +2043,7 @@
},
"Arn":{
"shape":"String",
"documentation":"<p>The ARN for the finding.</p>",
"documentation":"<p>The ARN of the finding.</p>",
"locationName":"arn"
},
"Confidence":{
@ -1884,7 +2053,7 @@
},
"CreatedAt":{
"shape":"String",
"documentation":"<p>The time and date at which the finding was created.</p>",
"documentation":"<p>The time and date when the finding was created.</p>",
"locationName":"createdAt"
},
"Description":{
@ -1904,7 +2073,7 @@
},
"Region":{
"shape":"String",
"documentation":"<p>The Region in which the finding was generated.</p>",
"documentation":"<p>The Region where the finding was generated.</p>",
"locationName":"region"
},
"Resource":{
@ -1927,17 +2096,17 @@
},
"Title":{
"shape":"String",
"documentation":"<p>The title for the finding.</p>",
"documentation":"<p>The title of the finding.</p>",
"locationName":"title"
},
"Type":{
"shape":"FindingType",
"documentation":"<p>The type of the finding.</p>",
"documentation":"<p>The type of finding.</p>",
"locationName":"type"
},
"UpdatedAt":{
"shape":"String",
"documentation":"<p>The time and date at which the finding was laste updated.</p>",
"documentation":"<p>The time and date when the finding was last updated.</p>",
"locationName":"updatedAt"
}
},
@ -1988,7 +2157,7 @@
"members":{
"CountBySeverity":{
"shape":"CountBySeverity",
"documentation":"<p>Represents a map of severity to count statistic for a set of findings</p>",
"documentation":"<p>Represents a map of severity to count statistics for a set of findings.</p>",
"locationName":"countBySeverity"
}
},
@ -2016,12 +2185,12 @@
"members":{
"Lat":{
"shape":"Double",
"documentation":"<p>Latitude information of remote IP address.</p>",
"documentation":"<p>The latitude information of the remote IP address.</p>",
"locationName":"lat"
},
"Lon":{
"shape":"Double",
"documentation":"<p>Longitude information of remote IP address.</p>",
"documentation":"<p>The longitude information of the remote IP address.</p>",
"locationName":"lon"
}
},
@ -2048,12 +2217,12 @@
"members":{
"CreatedAt":{
"shape":"String",
"documentation":"<p>Detector creation timestamp.</p>",
"documentation":"<p>The timestamp of when the detector was created.</p>",
"locationName":"createdAt"
},
"FindingPublishingFrequency":{
"shape":"FindingPublishingFrequency",
"documentation":"<p>Finding publishing frequency.</p>",
"documentation":"<p>The publishing frequency of the finding.</p>",
"locationName":"findingPublishingFrequency"
},
"ServiceRole":{
@ -2068,7 +2237,7 @@
},
"UpdatedAt":{
"shape":"String",
"documentation":"<p>Detector last update timestamp.</p>",
"documentation":"<p>The last-updated timestamp for the detector.</p>",
"locationName":"updatedAt"
},
"Tags":{
@ -2087,7 +2256,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the filter is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the filter is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
@ -2154,7 +2323,7 @@
},
"FindingIds":{
"shape":"FindingIds",
"documentation":"<p>IDs of the findings that you want to retrieve.</p>",
"documentation":"<p>The IDs of the findings that you want to retrieve.</p>",
"locationName":"findingIds"
},
"SortCriteria":{
@ -2190,12 +2359,12 @@
},
"FindingStatisticTypes":{
"shape":"FindingStatisticTypes",
"documentation":"<p>Types of finding statistics to retrieve.</p>",
"documentation":"<p>The types of finding statistics to retrieve.</p>",
"locationName":"findingStatisticTypes"
},
"FindingCriteria":{
"shape":"FindingCriteria",
"documentation":"<p>Represents the criteria used for querying findings.</p>",
"documentation":"<p>Represents the criteria that is used for querying findings.</p>",
"locationName":"findingCriteria"
}
}
@ -2206,7 +2375,7 @@
"members":{
"FindingStatistics":{
"shape":"FindingStatistics",
"documentation":"<p>Finding statistics object.</p>",
"documentation":"<p>The finding statistics object.</p>",
"locationName":"findingStatistics"
}
}
@ -2220,7 +2389,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the ipSet is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the IPSet is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
@ -2243,7 +2412,7 @@
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The user friendly name for the IPSet.</p>",
"documentation":"<p>The user-friendly name for the IPSet.</p>",
"locationName":"name"
},
"Format":{
@ -2253,17 +2422,17 @@
},
"Location":{
"shape":"Location",
"documentation":"<p>The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)</p>",
"documentation":"<p>The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.</p>",
"locationName":"location"
},
"Status":{
"shape":"IpSetStatus",
"documentation":"<p>The status of ipSet file uploaded.</p>",
"documentation":"<p>The status of IPSet file that was uploaded.</p>",
"locationName":"status"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags of the IP set resource.</p>",
"documentation":"<p>The tags of the IPSet resource.</p>",
"locationName":"tags"
}
}
@ -2301,7 +2470,7 @@
"members":{
"Master":{
"shape":"Master",
"documentation":"<p>Master account details.</p>",
"documentation":"<p>The master account details.</p>",
"locationName":"master"
}
}
@ -2340,7 +2509,7 @@
},
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -2354,13 +2523,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the threatIntelSet is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the threatIntelSet is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
"ThreatIntelSetId":{
"shape":"String",
"documentation":"<p>The unique ID of the threatIntelSet you want to get.</p>",
"documentation":"<p>The unique ID of the threatIntelSet that you want to get.</p>",
"location":"uri",
"locationName":"threatIntelSetId"
}
@ -2377,7 +2546,7 @@
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.</p>",
"documentation":"<p>A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.</p>",
"locationName":"name"
},
"Format":{
@ -2387,7 +2556,7 @@
},
"Location":{
"shape":"Location",
"documentation":"<p>The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).</p>",
"documentation":"<p>The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.</p>",
"locationName":"location"
},
"Status":{
@ -2397,7 +2566,7 @@
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags of the Threat List resource.</p>",
"documentation":"<p>The tags of the threat list resource.</p>",
"locationName":"tags"
}
}
@ -2411,12 +2580,12 @@
"members":{
"Arn":{
"shape":"String",
"documentation":"<p>AWS EC2 instance profile ARN.</p>",
"documentation":"<p>The profile ARN of the EC2 instance.</p>",
"locationName":"arn"
},
"Id":{
"shape":"String",
"documentation":"<p>AWS EC2 instance profile ID.</p>",
"documentation":"<p>The profile ID of the EC2 instance.</p>",
"locationName":"id"
}
},
@ -2427,7 +2596,7 @@
"members":{
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>The availability zone of the EC2 instance.</p>",
"documentation":"<p>The Availability Zone of the EC2 instance.</p>",
"locationName":"availabilityZone"
},
"IamInstanceProfile":{
@ -2472,7 +2641,7 @@
},
"NetworkInterfaces":{
"shape":"NetworkInterfaces",
"documentation":"<p>The network interface information of the EC2 instance.</p>",
"documentation":"<p>The elastic network interface information of the EC2 instance.</p>",
"locationName":"networkInterfaces"
},
"Platform":{
@ -2508,7 +2677,7 @@
"locationName":"__type"
}
},
"documentation":"<p>Internal server error exception object.</p>",
"documentation":"<p>An internal server error exception object.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
@ -2517,7 +2686,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the account from which the invitations was sent.</p>",
"documentation":"<p>The ID of the account that the invitation was sent from.</p>",
"locationName":"accountId"
},
"InvitationId":{
@ -2532,7 +2701,7 @@
},
"InvitedAt":{
"shape":"String",
"documentation":"<p>Timestamp at which the invitation was sent.</p>",
"documentation":"<p>The timestamp when the invitation was sent.</p>",
"locationName":"invitedAt"
}
},
@ -2553,7 +2722,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account with which you want to invite members.</p>",
"documentation":"<p>The unique ID of the detector of the GuardDuty account that you want to invite members with.</p>",
"location":"uri",
"locationName":"detectorId"
},
@ -2564,7 +2733,7 @@
},
"DisableEmailNotification":{
"shape":"Boolean",
"documentation":"<p>A boolean value that specifies whether you want to disable email notification to the accounts that youre inviting to GuardDuty as members.</p>",
"documentation":"<p>A Boolean value that specifies whether you want to disable email notification to the accounts that youre inviting to GuardDuty as members.</p>",
"locationName":"disableEmailNotification"
},
"Message":{
@ -2580,7 +2749,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -2627,13 +2796,13 @@
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.</p>",
"documentation":"<p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2645,12 +2814,12 @@
"members":{
"DetectorIds":{
"shape":"DetectorIds",
"documentation":"<p>A list of detector Ids.</p>",
"documentation":"<p>A list of detector IDs.</p>",
"locationName":"detectorIds"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2661,19 +2830,19 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the filter is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the filter is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.</p>",
"documentation":"<p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2685,12 +2854,12 @@
"members":{
"FilterNames":{
"shape":"FilterNames",
"documentation":"<p>A list of filter names</p>",
"documentation":"<p>A list of filter names.</p>",
"locationName":"filterNames"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2707,7 +2876,7 @@
},
"FindingCriteria":{
"shape":"FindingCriteria",
"documentation":"<p>Represents the criteria used for querying findings. Valid values include:</p> <ul> <li> <p>JSON field name</p> </li> <li> <p>accountId</p> </li> <li> <p>region</p> </li> <li> <p>confidence</p> </li> <li> <p>id</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.outpostArn</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.localIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.archived</p> <p>When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>severity</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: Timestamp in Unix Epoch millisecond format: 1486685375000</p> </li> </ul>",
"documentation":"<p>Represents the criteria used for querying findings. Valid values include:</p> <ul> <li> <p>JSON field name</p> </li> <li> <p>accountId</p> </li> <li> <p>region</p> </li> <li> <p>confidence</p> </li> <li> <p>id</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.archived</p> <p>When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>severity</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: Timestamp in Unix Epoch millisecond format: 1486685375000</p> </li> </ul>",
"locationName":"findingCriteria"
},
"SortCriteria":{
@ -2722,7 +2891,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"locationName":"nextToken"
}
}
@ -2733,12 +2902,12 @@
"members":{
"FindingIds":{
"shape":"FindingIds",
"documentation":"<p>The IDs of the findings you are listing.</p>",
"documentation":"<p>The IDs of the findings that you're listing.</p>",
"locationName":"findingIds"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2749,7 +2918,7 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the ipSet is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the IPSet is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
@ -2761,7 +2930,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2778,7 +2947,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2788,13 +2957,13 @@
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.</p>",
"documentation":"<p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2810,7 +2979,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2833,13 +3002,13 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"OnlyAssociated":{
"shape":"String",
"documentation":"<p>Specifies whether to only return associated members or to return all members (including members which haven't been invited yet or have been disassociated).</p>",
"documentation":"<p>Specifies what member accounts the response includes based on their relationship status with the master account. The default value is \"true\". If set to \"false\" the response includes all existing member accounts (including members who haven't been invited yet or have been disassociated).</p>",
"location":"querystring",
"locationName":"onlyAssociated"
}
@ -2855,7 +3024,39 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
},
"ListOrganizationAdminAccountsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in the response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListOrganizationAdminAccountsResponse":{
"type":"structure",
"members":{
"AdminAccounts":{
"shape":"AdminAccounts",
"documentation":"<p>An AdminAccounts object that includes a list of accounts configured as GuardDuty delegated administrators.</p>",
"locationName":"adminAccounts"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2878,7 +3079,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>",
"documentation":"<p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2890,12 +3091,12 @@
"members":{
"Destinations":{
"shape":"Destinations",
"documentation":"<p>A <code>Destinations</code> obect that includes information about each publishing destination returned.</p>",
"documentation":"<p>A <code>Destinations</code> object that includes information about each publishing destination returned.</p>",
"locationName":"destinations"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>",
"documentation":"<p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the <code>NextToken</code> value returned from the previous request to continue listing results after the first page.</p>",
"locationName":"nextToken"
}
}
@ -2906,7 +3107,7 @@
"members":{
"ResourceArn":{
"shape":"GuardDutyArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the given GuardDuty resource </p>",
"documentation":"<p>The Amazon Resource Name (ARN) for the given GuardDuty resource. </p>",
"location":"uri",
"locationName":"resourceArn"
}
@ -2928,19 +3129,19 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector the threatIntelSet is associated with.</p>",
"documentation":"<p>The unique ID of the detector that the threatIntelSet is associated with.</p>",
"location":"uri",
"locationName":"detectorId"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.</p>",
"documentation":"<p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For 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>You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>",
"location":"querystring",
"locationName":"nextToken"
}
@ -2957,7 +3158,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination parameter to be used on the next list operation to retrieve more items.</p>",
"documentation":"<p>The pagination parameter to be used on the next list operation to retrieve more items.</p>",
"locationName":"nextToken"
}
}
@ -2967,7 +3168,7 @@
"members":{
"IpAddressV4":{
"shape":"String",
"documentation":"<p>IPV4 remote address of the connection.</p>",
"documentation":"<p>The IPv4 local address of the connection.</p>",
"locationName":"ipAddressV4"
}
},
@ -2978,12 +3179,12 @@
"members":{
"Port":{
"shape":"Integer",
"documentation":"<p>Port number of the local connection.</p>",
"documentation":"<p>The port number of the local connection.</p>",
"locationName":"port"
},
"PortName":{
"shape":"String",
"documentation":"<p>Port name of the local connection.</p>",
"documentation":"<p>The port name of the local connection.</p>",
"locationName":"portName"
}
},
@ -3000,12 +3201,12 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the account used as the Master account.</p>",
"documentation":"<p>The ID of the account used as the master account.</p>",
"locationName":"accountId"
},
"InvitationId":{
"shape":"String",
"documentation":"<p>This value is used to validate the master account to the member account.</p>",
"documentation":"<p>The value used to validate the master account to the member account.</p>",
"locationName":"invitationId"
},
"RelationshipStatus":{
@ -3015,11 +3216,11 @@
},
"InvitedAt":{
"shape":"String",
"documentation":"<p>Timestamp at which the invitation was sent.</p>",
"documentation":"<p>The timestamp when the invitation was sent.</p>",
"locationName":"invitedAt"
}
},
"documentation":"<p>Contains information about the Master account and invitation.</p>"
"documentation":"<p>Contains information about the master account and invitation.</p>"
},
"MaxResults":{
"type":"integer",
@ -3038,22 +3239,22 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>Member account ID.</p>",
"documentation":"<p>The ID of the member account.</p>",
"locationName":"accountId"
},
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>Member account's detector ID.</p>",
"documentation":"<p>The detector ID of the member account.</p>",
"locationName":"detectorId"
},
"MasterId":{
"shape":"String",
"documentation":"<p>Master account ID.</p>",
"documentation":"<p>The master account ID.</p>",
"locationName":"masterId"
},
"Email":{
"shape":"Email",
"documentation":"<p>Member account's email address.</p>",
"documentation":"<p>The email address of the member account.</p>",
"locationName":"email"
},
"RelationshipStatus":{
@ -3063,16 +3264,16 @@
},
"InvitedAt":{
"shape":"String",
"documentation":"<p>Timestamp at which the invitation was sent</p>",
"documentation":"<p>The timestamp when the invitation was sent.</p>",
"locationName":"invitedAt"
},
"UpdatedAt":{
"shape":"String",
"documentation":"<p>Member last updated timestamp.</p>",
"documentation":"<p>The last-updated timestamp of the member.</p>",
"locationName":"updatedAt"
}
},
"documentation":"<p>Continas information about the member account </p>"
"documentation":"<p>Contains information about the member account. </p>"
},
"Members":{
"type":"list",
@ -3094,37 +3295,37 @@
"members":{
"Blocked":{
"shape":"Boolean",
"documentation":"<p>Network connection blocked information.</p>",
"documentation":"<p>Indicates whether EC2 blocked the network connection to your instance.</p>",
"locationName":"blocked"
},
"ConnectionDirection":{
"shape":"String",
"documentation":"<p>Network connection direction.</p>",
"documentation":"<p>The network connection direction.</p>",
"locationName":"connectionDirection"
},
"LocalPortDetails":{
"shape":"LocalPortDetails",
"documentation":"<p>Local port information of the connection.</p>",
"documentation":"<p>The local port information of the connection.</p>",
"locationName":"localPortDetails"
},
"Protocol":{
"shape":"String",
"documentation":"<p>Network connection protocol.</p>",
"documentation":"<p>The network connection protocol.</p>",
"locationName":"protocol"
},
"LocalIpDetails":{
"shape":"LocalIpDetails",
"documentation":"<p>Local IP information of the connection.</p>",
"documentation":"<p>The local IP information of the connection.</p>",
"locationName":"localIpDetails"
},
"RemoteIpDetails":{
"shape":"RemoteIpDetails",
"documentation":"<p>Remote IP information of the connection.</p>",
"documentation":"<p>The remote IP information of the connection.</p>",
"locationName":"remoteIpDetails"
},
"RemotePortDetails":{
"shape":"RemotePortDetails",
"documentation":"<p>Remote port information of the connection.</p>",
"documentation":"<p>The remote port information of the connection.</p>",
"locationName":"remotePortDetails"
}
},
@ -3135,22 +3336,22 @@
"members":{
"Ipv6Addresses":{
"shape":"Ipv6Addresses",
"documentation":"<p>A list of EC2 instance IPv6 address information.</p>",
"documentation":"<p>A list of IPv6 addresses for the EC2 instance.</p>",
"locationName":"ipv6Addresses"
},
"NetworkInterfaceId":{
"shape":"String",
"documentation":"<p>The ID of the network interface</p>",
"documentation":"<p>The ID of the network interface.</p>",
"locationName":"networkInterfaceId"
},
"PrivateDnsName":{
"shape":"String",
"documentation":"<p>Private DNS name of the EC2 instance.</p>",
"documentation":"<p>The private DNS name of the EC2 instance.</p>",
"locationName":"privateDnsName"
},
"PrivateIpAddress":{
"shape":"String",
"documentation":"<p>Private IP address of the EC2 instance.</p>",
"documentation":"<p>The private IP address of the EC2 instance.</p>",
"locationName":"privateIpAddress"
},
"PrivateIpAddresses":{
@ -3160,17 +3361,17 @@
},
"PublicDnsName":{
"shape":"String",
"documentation":"<p>Public DNS name of the EC2 instance.</p>",
"documentation":"<p>The public DNS name of the EC2 instance.</p>",
"locationName":"publicDnsName"
},
"PublicIp":{
"shape":"String",
"documentation":"<p>Public IP address of the EC2 instance.</p>",
"documentation":"<p>The public IP address of the EC2 instance.</p>",
"locationName":"publicIp"
},
"SecurityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>Security groups associated with the EC2 instance.</p>",
"documentation":"<p>The security groups associated with the EC2 instance.</p>",
"locationName":"securityGroups"
},
"SubnetId":{
@ -3184,7 +3385,7 @@
"locationName":"vpcId"
}
},
"documentation":"<p>Contains information about the network interface of the Ec2 instance.</p>"
"documentation":"<p>Contains information about the elastic network interface of the EC2 instance.</p>"
},
"NetworkInterfaces":{
"type":"list",
@ -3206,38 +3407,38 @@
"members":{
"Asn":{
"shape":"String",
"documentation":"<p>Autonomous system number of the internet provider of the remote IP address.</p>",
"documentation":"<p>The Autonomous System Number (ASN) of the internet provider of the remote IP address.</p>",
"locationName":"asn"
},
"AsnOrg":{
"shape":"String",
"documentation":"<p>Organization that registered this ASN.</p>",
"documentation":"<p>The organization that registered this ASN.</p>",
"locationName":"asnOrg"
},
"Isp":{
"shape":"String",
"documentation":"<p>ISP information for the internet provider.</p>",
"documentation":"<p>The ISP information for the internet provider.</p>",
"locationName":"isp"
},
"Org":{
"shape":"String",
"documentation":"<p>Name of the internet provider.</p>",
"documentation":"<p>The name of the internet provider.</p>",
"locationName":"org"
}
},
"documentation":"<p>Continas information about the ISP organization of the remote IP address.</p>"
"documentation":"<p>Contains information about the ISP organization of the remote IP address.</p>"
},
"PortProbeAction":{
"type":"structure",
"members":{
"Blocked":{
"shape":"Boolean",
"documentation":"<p>Port probe blocked information.</p>",
"documentation":"<p>Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.</p>",
"locationName":"blocked"
},
"PortProbeDetails":{
"shape":"PortProbeDetails",
"documentation":"<p>A list of port probe details objects.</p>",
"documentation":"<p>A list of objects related to port probe details.</p>",
"locationName":"portProbeDetails"
}
},
@ -3248,17 +3449,17 @@
"members":{
"LocalPortDetails":{
"shape":"LocalPortDetails",
"documentation":"<p>Local port information of the connection.</p>",
"documentation":"<p>The local port information of the connection.</p>",
"locationName":"localPortDetails"
},
"LocalIpDetails":{
"shape":"LocalIpDetails",
"documentation":"<p>Local IP information of the connection.</p>",
"documentation":"<p>The local IP information of the connection.</p>",
"locationName":"localIpDetails"
},
"RemoteIpDetails":{
"shape":"RemoteIpDetails",
"documentation":"<p>Remote IP information of the connection.</p>",
"documentation":"<p>The remote IP information of the connection.</p>",
"locationName":"remoteIpDetails"
}
},
@ -3273,12 +3474,12 @@
"members":{
"PrivateDnsName":{
"shape":"String",
"documentation":"<p>Private DNS name of the EC2 instance.</p>",
"documentation":"<p>The private DNS name of the EC2 instance.</p>",
"locationName":"privateDnsName"
},
"PrivateIpAddress":{
"shape":"String",
"documentation":"<p>Private IP address of the EC2 instance.</p>",
"documentation":"<p>The private IP address of the EC2 instance.</p>",
"locationName":"privateIpAddress"
}
},
@ -3293,16 +3494,16 @@
"members":{
"Code":{
"shape":"String",
"documentation":"<p>Product code information.</p>",
"documentation":"<p>The product code information.</p>",
"locationName":"code"
},
"ProductType":{
"shape":"String",
"documentation":"<p>Product code type.</p>",
"documentation":"<p>The product code type.</p>",
"locationName":"productType"
}
},
"documentation":"<p>Contains information about the product code for the Ec2 instance.</p>"
"documentation":"<p>Contains information about the product code for the EC2 instance.</p>"
},
"ProductCodes":{
"type":"list",
@ -3324,43 +3525,43 @@
"members":{
"City":{
"shape":"City",
"documentation":"<p>City information of the remote IP address.</p>",
"documentation":"<p>The city information of the remote IP address.</p>",
"locationName":"city"
},
"Country":{
"shape":"Country",
"documentation":"<p>Country code of the remote IP address.</p>",
"documentation":"<p>The country code of the remote IP address.</p>",
"locationName":"country"
},
"GeoLocation":{
"shape":"GeoLocation",
"documentation":"<p>Location information of the remote IP address.</p>",
"documentation":"<p>The location information of the remote IP address.</p>",
"locationName":"geoLocation"
},
"IpAddressV4":{
"shape":"String",
"documentation":"<p>IPV4 remote address of the connection.</p>",
"documentation":"<p>The IPv4 remote address of the connection.</p>",
"locationName":"ipAddressV4"
},
"Organization":{
"shape":"Organization",
"documentation":"<p>ISP Organization information of the remote IP address.</p>",
"documentation":"<p>The ISP organization information of the remote IP address.</p>",
"locationName":"organization"
}
},
"documentation":"<p>Continas information about the remote IP address of the connection.</p>"
"documentation":"<p>Contains information about the remote IP address of the connection.</p>"
},
"RemotePortDetails":{
"type":"structure",
"members":{
"Port":{
"shape":"Integer",
"documentation":"<p>Port number of the remote connection.</p>",
"documentation":"<p>The port number of the remote connection.</p>",
"locationName":"port"
},
"PortName":{
"shape":"String",
"documentation":"<p>Port name of the remote connection.</p>",
"documentation":"<p>The port name of the remote connection.</p>",
"locationName":"portName"
}
},
@ -3381,7 +3582,7 @@
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The type of the AWS resource.</p>",
"documentation":"<p>The type of AWS resource.</p>",
"locationName":"resourceType"
}
},
@ -3392,12 +3593,12 @@
"members":{
"GroupId":{
"shape":"String",
"documentation":"<p>EC2 instance's security group ID.</p>",
"documentation":"<p>The security group ID of the EC2 instance.</p>",
"locationName":"groupId"
},
"GroupName":{
"shape":"String",
"documentation":"<p>EC2 instance's security group name.</p>",
"documentation":"<p>The security group name of the EC2 instance.</p>",
"locationName":"groupName"
}
},
@ -3412,7 +3613,7 @@
"members":{
"Action":{
"shape":"Action",
"documentation":"<p>Information about the activity described in a finding.</p>",
"documentation":"<p>Information about the activity that is described in a finding.</p>",
"locationName":"action"
},
"Evidence":{
@ -3427,27 +3628,27 @@
},
"Count":{
"shape":"Integer",
"documentation":"<p>Total count of the occurrences of this finding type.</p>",
"documentation":"<p>The total count of the occurrences of this finding type.</p>",
"locationName":"count"
},
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>Detector ID for the GuardDuty service.</p>",
"documentation":"<p>The detector ID for the GuardDuty service.</p>",
"locationName":"detectorId"
},
"EventFirstSeen":{
"shape":"String",
"documentation":"<p>First seen timestamp of the activity that prompted GuardDuty to generate this finding.</p>",
"documentation":"<p>The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.</p>",
"locationName":"eventFirstSeen"
},
"EventLastSeen":{
"shape":"String",
"documentation":"<p>Last seen timestamp of the activity that prompted GuardDuty to generate this finding.</p>",
"documentation":"<p>The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.</p>",
"locationName":"eventLastSeen"
},
"ResourceRole":{
"shape":"String",
"documentation":"<p>Resource role information for this finding.</p>",
"documentation":"<p>The resource role information for this finding.</p>",
"locationName":"resourceRole"
},
"ServiceName":{
@ -3457,7 +3658,7 @@
},
"UserFeedback":{
"shape":"String",
"documentation":"<p>Feedback left about the finding.</p>",
"documentation":"<p>Feedback that was submitted about the finding.</p>",
"locationName":"userFeedback"
}
},
@ -3468,12 +3669,12 @@
"members":{
"AttributeName":{
"shape":"String",
"documentation":"<p>Represents the finding attribute (for example, accountId) by which to sort findings.</p>",
"documentation":"<p>Represents the finding attribute (for example, accountId) to sort findings by.</p>",
"locationName":"attributeName"
},
"OrderBy":{
"shape":"OrderBy",
"documentation":"<p>Order by which the sorted findings are to be displayed.</p>",
"documentation":"<p>The order by which the sorted findings are to be displayed.</p>",
"locationName":"orderBy"
}
},
@ -3505,7 +3706,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.</p>",
"locationName":"unprocessedAccounts"
}
}
@ -3519,13 +3720,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.</p>",
"documentation":"<p>The unique ID of the detector associated with the GuardDuty master account that is monitoring member accounts.</p>",
"location":"uri",
"locationName":"detectorId"
},
"AccountIds":{
"shape":"AccountIds",
"documentation":"<p>A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring.</p>",
"documentation":"<p>A list of account IDs for the member accounts to stop monitoring.</p>",
"locationName":"accountIds"
}
}
@ -3536,7 +3737,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"UnprocessedAccounts",
"documentation":"<p>A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.</p>",
"documentation":"<p>A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed. </p>",
"locationName":"unprocessedAccounts"
}
}
@ -3547,16 +3748,16 @@
"members":{
"Key":{
"shape":"String",
"documentation":"<p>EC2 instance tag key.</p>",
"documentation":"<p>The EC2 instance tag key.</p>",
"locationName":"key"
},
"Value":{
"shape":"String",
"documentation":"<p>EC2 instance tag value.</p>",
"documentation":"<p>The EC2 instance tag value.</p>",
"locationName":"value"
}
},
"documentation":"<p>Contains information about a tag associated with the Ec2 instance.</p>"
"documentation":"<p>Contains information about a tag associated with the EC2 instance.</p>"
},
"TagKey":{
"type":"string",
@ -3682,7 +3883,7 @@
},
"FindingIds":{
"shape":"FindingIds",
"documentation":"<p>IDs of the findings to unarchive.</p>",
"documentation":"<p>The IDs of the findings to unarchive.</p>",
"locationName":"findingIds"
}
}
@ -3701,7 +3902,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>AWS Account ID.</p>",
"documentation":"<p>The AWS account ID.</p>",
"locationName":"accountId"
},
"Result":{
@ -3710,7 +3911,7 @@
"locationName":"result"
}
},
"documentation":"<p>Contains information about the accounts that were not processed.</p>"
"documentation":"<p>Contains information about the accounts that weren't processed.</p>"
},
"UnprocessedAccounts":{
"type":"list",
@ -3761,7 +3962,7 @@
},
"FindingPublishingFrequency":{
"shape":"FindingPublishingFrequency",
"documentation":"<p>A enum value that specifies how frequently findings are exported, such as to CloudWatch Events.</p>",
"documentation":"<p>An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.</p>",
"locationName":"findingPublishingFrequency"
}
}
@ -3839,7 +4040,7 @@
},
"FindingIds":{
"shape":"FindingIds",
"documentation":"<p>IDs of the findings that you want to mark as useful or not useful.</p>",
"documentation":"<p>The IDs of the findings that you want to mark as useful or not useful.</p>",
"locationName":"findingIds"
},
"Feedback":{
@ -3885,12 +4086,12 @@
},
"Location":{
"shape":"Location",
"documentation":"<p>The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).</p>",
"documentation":"<p>The updated URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.</p>",
"locationName":"location"
},
"Activate":{
"shape":"Boolean",
"documentation":"<p>The updated boolean value that specifies whether the IPSet is active or not.</p>",
"documentation":"<p>The updated Boolean value that specifies whether the IPSet is active or not.</p>",
"locationName":"activate"
}
}
@ -3900,6 +4101,31 @@
"members":{
}
},
"UpdateOrganizationConfigurationRequest":{
"type":"structure",
"required":[
"DetectorId",
"AutoEnable"
],
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The ID of the detector to update the delegated administrator for.</p>",
"location":"uri",
"locationName":"detectorId"
},
"AutoEnable":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to automatically enable member accounts in the organization.</p>",
"locationName":"autoEnable"
}
}
},
"UpdateOrganizationConfigurationResponse":{
"type":"structure",
"members":{
}
},
"UpdatePublishingDestinationRequest":{
"type":"structure",
"required":[
@ -3909,13 +4135,13 @@
"members":{
"DetectorId":{
"shape":"DetectorId",
"documentation":"<p>The ID of the </p>",
"documentation":"<p>The ID of the detector associated with the publishing destinations to update.</p>",
"location":"uri",
"locationName":"detectorId"
},
"DestinationId":{
"shape":"String",
"documentation":"<p>The ID of the detector associated with the publishing destinations to update.</p>",
"documentation":"<p>The ID of the publishing destination to update.</p>",
"location":"uri",
"locationName":"destinationId"
},
@ -3957,12 +4183,12 @@
},
"Location":{
"shape":"Location",
"documentation":"<p>The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)</p>",
"documentation":"<p>The updated URI of the file that contains the ThreateIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.</p>",
"locationName":"location"
},
"Activate":{
"shape":"Boolean",
"documentation":"<p>The updated boolean value that specifies whether the ThreateIntelSet is active or not.</p>",
"documentation":"<p>The updated Boolean value that specifies whether the ThreateIntelSet is active or not.</p>",
"locationName":"activate"
}
}
@ -3973,5 +4199,5 @@
}
}
},
"documentation":"<p>Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html\">Amazon GuardDuty User Guide</a>. </p>"
"documentation":"<p>Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances that serve malware or mine bitcoin. </p> <p>GuardDuty also monitors AWS account access behavior for signs of compromise. Some examples of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength. </p> <p>GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see the <i> <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html\">Amazon GuardDuty User Guide</a> </i>. </p>"
}

View file

@ -849,7 +849,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 AWS 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 AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS 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 AWS service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt. </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 AWS 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, AWS Organizations policies, IAM permissions boundaries, and AWS 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 last accessed data, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html\">Reducing Policy Scope by Viewing User Activity</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 AWS 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 AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS 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 AWS 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 AWS 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, AWS Organizations policies, IAM permissions boundaries, and AWS 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 last accessed data, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html\">Reducing Policy Scope by Viewing User Activity</a> in the <i>IAM User Guide</i>.</p>"
},
"GetAccessKeyLastUsed":{
"name":"GetAccessKeyLastUsed",
@ -2598,7 +2598,7 @@
"documentation":"<p>The data type of the value (or values) specified in the <code>ContextKeyValues</code> parameter.</p>"
}
},
"documentation":"<p>Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the <code>Condition</code> elements of the input policies.</p> <p>This data type is used as an input parameter to <code> <a>SimulateCustomPolicy</a> </code> and <code> <a>SimulatePrincipalPolicy</a> </code>.</p>"
"documentation":"<p>Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the <code>Condition</code> elements of the input policies.</p> <p>This data type is used as an input parameter to <a>SimulateCustomPolicy</a> and <a>SimulatePrincipalPolicy</a>.</p>"
},
"ContextEntryListType":{
"type":"list",
@ -3717,7 +3717,7 @@
"members":{
"JobId":{
"shape":"jobIDType",
"documentation":"<p>The job ID that you can use in the <a>GetServiceLastAccessedDetails</a> or <a>GetServiceLastAccessedDetailsWithEntities</a> operations.</p>"
"documentation":"<p>The <code>JobId</code> that you can use in the <a>GetServiceLastAccessedDetails</a> or <a>GetServiceLastAccessedDetailsWithEntities</a> operations. 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>"
}
}
},
@ -4282,7 +4282,7 @@
"members":{
"JobId":{
"shape":"jobIDType",
"documentation":"<p>The ID of the request generated by the <a>GenerateServiceLastAccessedDetails</a> operation.</p>"
"documentation":"<p>The ID of the request generated by the <a>GenerateServiceLastAccessedDetails</a> operation. 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>"
},
"MaxItems":{
"shape":"maxItemsType",

View file

@ -664,7 +664,7 @@
{"shape":"ForbiddenException"},
{"shape":"CallRateLimitExceededException"}
],
"documentation":"<p> Applies a policy to a component. </p>"
"documentation":"<p> Applies a policy to a component. We recommend that you call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html\">CreateResourceShare</a> to share resources. If you call the Image Builder API <code>PutComponentPolicy</code>, you must also call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html\">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared. </p>"
},
"PutImagePolicy":{
"name":"PutImagePolicy",
@ -684,7 +684,7 @@
{"shape":"ForbiddenException"},
{"shape":"CallRateLimitExceededException"}
],
"documentation":"<p> Applies a policy to an image. </p>"
"documentation":"<p>Applies a policy to an image. We recommend that you call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html\">CreateResourceShare</a> to share resources. If you call the Image Builder API <code>PutImagePolicy</code>, you must also call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html\">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared. </p>"
},
"PutImageRecipePolicy":{
"name":"PutImageRecipePolicy",
@ -704,7 +704,7 @@
{"shape":"ForbiddenException"},
{"shape":"CallRateLimitExceededException"}
],
"documentation":"<p> Applies a policy to an image recipe. </p>"
"documentation":"<p> Applies a policy to an image recipe. We recommend that you call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html\">CreateResourceShare</a> to share resources. If you call the Image Builder API <code>PutImageRecipePolicy</code>, you must also call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html\">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared. </p>"
},
"StartImagePipelineExecution":{
"name":"StartImagePipelineExecution",
@ -829,19 +829,19 @@
"members":{
"region":{
"shape":"NonEmptyString",
"documentation":"<p> The AWS Region of the EC2 AMI. </p>"
"documentation":"<p>The AWS Region of the EC2 AMI. </p>"
},
"image":{
"shape":"NonEmptyString",
"documentation":"<p> The AMI ID of the EC2 AMI. </p>"
"documentation":"<p>The AMI ID of the EC2 AMI. </p>"
},
"name":{
"shape":"NonEmptyString",
"documentation":"<p> The name of the EC2 AMI. </p>"
"documentation":"<p>The name of the EC2 AMI. </p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the EC2 AMI. </p>"
"documentation":"<p>The description of the EC2 AMI. </p>"
},
"state":{"shape":"ImageState"}
},
@ -852,15 +852,15 @@
"members":{
"name":{
"shape":"AmiNameString",
"documentation":"<p> The name of the distribution configuration. </p>"
"documentation":"<p>The name of the distribution configuration. </p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the distribution configuration. </p>"
"documentation":"<p>The description of the distribution configuration. </p>"
},
"amiTags":{
"shape":"TagMap",
"documentation":"<p> The tags to apply to AMIs distributed to this Region. </p>"
"documentation":"<p>The tags to apply to AMIs distributed to this Region. </p>"
},
"launchPermission":{
"shape":"LaunchPermissionConfiguration",
@ -1010,7 +1010,7 @@
"members":{
"componentArn":{
"shape":"ComponentVersionArnOrBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the component. </p>"
}
},
"documentation":"<p> Configuration details of the component. </p>"
@ -1282,6 +1282,10 @@
"shape":"ImageTestsConfiguration",
"documentation":"<p> The image test configuration of the image pipeline. </p>"
},
"enhancedImageMetadataEnabled":{
"shape":"NullableBoolean",
"documentation":"<p> Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. </p>"
},
"schedule":{
"shape":"Schedule",
"documentation":"<p> The schedule of the image pipeline. </p>"
@ -1338,19 +1342,19 @@
},
"semanticVersion":{
"shape":"VersionNumber",
"documentation":"<p> The semantic version of the image recipe. </p>"
"documentation":"<p>The semantic version of the image recipe. </p>"
},
"components":{
"shape":"ComponentConfigurationList",
"documentation":"<p> The components of the image recipe. </p>"
"documentation":"<p>The components of the image recipe. </p>"
},
"parentImage":{
"shape":"NonEmptyString",
"documentation":"<p> The parent image of the image recipe. </p>"
"documentation":"<p>The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: <code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x</code>. The ARN ends with <code>/20xx.x.x</code>, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder. </p>"
},
"blockDeviceMappings":{
"shape":"InstanceBlockDeviceMappings",
"documentation":"<p> The block device mappings of the image recipe. </p>"
"documentation":"<p>The block device mappings of the image recipe. </p>"
},
"tags":{
"shape":"TagMap",
@ -1358,7 +1362,7 @@
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>",
"documentation":"<p>The idempotency token used to make this request idempotent. </p>",
"idempotencyToken":true
}
}
@ -1368,15 +1372,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>"
"documentation":"<p>The idempotency token used to make this request idempotent. </p>"
},
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that was created by this request. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe that was created by this request. </p>"
}
}
},
@ -1404,6 +1408,10 @@
"shape":"ImageTestsConfiguration",
"documentation":"<p> The image tests configuration of the image. </p>"
},
"enhancedImageMetadataEnabled":{
"shape":"NullableBoolean",
"documentation":"<p> Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. </p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p> The tags of the image. </p>"
@ -1442,51 +1450,51 @@
"members":{
"name":{
"shape":"ResourceName",
"documentation":"<p> The name of the infrastructure configuration. </p>"
"documentation":"<p>The name of the infrastructure configuration. </p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the infrastructure configuration. </p>"
"documentation":"<p>The description of the infrastructure configuration. </p>"
},
"instanceTypes":{
"shape":"InstanceTypeList",
"documentation":"<p> The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability. </p>"
"documentation":"<p>The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability. </p>"
},
"instanceProfileName":{
"shape":"NonEmptyString",
"documentation":"<p> The instance profile to associate with the instance used to customize your EC2 AMI. </p>"
"documentation":"<p>The instance profile to associate with the instance used to customize your EC2 AMI. </p>"
},
"securityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p> The security group IDs to associate with the instance used to customize your EC2 AMI. </p>"
"documentation":"<p>The security group IDs to associate with the instance used to customize your EC2 AMI. </p>"
},
"subnetId":{
"shape":"NonEmptyString",
"documentation":"<p> The subnet ID in which to place the instance used to customize your EC2 AMI. </p>"
"documentation":"<p>The subnet ID in which to place the instance used to customize your EC2 AMI. </p>"
},
"logging":{
"shape":"Logging",
"documentation":"<p> The logging configuration of the infrastructure configuration. </p>"
"documentation":"<p>The logging configuration of the infrastructure configuration. </p>"
},
"keyPair":{
"shape":"NonEmptyString",
"documentation":"<p> The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>"
"documentation":"<p>The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>"
},
"terminateInstanceOnFailure":{
"shape":"NullableBoolean",
"documentation":"<p> The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. </p>"
"documentation":"<p>The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. </p>"
},
"snsTopicArn":{
"shape":"SnsTopicArn",
"documentation":"<p> The SNS topic on which to send image build events. </p>"
"documentation":"<p>The SNS topic on which to send image build events. </p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p> The tags of the infrastructure configuration. </p>"
"documentation":"<p>The tags of the infrastructure configuration. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>",
"documentation":"<p>The idempotency token used to make this request idempotent. </p>",
"idempotencyToken":true
}
}
@ -1496,15 +1504,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>"
"documentation":"<p>The idempotency token used to make this request idempotent. </p>"
},
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request. </p>"
}
}
},
@ -1515,7 +1523,7 @@
"members":{
"componentBuildVersionArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component build version to delete. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the component build version to delete. </p>",
"location":"querystring",
"locationName":"componentBuildVersionArn"
}
@ -1526,11 +1534,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"componentBuildVersionArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component build version that was deleted. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the component build version that was deleted. </p>"
}
}
},
@ -1540,7 +1548,7 @@
"members":{
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration to delete. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the distribution configuration to delete. </p>",
"location":"querystring",
"locationName":"distributionConfigurationArn"
}
@ -1551,11 +1559,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that was deleted. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the distribution configuration that was deleted. </p>"
}
}
},
@ -1565,7 +1573,7 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline to delete. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline to delete. </p>",
"location":"querystring",
"locationName":"imagePipelineArn"
}
@ -1576,11 +1584,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that was deleted. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline that was deleted. </p>"
}
}
},
@ -1590,7 +1598,7 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe to delete. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe to delete. </p>",
"location":"querystring",
"locationName":"imageRecipeArn"
}
@ -1601,11 +1609,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that was deleted. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe that was deleted. </p>"
}
}
},
@ -1615,7 +1623,7 @@
"members":{
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image to delete. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image to delete. </p>",
"location":"querystring",
"locationName":"imageBuildVersionArn"
}
@ -1626,11 +1634,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that was deleted. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image that was deleted. </p>"
}
}
},
@ -1640,7 +1648,7 @@
"members":{
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration to delete. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration to delete. </p>",
"location":"querystring",
"locationName":"infrastructureConfigurationArn"
}
@ -1651,11 +1659,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted. </p>"
}
}
},
@ -1665,15 +1673,15 @@
"members":{
"region":{
"shape":"NonEmptyString",
"documentation":"<p> The target Region. </p>"
"documentation":"<p>The target Region. </p>"
},
"amiDistributionConfiguration":{
"shape":"AmiDistributionConfiguration",
"documentation":"<p> The specific AMI settings (for example, launch permissions, AMI tags). </p>"
"documentation":"<p>The specific AMI settings (for example, launch permissions, AMI tags). </p>"
},
"licenseConfigurationArns":{
"shape":"ArnList",
"documentation":"<p> The License Manager Configuration to associate with the AMI in the specified Region.</p>"
"documentation":"<p>The License Manager Configuration to associate with the AMI in the specified Region.</p>"
}
},
"documentation":"<p> Defines the settings for a specific Region. </p>"
@ -1829,14 +1837,14 @@
"members":{
"name":{
"shape":"FilterName",
"documentation":"<p> The name of the filter. Filter names are case-sensitive. </p>"
"documentation":"<p>The name of the filter. Filter names are case-sensitive. </p>"
},
"values":{
"shape":"FilterValues",
"documentation":"<p> The filter values. Filter values are case-sensitive. </p>"
"documentation":"<p>The filter values. Filter values are case-sensitive. </p>"
}
},
"documentation":"<p> A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. </p>"
"documentation":"<p>A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. </p>"
},
"FilterList":{
"type":"list",
@ -1873,7 +1881,7 @@
"members":{
"componentArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component whose policy you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the component whose policy you want to retrieve. </p>",
"location":"querystring",
"locationName":"componentArn"
}
@ -1884,11 +1892,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"policy":{
"shape":"ResourcePolicyDocument",
"documentation":"<p> The component policy. </p>"
"documentation":"<p>The component policy. </p>"
}
}
},
@ -1898,7 +1906,7 @@
"members":{
"componentBuildVersionArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.</p>",
"location":"querystring",
"locationName":"componentBuildVersionArn"
}
@ -1909,11 +1917,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"component":{
"shape":"Component",
"documentation":"<p> The component object associated with the specified ARN. </p>"
"documentation":"<p>The component object associated with the specified ARN. </p>"
}
}
},
@ -1923,7 +1931,7 @@
"members":{
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve. </p>",
"location":"querystring",
"locationName":"distributionConfigurationArn"
}
@ -1934,11 +1942,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"distributionConfiguration":{
"shape":"DistributionConfiguration",
"documentation":"<p> The distribution configuration object. </p>"
"documentation":"<p>The distribution configuration object. </p>"
}
}
},
@ -1948,7 +1956,7 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve. </p>",
"location":"querystring",
"locationName":"imagePipelineArn"
}
@ -1959,11 +1967,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imagePipeline":{
"shape":"ImagePipeline",
"documentation":"<p> The image pipeline object. </p>"
"documentation":"<p>The image pipeline object. </p>"
}
}
},
@ -1973,7 +1981,7 @@
"members":{
"imageArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image whose policy you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image whose policy you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageArn"
}
@ -1984,11 +1992,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"policy":{
"shape":"ResourcePolicyDocument",
"documentation":"<p> The image policy object. </p>"
"documentation":"<p>The image policy object. </p>"
}
}
},
@ -1998,7 +2006,7 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageRecipeArn"
}
@ -2009,11 +2017,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"policy":{
"shape":"ResourcePolicyDocument",
"documentation":"<p> The image recipe policy object. </p>"
"documentation":"<p>The image recipe policy object. </p>"
}
}
},
@ -2023,7 +2031,7 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageRecipeArn"
}
@ -2034,11 +2042,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageRecipe":{
"shape":"ImageRecipe",
"documentation":"<p> The image recipe object. </p>"
"documentation":"<p>The image recipe object. </p>"
}
}
},
@ -2048,7 +2056,7 @@
"members":{
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the image that you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageBuildVersionArn"
}
@ -2059,11 +2067,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"image":{
"shape":"Image",
"documentation":"<p> The image object. </p>"
"documentation":"<p>The image object. </p>"
}
}
},
@ -2085,11 +2093,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"infrastructureConfiguration":{
"shape":"InfrastructureConfiguration",
"documentation":"<p> The infrastructure configuration object. </p>"
"documentation":"<p>The infrastructure configuration object. </p>"
}
},
"documentation":"<p>GetInfrastructureConfiguration response object. </p>"
@ -2122,6 +2130,14 @@
"shape":"Platform",
"documentation":"<p>The platform of the image.</p>"
},
"enhancedImageMetadataEnabled":{
"shape":"NullableBoolean",
"documentation":"<p> Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. </p>"
},
"osVersion":{
"shape":"OsVersion",
"documentation":"<p>The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. </p>"
},
"state":{
"shape":"ImageState",
"documentation":"<p>The state of the image.</p>"
@ -2140,7 +2156,7 @@
},
"infrastructureConfiguration":{
"shape":"InfrastructureConfiguration",
"documentation":"<p> The infrastructure used when creating this image.</p>"
"documentation":"<p>The infrastructure used when creating this image.</p>"
},
"distributionConfiguration":{
"shape":"DistributionConfiguration",
@ -2192,6 +2208,10 @@
"shape":"Platform",
"documentation":"<p>The platform of the image pipeline.</p>"
},
"enhancedImageMetadataEnabled":{
"shape":"NullableBoolean",
"documentation":"<p> Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. </p>"
},
"imageRecipeArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.</p>"
@ -2344,11 +2364,11 @@
"members":{
"status":{
"shape":"ImageStatus",
"documentation":"<p> The status of the image. </p>"
"documentation":"<p>The status of the image. </p>"
},
"reason":{
"shape":"NonEmptyString",
"documentation":"<p> The reason for the image's status. </p>"
"documentation":"<p>The reason for the image's status. </p>"
}
},
"documentation":"<p> Image state shows the image status and the reason for that status. </p>"
@ -2388,6 +2408,10 @@
"shape":"Platform",
"documentation":"<p>The platform of the image.</p>"
},
"osVersion":{
"shape":"OsVersion",
"documentation":"<p>The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. </p>"
},
"state":{
"shape":"ImageState",
"documentation":"<p>The state of the image.</p>"
@ -2453,6 +2477,10 @@
"shape":"Platform",
"documentation":"<p>The platform of the image semantic version.</p>"
},
"osVersion":{
"shape":"OsVersion",
"documentation":"<p> The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019. </p>"
},
"owner":{
"shape":"NonEmptyString",
"documentation":"<p>The owner of the image semantic version.</p>"
@ -2497,7 +2525,7 @@
},
"changeDescription":{
"shape":"NonEmptyString",
"documentation":"<p> The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component. </p>"
"documentation":"<p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component. </p>"
},
"type":{
"shape":"ComponentType",
@ -2505,11 +2533,11 @@
},
"format":{
"shape":"ComponentFormat",
"documentation":"<p> The format of the resource that you want to import as a component. </p>"
"documentation":"<p>The format of the resource that you want to import as a component. </p>"
},
"platform":{
"shape":"Platform",
"documentation":"<p> The platform of the component. </p>"
"documentation":"<p>The platform of the component. </p>"
},
"data":{
"shape":"NonEmptyString",
@ -2521,15 +2549,15 @@
},
"kmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p> The ID of the KMS key that should be used to encrypt this component. </p>"
"documentation":"<p>The ID of the KMS key that should be used to encrypt this component. </p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p> The tags of the component. </p>"
"documentation":"<p>The tags of the component. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token of the component. </p>",
"documentation":"<p>The idempotency token of the component. </p>",
"idempotencyToken":true
}
}
@ -2539,15 +2567,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>"
"documentation":"<p>The idempotency token used to make this request idempotent. </p>"
},
"componentBuildVersionArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the imported component. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the imported component. </p>"
}
}
},
@ -2746,7 +2774,7 @@
"members":{
"userIds":{
"shape":"AccountList",
"documentation":"<p> The AWS account ID. </p>"
"documentation":"<p>The AWS account ID. </p>"
},
"userGroups":{
"shape":"StringList",
@ -2761,16 +2789,16 @@
"members":{
"componentVersionArn":{
"shape":"ComponentVersionArn",
"documentation":"<p> The component version Amazon Resource Name (ARN) whose versions you want to list. </p>"
"documentation":"<p>The component version Amazon Resource Name (ARN) whose versions you want to list. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -2779,15 +2807,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"componentSummaryList":{
"shape":"ComponentSummaryList",
"documentation":"<p> The list of component summaries for the specified semantic version. </p>"
"documentation":"<p>The list of component summaries for the specified semantic version. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2796,20 +2824,20 @@
"members":{
"owner":{
"shape":"Ownership",
"documentation":"<p> The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers. </p>"
"documentation":"<p>The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -2818,15 +2846,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"componentVersionList":{
"shape":"ComponentVersionList",
"documentation":"<p> The list of component semantic versions. </p>"
"documentation":"<p>The list of component semantic versions. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2835,16 +2863,16 @@
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -2853,15 +2881,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"distributionConfigurationSummaryList":{
"shape":"DistributionConfigurationSummaryList",
"documentation":"<p> The list of distributions. </p>"
"documentation":"<p>The list of distributions. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2871,20 +2899,20 @@
"members":{
"imageVersionArn":{
"shape":"ImageVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -2893,15 +2921,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageSummaryList":{
"shape":"ImageSummaryList",
"documentation":"<p> The list of image build versions. </p>"
"documentation":"<p>The list of image build versions. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2911,20 +2939,20 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline whose images you want to view. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline whose images you want to view. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -2933,15 +2961,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageSummaryList":{
"shape":"ImageSummaryList",
"documentation":"<p> The list of images built by this pipeline. </p>"
"documentation":"<p>The list of images built by this pipeline. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2950,16 +2978,16 @@
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -2968,15 +2996,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imagePipelineList":{
"shape":"ImagePipelineList",
"documentation":"<p> The list of image pipelines. </p>"
"documentation":"<p>The list of image pipelines. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2985,20 +3013,20 @@
"members":{
"owner":{
"shape":"Ownership",
"documentation":"<p> The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers. </p>"
"documentation":"<p>The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -3007,15 +3035,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageRecipeSummaryList":{
"shape":"ImageRecipeSummaryList",
"documentation":"<p> The list of image pipelines. </p>"
"documentation":"<p>The list of image pipelines. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -3024,20 +3052,20 @@
"members":{
"owner":{
"shape":"Ownership",
"documentation":"<p> The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers. </p>"
"documentation":"<p>The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -3046,15 +3074,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageVersionList":{
"shape":"ImageVersionList",
"documentation":"<p> The list of image semantic versions. </p>"
"documentation":"<p>The list of image semantic versions. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -3063,16 +3091,16 @@
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p> The filters. </p>"
"documentation":"<p>The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p> The maximum items to return in a request. </p>",
"documentation":"<p>The maximum items to return in a request. </p>",
"box":true
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response. </p>"
}
}
},
@ -3081,15 +3109,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"infrastructureConfigurationSummaryList":{
"shape":"InfrastructureConfigurationSummaryList",
"documentation":"<p> The list of infrastructure configurations. </p>"
"documentation":"<p>The list of infrastructure configurations. </p>"
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.</p>"
"documentation":"<p>The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.</p>"
}
}
},
@ -3099,7 +3127,7 @@
"members":{
"resourceArn":{
"shape":"ImageBuilderArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. </p>",
"location":"uri",
"locationName":"resourceArn"
}
@ -3110,7 +3138,7 @@
"members":{
"tags":{
"shape":"TagMap",
"documentation":"<p> The tags for the specified resource. </p>"
"documentation":"<p>The tags for the specified resource. </p>"
}
}
},
@ -3130,6 +3158,10 @@
"min":1
},
"NullableBoolean":{"type":"boolean"},
"OsVersion":{
"type":"string",
"min":1
},
"OutputResources":{
"type":"structure",
"members":{
@ -3178,11 +3210,11 @@
"members":{
"componentArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component that this policy should be applied to. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the component that this policy should be applied to. </p>"
},
"policy":{
"shape":"ResourcePolicyDocument",
"documentation":"<p> The policy to apply. </p>"
"documentation":"<p>The policy to apply. </p>"
}
}
},
@ -3191,11 +3223,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"componentArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component that this policy was applied to. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the component that this policy was applied to. </p>"
}
}
},
@ -3208,11 +3240,11 @@
"members":{
"imageArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that this policy should be applied to. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image that this policy should be applied to. </p>"
},
"policy":{
"shape":"ResourcePolicyDocument",
"documentation":"<p> The policy to apply. </p>"
"documentation":"<p>The policy to apply. </p>"
}
}
},
@ -3221,11 +3253,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that this policy was applied to. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image that this policy was applied to. </p>"
}
}
},
@ -3238,11 +3270,11 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to. </p>"
},
"policy":{
"shape":"ResourcePolicyDocument",
"documentation":"<p> The policy to apply. </p>"
"documentation":"<p>The policy to apply. </p>"
}
}
},
@ -3251,11 +3283,11 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that this policy was applied to. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe that this policy was applied to. </p>"
}
}
},
@ -3328,14 +3360,14 @@
"members":{
"scheduleExpression":{
"shape":"NonEmptyString",
"documentation":"<p> The expression determines how often EC2 Image Builder evaluates your <code>pipelineExecutionStartCondition</code>.</p>"
"documentation":"<p>The expression determines how often EC2 Image Builder evaluates your <code>pipelineExecutionStartCondition</code>.</p>"
},
"pipelineExecutionStartCondition":{
"shape":"PipelineExecutionStartCondition",
"documentation":"<p> The condition configures when the pipeline should trigger a new image build. When the <code>pipelineExecutionStartCondition</code> is set to <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to <code>EXPRESSION_MATCH_ONLY</code>, it will build a new image every time the CRON expression matches the current time.</p>"
"documentation":"<p>The condition configures when the pipeline should trigger a new image build. When the <code>pipelineExecutionStartCondition</code> is set to <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to <code>EXPRESSION_MATCH_ONLY</code>, it will build a new image every time the CRON expression matches the current time.</p>"
}
},
"documentation":"<p> A schedule configures how often and when a pipeline will automatically create a new image. </p>"
"documentation":"<p>A schedule configures how often and when a pipeline will automatically create a new image. </p>"
},
"SecurityGroupIds":{
"type":"list",
@ -3372,11 +3404,11 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>",
"documentation":"<p>The idempotency token used to make this request idempotent. </p>",
"idempotencyToken":true
}
}
@ -3386,15 +3418,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent.</p>"
"documentation":"<p>The idempotency token used to make this request idempotent.</p>"
},
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that was created by this request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image that was created by this request.</p>"
}
}
},
@ -3430,13 +3462,13 @@
"members":{
"resourceArn":{
"shape":"ImageBuilderArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource that you want to tag. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to tag. </p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"<p> The tags to apply to the resource. </p>"
"documentation":"<p>The tags to apply to the resource. </p>"
}
}
},
@ -3458,13 +3490,13 @@
"members":{
"resourceArn":{
"shape":"ImageBuilderArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource that you want to untag. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to untag. </p>",
"location":"uri",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p> The tag keys to remove from the resource. </p>",
"documentation":"<p>The tag keys to remove from the resource. </p>",
"location":"querystring",
"locationName":"tagKeys"
}
@ -3485,19 +3517,19 @@
"members":{
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that you want to update. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the distribution configuration that you want to update. </p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the distribution configuration. </p>"
"documentation":"<p>The description of the distribution configuration. </p>"
},
"distributions":{
"shape":"DistributionList",
"documentation":"<p> The distributions of the distribution configuration. </p>"
"documentation":"<p>The distributions of the distribution configuration. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token of the distribution configuration. </p>",
"documentation":"<p>The idempotency token of the distribution configuration. </p>",
"idempotencyToken":true
}
}
@ -3507,15 +3539,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>"
"documentation":"<p>The idempotency token used to make this request idempotent. </p>"
},
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request. </p>"
}
}
},
@ -3530,39 +3562,43 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you want to update. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline that you want to update. </p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the image pipeline. </p>"
"documentation":"<p>The description of the image pipeline. </p>"
},
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline. </p>"
},
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline. </p>"
},
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline. </p>"
},
"imageTestsConfiguration":{
"shape":"ImageTestsConfiguration",
"documentation":"<p> The image test configuration of the image pipeline. </p>"
"documentation":"<p>The image test configuration of the image pipeline. </p>"
},
"enhancedImageMetadataEnabled":{
"shape":"NullableBoolean",
"documentation":"<p> Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default. </p>"
},
"schedule":{
"shape":"Schedule",
"documentation":"<p> The schedule of the image pipeline. </p>"
"documentation":"<p>The schedule of the image pipeline. </p>"
},
"status":{
"shape":"PipelineStatus",
"documentation":"<p> The status of the image pipeline. </p>"
"documentation":"<p>The status of the image pipeline. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>",
"documentation":"<p>The idempotency token used to make this request idempotent. </p>",
"idempotencyToken":true
}
}
@ -3572,15 +3608,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>"
"documentation":"<p>The idempotency token used to make this request idempotent. </p>"
},
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that was updated by this request. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image pipeline that was updated by this request. </p>"
}
}
},
@ -3594,47 +3630,47 @@
"members":{
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update. </p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the infrastructure configuration. </p>"
"documentation":"<p>The description of the infrastructure configuration. </p>"
},
"instanceTypes":{
"shape":"InstanceTypeList",
"documentation":"<p> The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability. </p>"
"documentation":"<p>The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability. </p>"
},
"instanceProfileName":{
"shape":"NonEmptyString",
"documentation":"<p> The instance profile to associate with the instance used to customize your EC2 AMI. </p>"
"documentation":"<p>The instance profile to associate with the instance used to customize your EC2 AMI. </p>"
},
"securityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p> The security group IDs to associate with the instance used to customize your EC2 AMI. </p>"
"documentation":"<p>The security group IDs to associate with the instance used to customize your EC2 AMI. </p>"
},
"subnetId":{
"shape":"NonEmptyString",
"documentation":"<p> The subnet ID to place the instance used to customize your EC2 AMI in. </p>"
"documentation":"<p>The subnet ID to place the instance used to customize your EC2 AMI in. </p>"
},
"logging":{
"shape":"Logging",
"documentation":"<p> The logging configuration of the infrastructure configuration. </p>"
"documentation":"<p>The logging configuration of the infrastructure configuration. </p>"
},
"keyPair":{
"shape":"NonEmptyString",
"documentation":"<p> The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>"
"documentation":"<p>The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>"
},
"terminateInstanceOnFailure":{
"shape":"NullableBoolean",
"documentation":"<p> The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. </p>"
"documentation":"<p>The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. </p>"
},
"snsTopicArn":{
"shape":"SnsTopicArn",
"documentation":"<p> The SNS topic on which to send image build events. </p>"
"documentation":"<p>The SNS topic on which to send image build events. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>",
"documentation":"<p>The idempotency token used to make this request idempotent. </p>",
"idempotencyToken":true
}
}
@ -3644,15 +3680,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
"documentation":"<p>The request ID that uniquely identifies this request. </p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p> The idempotency token used to make this request idempotent. </p>"
"documentation":"<p>The idempotency token used to make this request idempotent. </p>"
},
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request. </p>"
}
}
},

View file

@ -168,6 +168,13 @@
"createdAt": "1458680170.035",
"dataCollected": true,
"durationInSeconds": 3600,
"findingCounts": {
"High": 14,
"Informational": 0,
"Low": 0,
"Medium": 2,
"Undefined": 0
},
"notifications": [
],
@ -273,6 +280,7 @@
{
"name": "ExampleAssessmentTemplate",
"arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
"assessmentRunCount": 0,
"assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
"createdAt": "1458074191.844",
"durationInSeconds": 3600,

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -1,5 +1,5 @@
{
"version":"1.0",
"examples":{
"version": "1.0",
"examples": {
}
}

View file

@ -321,6 +321,23 @@
],
"documentation":"<p>Creates an X.509 certificate using the specified certificate signing request.</p> <p> <b>Note:</b> The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. </p> <p> <b>Note:</b> Reusing the same certificate signing request (CSR) results in a distinct certificate.</p> <p>You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.</p> <p>Assuming a set of CSRs are located inside of the directory my-csr-directory:</p> <p>On Linux and OS X, the command is:</p> <p>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.</p> <p>The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:</p> <p>$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>&gt; ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}</p> <p>On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>&gt; forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"</p>"
},
"CreateDimension":{
"name":"CreateDimension",
"http":{
"method":"POST",
"requestUri":"/dimensions/{name}"
},
"input":{"shape":"CreateDimensionRequest"},
"output":{"shape":"CreateDimensionResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.</p>"
},
"CreateDomainConfiguration":{
"name":"CreateDomainConfiguration",
"http":{
@ -774,6 +791,21 @@
],
"documentation":"<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status.</p>"
},
"DeleteDimension":{
"name":"DeleteDimension",
"http":{
"method":"DELETE",
"requestUri":"/dimensions/{name}"
},
"input":{"shape":"DeleteDimensionRequest"},
"output":{"shape":"DeleteDimensionResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Removes the specified dimension from your AWS account.</p>"
},
"DeleteDomainConfiguration":{
"name":"DeleteDomainConfiguration",
"http":{
@ -1302,6 +1334,22 @@
],
"documentation":"<p>Describes the default authorizer.</p>"
},
"DescribeDimension":{
"name":"DescribeDimension",
"http":{
"method":"GET",
"requestUri":"/dimensions/{name}"
},
"input":{"shape":"DescribeDimensionRequest"},
"output":{"shape":"DescribeDimensionResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Provides details about a dimension that is defined in your AWS account.</p>"
},
"DescribeDomainConfiguration":{
"name":"DescribeDomainConfiguration",
"http":{
@ -2114,6 +2162,21 @@
],
"documentation":"<p>List the device certificates signed by the specified CA certificate.</p>"
},
"ListDimensions":{
"name":"ListDimensions",
"http":{
"method":"GET",
"requestUri":"/dimensions"
},
"input":{"shape":"ListDimensionsRequest"},
"output":{"shape":"ListDimensionsResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>List the set of dimensions that are defined for your AWS account.</p>"
},
"ListDomainConfigurations":{
"name":"ListDomainConfigurations",
"http":{
@ -2412,7 +2475,8 @@
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
{"shape":"InternalFailureException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.</p>"
},
@ -2916,7 +2980,8 @@
{"shape":"InternalException"},
{"shape":"NotConfiguredException"},
{"shape":"InvalidRequestException"},
{"shape":"ServiceUnavailableException"}
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Sets the logging level.</p>"
},
@ -3177,6 +3242,22 @@
],
"documentation":"<p>Updates the status of the specified certificate. This operation is idempotent.</p> <p>Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.</p> <p>The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.</p>"
},
"UpdateDimension":{
"name":"UpdateDimension",
"http":{
"method":"PATCH",
"requestUri":"/dimensions/{name}"
},
"input":{"shape":"UpdateDimensionRequest"},
"output":{"shape":"UpdateDimensionResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).</p>"
},
"UpdateDomainConfiguration":{
"name":"UpdateDomainConfiguration",
"http":{
@ -3575,7 +3656,7 @@
},
"cloudwatchLogs":{
"shape":"CloudwatchLogsAction",
"documentation":"<p>Send data to CloudWatch logs.</p>"
"documentation":"<p>Send data to CloudWatch Logs.</p>"
},
"elasticsearch":{
"shape":"ElasticsearchAction",
@ -3736,6 +3817,10 @@
"type":"list",
"member":{"shape":"BehaviorMetric"}
},
"AdditionalMetricsToRetainV2List":{
"type":"list",
"member":{"shape":"MetricToRetain"}
},
"AdditionalParameterMap":{
"type":"map",
"key":{"shape":"AttributeKey"},
@ -4571,6 +4656,10 @@
"shape":"BehaviorMetric",
"documentation":"<p>What is measured by the behavior.</p>"
},
"metricDimension":{
"shape":"MetricDimension",
"documentation":"<p>The dimension for a metric in your behavior. For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.</p>"
},
"criteria":{
"shape":"BehaviorCriteria",
"documentation":"<p>The criteria that determine if a device is behaving normally in regard to the <code>metric</code>.</p>"
@ -5130,7 +5219,7 @@
"documentation":"<p>The CloudWatch log group to which the action sends data.</p>"
}
},
"documentation":"<p>Describes an action that sends data to CloudWatch logs.</p>"
"documentation":"<p>Describes an action that sends data to CloudWatch Logs.</p>"
},
"CloudwatchMetricAction":{
"type":"structure",
@ -5408,6 +5497,53 @@
},
"documentation":"<p>The output from the CreateCertificateFromCsr operation.</p>"
},
"CreateDimensionRequest":{
"type":"structure",
"required":[
"name",
"type",
"stringValues",
"clientRequestToken"
],
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.</p>",
"location":"uri",
"locationName":"name"
},
"type":{
"shape":"DimensionType",
"documentation":"<p>Specifies the type of dimension. Supported types: <code>TOPIC_FILTER.</code> </p>"
},
"stringValues":{
"shape":"DimensionStringValues",
"documentation":"<p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code> dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata that can be used to manage the dimension.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.</p>",
"idempotencyToken":true
}
}
},
"CreateDimensionResponse":{
"type":"structure",
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>A unique identifier for the dimension.</p>"
},
"arn":{
"shape":"DimensionArn",
"documentation":"<p>The ARN (Amazon resource name) of the created dimension.</p>"
}
}
},
"CreateDomainConfigurationRequest":{
"type":"structure",
"required":["domainConfigurationName"],
@ -6071,6 +6207,12 @@
},
"additionalMetricsToRetain":{
"shape":"AdditionalMetricsToRetainList",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p> <p> <b>Note:</b> This API field is deprecated. Please use <a>CreateSecurityProfileRequest$additionalMetricsToRetainV2</a> instead.</p>",
"deprecated":true,
"deprecatedMessage":"Use additionalMetricsToRetainV2."
},
"additionalMetricsToRetainV2":{
"shape":"AdditionalMetricsToRetainV2List",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
},
"tags":{
@ -6473,6 +6615,23 @@
"error":{"httpStatusCode":409},
"exception":true
},
"DeleteDimensionRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>The unique identifier for the dimension that you want to delete.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DeleteDimensionResponse":{
"type":"structure",
"members":{
}
},
"DeleteDomainConfigurationRequest":{
"type":"structure",
"required":["domainConfigurationName"],
@ -7186,6 +7345,47 @@
}
}
},
"DescribeDimensionRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>The unique identifier for the dimension.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DescribeDimensionResponse":{
"type":"structure",
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>The unique identifier for the dimension.</p>"
},
"arn":{
"shape":"DimensionArn",
"documentation":"<p>The ARN (Amazon resource name) for the dimension.</p>"
},
"type":{
"shape":"DimensionType",
"documentation":"<p>The type of the dimension.</p>"
},
"stringValues":{
"shape":"DimensionStringValues",
"documentation":"<p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"<p>The date the dimension was created.</p>"
},
"lastModifiedDate":{
"shape":"Timestamp",
"documentation":"<p>The date the dimension was last modified.</p>"
}
}
},
"DescribeDomainConfigurationRequest":{
"type":"structure",
"required":["domainConfigurationName"],
@ -7612,7 +7812,13 @@
},
"additionalMetricsToRetain":{
"shape":"AdditionalMetricsToRetainList",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p> <p> <b>Note:</b> This API field is deprecated. Please use <a>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</a> instead.</p>",
"deprecated":true,
"deprecatedMessage":"Use additionalMetricsToRetainV2."
},
"additionalMetricsToRetainV2":{
"shape":"AdditionalMetricsToRetainV2List",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.</p>"
},
"version":{
"shape":"Version",
@ -7993,6 +8199,39 @@
"max":128,
"min":1
},
"DimensionArn":{"type":"string"},
"DimensionName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9:_-]+"
},
"DimensionNames":{
"type":"list",
"member":{"shape":"DimensionName"}
},
"DimensionStringValue":{
"type":"string",
"max":256,
"min":1
},
"DimensionStringValues":{
"type":"list",
"member":{"shape":"DimensionStringValue"},
"max":100,
"min":1
},
"DimensionType":{
"type":"string",
"enum":["TOPIC_FILTER"]
},
"DimensionValueOperator":{
"type":"string",
"enum":[
"IN",
"NOT_IN"
]
},
"DisableAllLogs":{"type":"boolean"},
"DisableTopicRuleRequest":{
"type":"structure",
@ -8860,7 +9099,7 @@
},
"confirmationUrl":{
"shape":"Url",
"documentation":"<p>The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substituion template before traffic is allowed to your endpoint URL.</p>"
"documentation":"<p>The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.</p>"
},
"headers":{
"shape":"HeaderList",
@ -10097,6 +10336,36 @@
},
"documentation":"<p>The output of the ListCertificates operation.</p>"
},
"ListDimensionsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to retrieve at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListDimensionsResponse":{
"type":"structure",
"members":{
"dimensionNames":{
"shape":"DimensionNames",
"documentation":"<p>A list of the names of the defined dimensions. Use <code>DescribeDimension</code> to get details for a dimension.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListDomainConfigurationsRequest":{
"type":"structure",
"members":{
@ -10793,6 +11062,12 @@
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"dimensionName":{
"shape":"DimensionName",
"documentation":"<p>A filter to limit results to the security profiles that use the defined dimension.</p>",
"location":"querystring",
"locationName":"dimensionName"
}
}
},
@ -11593,6 +11868,36 @@
"type":"string",
"max":128
},
"MetricDimension":{
"type":"structure",
"required":["dimensionName"],
"members":{
"dimensionName":{
"shape":"DimensionName",
"documentation":"<p>A unique identifier for the dimension.</p>"
},
"operator":{
"shape":"DimensionValueOperator",
"documentation":"<p>Defines how the <code>dimensionValues</code> of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with <code>IN</code> operator, a message will be counted only if its topic matches one of the topic filters. With <code>NOT_IN</code> Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is <code>null</code>), it will be interpreted as <code>IN</code>.</p>"
}
},
"documentation":"<p>The dimension of a metric.</p>"
},
"MetricToRetain":{
"type":"structure",
"required":["metric"],
"members":{
"metric":{
"shape":"BehaviorMetric",
"documentation":"<p>What is measured by the behavior.</p>"
},
"metricDimension":{
"shape":"MetricDimension",
"documentation":"<p>The dimension of a metric.</p>"
}
},
"documentation":"<p>The metric you want to retain. Dimensions are optional.</p>"
},
"MetricValue":{
"type":"structure",
"members":{
@ -14818,6 +15123,54 @@
},
"documentation":"<p>Parameters to define a mitigation action that changes the state of the device certificate to inactive.</p>"
},
"UpdateDimensionRequest":{
"type":"structure",
"required":[
"name",
"stringValues"
],
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.</p>",
"location":"uri",
"locationName":"name"
},
"stringValues":{
"shape":"DimensionStringValues",
"documentation":"<p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code> dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").</p>"
}
}
},
"UpdateDimensionResponse":{
"type":"structure",
"members":{
"name":{
"shape":"DimensionName",
"documentation":"<p>A unique identifier for the dimension.</p>"
},
"arn":{
"shape":"DimensionArn",
"documentation":"<p>The ARN (Amazon resource name) of the created dimension.</p>"
},
"type":{
"shape":"DimensionType",
"documentation":"<p>The type of the dimension.</p>"
},
"stringValues":{
"shape":"DimensionStringValues",
"documentation":"<p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in milliseconds since epoch, when the dimension was initially created.</p>"
},
"lastModifiedDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in milliseconds since epoch, when the dimension was most recently updated.</p>"
}
}
},
"UpdateDomainConfigurationRequest":{
"type":"structure",
"required":["domainConfigurationName"],
@ -15123,7 +15476,13 @@
},
"additionalMetricsToRetain":{
"shape":"AdditionalMetricsToRetainList",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p> <p> <b>Note:</b> This API field is deprecated. Please use <a>UpdateSecurityProfileRequest$additionalMetricsToRetainV2</a> instead.</p>",
"deprecated":true,
"deprecatedMessage":"Use additionalMetricsToRetainV2."
},
"additionalMetricsToRetainV2":{
"shape":"AdditionalMetricsToRetainV2List",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.</p>"
},
"deleteBehaviors":{
"shape":"DeleteBehaviors",
@ -15170,7 +15529,13 @@
},
"additionalMetricsToRetain":{
"shape":"AdditionalMetricsToRetainList",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p> <p> <b>Note:</b> This API field is deprecated. Please use <a>UpdateSecurityProfileResponse$additionalMetricsToRetainV2</a> instead.</p>",
"deprecated":true,
"deprecatedMessage":"Use additionalMetricsToRetainV2."
},
"additionalMetricsToRetainV2":{
"shape":"AdditionalMetricsToRetainV2List",
"documentation":"<p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.</p>"
},
"version":{
"shape":"Version",
@ -15474,5 +15839,5 @@
"resourceArn":{"type":"string"},
"resourceId":{"type":"string"}
},
"documentation":"<fullname>AWS IoT</fullname> <p>AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.</p> <p>For more information about how AWS IoT works, see the <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html\">Developer Guide</a>.</p> <p>For information about how to use the credentials provider for AWS IoT, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html\">Authorizing Direct Calls to AWS Services</a>.</p>"
"documentation":"<fullname>AWS IoT</fullname> <p>AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.</p> <p>The service endpoints that expose this API are listed in <a href=\"https://docs.aws.amazon.com/general/latest/gr/iot-core.html\">AWS IoT Core Endpoints and Quotas</a>. You must use the endpoint for the region that has the resources you want to access.</p> <p>The service name used by <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">AWS Signature Version 4</a> to sign the request is: <i>execute-api</i>.</p> <p>For more information about how AWS IoT works, see the <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html\">Developer Guide</a>.</p> <p>For information about how to use the credentials provider for AWS IoT, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html\">Authorizing Direct Calls to AWS Services</a>.</p>"
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -290,6 +290,24 @@
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Updates an input.</p>"
},
"VerifyResourcesExistForTagris":{
"name":"VerifyResourcesExistForTagris",
"http":{
"method":"GET",
"requestUri":"/internal/tags/resource-status"
},
"input":{"shape":"TagrisVerifyResourcesExistInput"},
"output":{"shape":"TagrisVerifyResourcesExistOutput"},
"errors":[
{"shape":"TagrisAccessDeniedException"},
{"shape":"TagrisInternalServiceException"},
{"shape":"TagrisInvalidArnException"},
{"shape":"TagrisInvalidParameterException"},
{"shape":"TagrisPartialResourcesExistResultsException"},
{"shape":"TagrisThrottledException"}
],
"internalonly":true
}
},
"shapes":{
@ -326,7 +344,7 @@
},
"iotEvents":{
"shape":"IotEventsAction",
"documentation":"<p>Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
"documentation":"<p>Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.</p>"
},
"sqs":{
"shape":"SqsAction",
@ -335,6 +353,18 @@
"firehose":{
"shape":"FirehoseAction",
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.</p>"
},
"dynamoDB":{
"shape":"DynamoDBAction",
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
},
"dynamoDBv2":{
"shape":"DynamoDBv2Action",
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
},
"iotSiteWise":{
"shape":"IotSiteWiseAction",
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an AWS IoT SiteWise asset property.</p>"
}
},
"documentation":"<p>An action to be performed when the <code>condition</code> is TRUE.</p>"
@ -348,6 +378,73 @@
"max":2048,
"min":1
},
"AssetId":{"type":"string"},
"AssetPropertyAlias":{"type":"string"},
"AssetPropertyBooleanValue":{"type":"string"},
"AssetPropertyDoubleValue":{"type":"string"},
"AssetPropertyEntryId":{"type":"string"},
"AssetPropertyId":{"type":"string"},
"AssetPropertyIntegerValue":{"type":"string"},
"AssetPropertyOffsetInNanos":{"type":"string"},
"AssetPropertyQuality":{"type":"string"},
"AssetPropertyStringValue":{"type":"string"},
"AssetPropertyTimeInSeconds":{"type":"string"},
"AssetPropertyTimestamp":{
"type":"structure",
"required":["timeInSeconds"],
"members":{
"timeInSeconds":{
"shape":"AssetPropertyTimeInSeconds",
"documentation":"<p>The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.</p>"
},
"offsetInNanos":{
"shape":"AssetPropertyOffsetInNanos",
"documentation":"<p>The nanosecond offset converted from <code>timeInSeconds</code>. The valid range is between 0-999999999. You can also specify an expression.</p>"
}
},
"documentation":"<p>A structure that contains timestamp information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html\">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>For parameters that are string data type, you can specify the following options:</p> <ul> <li> <p>Use a string. For example, the <code>timeInSeconds</code> value can be <code>'1586400675'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>timeInSeconds</code> value can be <code>'${$input.TemperatureInput.sensorData.timestamp/1000}'</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
},
"AssetPropertyValue":{
"type":"structure",
"required":["value"],
"members":{
"value":{
"shape":"AssetPropertyVariant",
"documentation":"<p>The value to send to an asset property.</p>"
},
"timestamp":{
"shape":"AssetPropertyTimestamp",
"documentation":"<p>The timestamp associated with the asset property value. The default is the current event time.</p>"
},
"quality":{
"shape":"AssetPropertyQuality",
"documentation":"<p>The quality of the asset property value. The value must be <code>GOOD</code>, <code>BAD</code>, or <code>UNCERTAIN</code>. You can also specify an expression.</p>"
}
},
"documentation":"<p>A structure that contains value information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html\">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>For parameters that are string data type, you can specify the following options: </p> <ul> <li> <p>Use a string. For example, the <code>quality</code> value can be <code>'GOOD'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>quality</code> value can be <code>$input.TemperatureInput.sensorData.quality</code> .</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
},
"AssetPropertyVariant":{
"type":"structure",
"members":{
"stringValue":{
"shape":"AssetPropertyStringValue",
"documentation":"<p>The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.</p>"
},
"integerValue":{
"shape":"AssetPropertyIntegerValue",
"documentation":"<p>The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.</p>"
},
"doubleValue":{
"shape":"AssetPropertyDoubleValue",
"documentation":"<p>The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.</p>"
},
"booleanValue":{
"shape":"AssetPropertyBooleanValue",
"documentation":"<p>The asset property value is a Boolean value that must be <code>TRUE</code> or <code>FALSE</code>. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.</p>"
}
},
"documentation":"<p>A structure that contains an asset property value. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html\">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <important> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html\">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> </important> <p>For parameters that are string data type, you can specify the following options:</p> <ul> <li> <p>Use a string. For example, the <code>doubleValue</code> value can be <code>'47.9'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>doubleValue</code> value can be <code>$input.TemperatureInput.sensorData.temperature</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
},
"Attribute":{
"type":"structure",
"required":["jsonPath"],
@ -386,6 +483,10 @@
"type":"string",
"max":512
},
"ContentExpression":{
"type":"string",
"min":1
},
"CreateDetectorModelRequest":{
"type":"structure",
"required":[
@ -636,7 +737,7 @@
},
"key":{
"shape":"AttributeJsonPath",
"documentation":"<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.</p>"
"documentation":"<p>The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information. </p> <p>This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.</p>"
},
"evaluationMethod":{
"shape":"EvaluationMethod",
@ -754,6 +855,71 @@
},
"documentation":"<p>Information about the detector model version.</p>"
},
"DynamoDBAction":{
"type":"structure",
"required":[
"hashKeyField",
"hashKeyValue",
"tableName"
],
"members":{
"hashKeyType":{
"shape":"DynamoKeyType",
"documentation":"<p>The data type for the hash key (also called the partition key). You can specify the following values:</p> <ul> <li> <p> <code>STRING</code> - The hash key is a string.</p> </li> <li> <p> <code>NUMBER</code> - The hash key is a number.</p> </li> </ul> <p>If you don't specify <code>hashKeyType</code>, the default value is <code>STRING</code>.</p>"
},
"hashKeyField":{
"shape":"DynamoKeyField",
"documentation":"<p>The name of the hash key (also called the partition key).</p>"
},
"hashKeyValue":{
"shape":"DynamoKeyValue",
"documentation":"<p>The value of the hash key (also called the partition key).</p>"
},
"rangeKeyType":{
"shape":"DynamoKeyType",
"documentation":"<p>The data type for the range key (also called the sort key), You can specify the following values:</p> <ul> <li> <p> <code>STRING</code> - The range key is a string.</p> </li> <li> <p> <code>NUMBER</code> - The range key is number.</p> </li> </ul> <p>If you don't specify <code>rangeKeyField</code>, the default value is <code>STRING</code>.</p>"
},
"rangeKeyField":{
"shape":"DynamoKeyField",
"documentation":"<p>The name of the range key (also called the sort key).</p>"
},
"rangeKeyValue":{
"shape":"DynamoKeyValue",
"documentation":"<p>The value of the range key (also called the sort key).</p>"
},
"operation":{
"shape":"DynamoOperation",
"documentation":"<p>The type of operation to perform. You can specify the following values: </p> <ul> <li> <p> <code>INSERT</code> - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.</p> </li> <li> <p> <code>UPDATE</code> - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> <li> <p> <code>DELETE</code> - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> </ul> <p>If you don't specify this parameter, AWS IoT Events triggers the <code>INSERT</code> operation.</p>"
},
"payloadField":{
"shape":"DynamoKeyField",
"documentation":"<p>The name of the DynamoDB column that receives the action payload.</p> <p>If you don't specify this parameter, the name of the DynamoDB column is <code>payload</code>.</p>"
},
"tableName":{
"shape":"DynamoTableName",
"documentation":"<p>The name of the DynamoDB table.</p>"
},
"payload":{"shape":"Payload"}
},
"documentation":"<p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.</p> <p>The <code>tableName</code> and <code>hashKeyField</code> values must match the table name and the partition key of the DynamoDB table. </p> <note> <p>If the DynamoDB table also has a sort key, you must specify <code>rangeKeyField</code>. The <code>rangeKeyField</code> value must match the sort key.</p> </note> <p/> <p>The <code>hashKeyValue</code> and <code>rangeKeyValue</code> use substitution templates. These templates provide data at runtime. The syntax is <code>${sql-expression}</code>.</p> <p>You can use expressions for parameters that are string data type. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <note> <p>If the defined payload type is a string, <code>DynamoDBAction</code> writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The <code>payloadField</code> is <code>&lt;payload-field&gt;_raw</code>.</p> </note>"
},
"DynamoDBv2Action":{
"type":"structure",
"required":["tableName"],
"members":{
"tableName":{
"shape":"DynamoTableName",
"documentation":"<p>The name of the DynamoDB table.</p>"
},
"payload":{"shape":"Payload"}
},
"documentation":"<p>Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.</p> <important> <p>The <code>type</code> value for <code>Payload</code> must be <code>JSON</code>.</p> </important> <p>You can use expressions for parameters that are strings. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
},
"DynamoKeyField":{"type":"string"},
"DynamoKeyType":{"type":"string"},
"DynamoKeyValue":{"type":"string"},
"DynamoOperation":{"type":"string"},
"DynamoTableName":{"type":"string"},
"EvaluationMethod":{
"type":"string",
"enum":[
@ -799,6 +965,10 @@
"separator":{
"shape":"FirehoseSeparator",
"documentation":"<p>A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).</p>"
},
"payload":{
"shape":"Payload",
"documentation":"<p>You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.</p>"
}
},
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.</p>"
@ -955,10 +1125,41 @@
"inputName":{
"shape":"InputName",
"documentation":"<p>The name of the AWS IoT Events input where the data is sent.</p>"
},
"payload":{
"shape":"Payload",
"documentation":"<p>You can configure the action payload when you send a message to an AWS IoT Events input.</p>"
}
},
"documentation":"<p>Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
},
"IotSiteWiseAction":{
"type":"structure",
"required":["propertyValue"],
"members":{
"entryId":{
"shape":"AssetPropertyEntryId",
"documentation":"<p>A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.</p>"
},
"assetId":{
"shape":"AssetId",
"documentation":"<p>The ID of the asset that has the specified property. You can specify an expression.</p>"
},
"propertyId":{
"shape":"AssetPropertyId",
"documentation":"<p>The ID of the asset property. You can specify an expression.</p>"
},
"propertyAlias":{
"shape":"AssetPropertyAlias",
"documentation":"<p>The alias of the asset property. You can also specify an expression.</p>"
},
"propertyValue":{
"shape":"AssetPropertyValue",
"documentation":"<p>The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. </p>"
}
},
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <important> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> </important> <p>For parameters that are string data type, you can specify the following options: </p> <ul> <li> <p>Use a string. For example, the <code>propertyAlias</code> value can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>propertyAlias</code> value can be <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature'</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
},
"IotTopicPublishAction":{
"type":"structure",
"required":["mqttTopic"],
@ -966,6 +1167,10 @@
"mqttTopic":{
"shape":"MQTTTopic",
"documentation":"<p>The MQTT topic of the message. You can use a string expression that includes variables (<code>$variable.&lt;variable-name&gt;</code>) and input values (<code>$input.&lt;input-name&gt;.&lt;path-to-datum&gt;</code>) as the topic string.</p>"
},
"payload":{
"shape":"Payload",
"documentation":"<p>You can configure the action payload when you publish a message to an AWS IoT Core topic.</p>"
}
},
"documentation":"<p>Information required to publish the MQTT message through the AWS IoT message broker.</p>"
@ -983,6 +1188,10 @@
"functionArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the Lambda function that is executed.</p>"
},
"payload":{
"shape":"Payload",
"documentation":"<p>You can configure the action payload when you send a message to a Lambda function.</p>"
}
},
"documentation":"<p>Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.</p>"
@ -1169,7 +1378,7 @@
"members":{
"events":{
"shape":"Events",
"documentation":"<p>Specifies the actions that are performed when the state is entered and the <code>condition</code> is TRUE.</p>"
"documentation":"<p>Specifies the actions that are performed when the state is entered and the <code>condition</code> is <code>TRUE</code>.</p>"
}
},
"documentation":"<p>When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.</p>"
@ -1179,10 +1388,10 @@
"members":{
"events":{
"shape":"Events",
"documentation":"<p>Specifies the <code>actions</code> that are performed when the state is exited and the <code>condition</code> is TRUE.</p>"
"documentation":"<p>Specifies the <code>actions</code> that are performed when the state is exited and the <code>condition</code> is <code>TRUE</code>.</p>"
}
},
"documentation":"<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is TRUE.</p>"
"documentation":"<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is <code>TRUE</code>.</p>"
},
"OnInputLifecycle":{
"type":"structure",
@ -1198,6 +1407,31 @@
},
"documentation":"<p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>"
},
"Payload":{
"type":"structure",
"required":[
"contentExpression",
"type"
],
"members":{
"contentExpression":{
"shape":"ContentExpression",
"documentation":"<p>The content of the payload. You can use a string expression that includes quoted strings (<code>'&lt;string&gt;'</code>), variables (<code>$variable.&lt;variable-name&gt;</code>), input values (<code>$input.&lt;input-name&gt;.&lt;path-to-datum&gt;</code>), string concatenations, and quoted strings that contain <code>${}</code> as the content. The recommended maximum size of a content expression is 1 KB.</p>"
},
"type":{
"shape":"PayloadType",
"documentation":"<p>The value of the payload type can be either <code>STRING</code> or <code>JSON</code>.</p>"
}
},
"documentation":"<p>Information needed to configure the payload.</p> <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use <code>contentExpression</code>.</p>"
},
"PayloadType":{
"type":"string",
"enum":[
"STRING",
"JSON"
]
},
"PutLoggingOptionsRequest":{
"type":"structure",
"required":["loggingOptions"],
@ -1218,7 +1452,7 @@
"documentation":"<p>The name of the timer to reset.</p>"
}
},
"documentation":"<p>Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. </p>"
"documentation":"<p>Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.</p>"
},
"ResourceAlreadyExistsException":{
"type":"structure",
@ -1271,6 +1505,10 @@
"targetArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the Amazon SNS target where the message is sent.</p>"
},
"payload":{
"shape":"Payload",
"documentation":"<p>You can configure the action payload when you send a message as an Amazon SNS push notification.</p>"
}
},
"documentation":"<p>Information required to publish the Amazon SNS message.</p>"
@ -1303,7 +1541,7 @@
},
"seconds":{
"shape":"Seconds",
"documentation":"<p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.</p>",
"documentation":"<p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. </p>",
"deprecated":true,
"deprecatedMessage":"seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression."
},
@ -1342,7 +1580,11 @@
},
"useBase64":{
"shape":"UseBase64",
"documentation":"<p>Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue.</p>"
"documentation":"<p>Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.</p>"
},
"payload":{
"shape":"Payload",
"documentation":"<p>You can configure the action payload when you send a message to an Amazon SQS queue.</p>"
}
},
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.</p>"
@ -1365,7 +1607,7 @@
},
"onExit":{
"shape":"OnExitLifecycle",
"documentation":"<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is TRUE.</p>"
"documentation":"<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is <code>TRUE</code>.</p>"
}
},
"documentation":"<p>Information that defines a state of a detector.</p>"
@ -1436,6 +1678,111 @@
"max":256,
"min":0
},
"TagrisAccessDeniedException":{
"type":"structure",
"members":{
"message":{"shape":"TagrisExceptionMessage"}
},
"exception":true
},
"TagrisAccountId":{
"type":"string",
"max":12,
"min":12
},
"TagrisAmazonResourceName":{
"type":"string",
"max":1011,
"min":1
},
"TagrisExceptionMessage":{
"type":"string",
"max":2048,
"min":0
},
"TagrisInternalId":{
"type":"string",
"max":64,
"min":0
},
"TagrisInternalServiceException":{
"type":"structure",
"members":{
"message":{"shape":"TagrisExceptionMessage"}
},
"exception":true,
"fault":true
},
"TagrisInvalidArnException":{
"type":"structure",
"members":{
"message":{"shape":"TagrisExceptionMessage"},
"sweepListItem":{"shape":"TagrisSweepListItem"}
},
"exception":true
},
"TagrisInvalidParameterException":{
"type":"structure",
"members":{
"message":{"shape":"TagrisExceptionMessage"}
},
"exception":true
},
"TagrisPartialResourcesExistResultsException":{
"type":"structure",
"members":{
"message":{"shape":"TagrisExceptionMessage"},
"resourceExistenceInformation":{"shape":"TagrisSweepListResult"}
},
"exception":true
},
"TagrisStatus":{
"type":"string",
"enum":[
"ACTIVE",
"NOT_ACTIVE"
]
},
"TagrisSweepList":{
"type":"list",
"member":{"shape":"TagrisSweepListItem"}
},
"TagrisSweepListItem":{
"type":"structure",
"members":{
"TagrisAccountId":{"shape":"TagrisAccountId"},
"TagrisAmazonResourceName":{"shape":"TagrisAmazonResourceName"},
"TagrisInternalId":{"shape":"TagrisInternalId"},
"TagrisVersion":{"shape":"TagrisVersion"}
}
},
"TagrisSweepListResult":{
"type":"map",
"key":{"shape":"TagrisAmazonResourceName"},
"value":{"shape":"TagrisStatus"}
},
"TagrisThrottledException":{
"type":"structure",
"members":{
"message":{"shape":"TagrisExceptionMessage"}
},
"exception":true
},
"TagrisVerifyResourcesExistInput":{
"type":"structure",
"required":["TagrisSweepList"],
"members":{
"TagrisSweepList":{"shape":"TagrisSweepList"}
}
},
"TagrisVerifyResourcesExistOutput":{
"type":"structure",
"required":["TagrisSweepListResult"],
"members":{
"TagrisSweepListResult":{"shape":"TagrisSweepListResult"}
}
},
"TagrisVersion":{"type":"long"},
"Tags":{
"type":"list",
"member":{"shape":"Tag"}
@ -1617,5 +1964,5 @@
"resourceArn":{"type":"string"},
"resourceId":{"type":"string"}
},
"documentation":"<p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API commands to create, read, update, and delete inputs and detector models, and to list their versions.</p>"
"documentation":"<p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.</p>"
}

View file

@ -104,6 +104,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the <code>Status</code> field returned from a call to . The <code>Status</code> field is set to <code>ACTIVE</code> when the index is ready to use.</p> <p>Once the index is active you can index your documents using the operation or using one of the supported data sources. </p>"
@ -481,7 +482,7 @@
"documentation":"<p>Performs a less than or equals operation on two document attributes. Use with a document attribute of type <code>Integer</code> or <code>Long</code>.</p>"
}
},
"documentation":"<p>Provides filtering the query results based on document attributes.</p>"
"documentation":"<p>Provides filtering the query results based on document attributes.</p> <p>When you use the <code>AndAllFilters</code> or <code>OrAllFilters</code>, filters you can use a total of 3 layers. For example, you can use:</p> <ol> <li> <p> <code>&lt;AndAllFilters&gt;</code> </p> </li> <li> <p> <code> &lt;OrAllFilters&gt;</code> </p> </li> <li> <p> <code> &lt;EqualTo&gt;</code> </p> </li> </ol>"
},
"AttributeFilterList":{
"type":"list",
@ -623,6 +624,11 @@
"type":"list",
"member":{"shape":"ClickFeedback"}
},
"ClientTokenName":{
"type":"string",
"max":100,
"min":1
},
"ColumnConfiguration":{
"type":"structure",
"required":[
@ -823,6 +829,11 @@
"Description":{
"shape":"Description",
"documentation":"<p>A description for the index.</p>"
},
"ClientToken":{
"shape":"ClientTokenName",
"documentation":"<p>A token that you provide to identify the request to create an index. Multiple calls to the <code>CreateIndex</code> operation with the same client token will create only one index.”</p>",
"idempotencyToken":true
}
}
},
@ -862,7 +873,7 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"
"pattern":"^[a-zA-Z][a-zA-Z0-9_.]*$"
},
"DataSourceId":{
"type":"string",
@ -879,8 +890,7 @@
"DataSourceInclusionsExclusionsStringsMember":{
"type":"string",
"max":50,
"min":1,
"pattern":"^\\P{C}*$"
"min":1
},
"DataSourceName":{
"type":"string",
@ -1323,7 +1333,7 @@
},
"Blob":{
"shape":"Blob",
"documentation":"<p>The contents of the document as a base-64 encoded string.</p>"
"documentation":"<p>The contents of the document. </p> <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.</p>"
},
"S3Path":{"shape":"S3Path"},
"Attributes":{
@ -1386,8 +1396,7 @@
"DocumentAttributeStringValue":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^\\P{C}*$"
"min":1
},
"DocumentAttributeValue":{
"type":"structure",
@ -2223,8 +2232,7 @@
"S3ObjectKey":{
"type":"string",
"max":1024,
"min":1,
"pattern":".*"
"min":1
},
"S3Path":{
"type":"structure",
@ -2317,6 +2325,18 @@
"shape":"Boolean",
"documentation":"<p> <code>TRUE</code> to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, <code>FALSE</code>.</p>"
},
"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>"
},
"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>"
},
"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>"
},
"VpcConfiguration":{"shape":"DataSourceVpcConfiguration"},
"FieldMappings":{
"shape":"DataSourceToIndexFieldMappingList",

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -71,20 +71,32 @@
],
"CreateKey": [
{
"input": {
"Tags": [
{
"TagKey": "CreatedBy",
"TagValue": "ExampleUser"
}
]
},
"output": {
"KeyMetadata": {
"AWSAccountId": "111122223333",
"Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
"CreationDate": "2016-11-01T10:15:42-07:00",
"CreationDate": "2017-07-05T14:04:55-07:00",
"Description": "",
"Enabled": true,
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
"KeyManager": "CUSTOMER",
"KeyState": "Enabled",
"KeyUsage": "ENCRYPT_DECRYPT",
"Origin": "AWS_KMS"
}
},
"comments": {
"input": {
"Tags": "One or more tags. Each tag consists of a tag key and a tag value."
},
"output": {
"KeyMetadata": "An object that contains information about the CMK created by this operation."
}
@ -155,11 +167,12 @@
"output": {
"KeyMetadata": {
"AWSAccountId": "111122223333",
"Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
"CreationDate": "2015-10-12T11:45:07-07:00",
"Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
"CreationDate": "2017-07-05T14:04:55-07:00",
"Description": "",
"Enabled": true,
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
"KeyManager": "CUSTOMER",
"KeyState": "Enabled",
"KeyUsage": "ENCRYPT_DECRYPT",
"Origin": "AWS_KMS"
@ -636,6 +649,42 @@
"title": "To list customer master keys (CMKs)"
}
],
"ListResourceTags": [
{
"input": {
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
},
"output": {
"Tags": [
{
"TagKey": "CostCenter",
"TagValue": "87654"
},
{
"TagKey": "CreatedBy",
"TagValue": "ExampleUser"
},
{
"TagKey": "Purpose",
"TagValue": "Test"
}
],
"Truncated": false
},
"comments": {
"input": {
"KeyId": "The identifier of the CMK whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the CMK."
},
"output": {
"Tags": "A list of tags.",
"Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not."
}
},
"description": "The following example lists tags for a CMK.",
"id": "to-list-tags-for-a-cmk-1483996855796",
"title": "To list tags for a customer master key (CMK)"
}
],
"ListRetirableGrants": [
{
"input": {
@ -777,6 +826,48 @@
"title": "To schedule a customer master key (CMK) for deletion"
}
],
"TagResource": [
{
"input": {
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
"Tags": [
{
"TagKey": "Purpose",
"TagValue": "Test"
}
]
},
"comments": {
"input": {
"KeyId": "The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.",
"Tags": "A list of tags."
}
},
"description": "The following example tags a CMK.",
"id": "to-tag-a-cmk-1483997246518",
"title": "To tag a customer master key (CMK)"
}
],
"UntagResource": [
{
"input": {
"KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
"TagKeys": [
"Purpose",
"CostCenter"
]
},
"comments": {
"input": {
"KeyId": "The identifier of the CMK whose tags you are removing.",
"TagKeys": "A list of tag keys. Provide only the tag keys, not the tag values."
}
},
"description": "The following example removes tags from a CMK.",
"id": "to-remove-tags-from-a-cmk-1483997590962",
"title": "To remove tags from a customer master key (CMK)"
}
],
"UpdateAlias": [
{
"input": {

View file

@ -438,7 +438,7 @@
"CodeSha256": "",
"CodeSize": 123,
"Description": "",
"FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction:1",
"FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction",
"FunctionName": "myFunction",
"Handler": "index.handler",
"LastModified": "2016-11-21T19:49:20.006+0000",

View file

@ -48,7 +48,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"PreconditionFailedException"}
],
"documentation":"<p>Grants an AWS 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.</p> <p>To grant permission to another account, specify the account ID as the <code>Principal</code>. For AWS 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 AWS services, you can also specify the ARN or owning account of the associated resource as the <code>SourceArn</code> or <code>SourceAccount</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 AWS 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.</p> <p>To grant permission to another account, specify the account ID as the <code>Principal</code>. For AWS 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 AWS 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",
@ -455,7 +455,7 @@
{"shape":"ResourceConflictException"},
{"shape":"ResourceNotReadyException"}
],
"documentation":"<p>Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set <code>InvocationType</code> to <code>Event</code>.</p> <p>For <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html\">synchronous invocation</a>, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html\">execution log</a> and <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html\">trace</a>.</p> <p>When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/retries-on-errors.html\">Retry Behavior</a>.</p> <p>For <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html\">asynchronous invocation</a>, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq\">dead-letter queue</a>.</p> <p>The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/limits.html\">limit errors</a>, or issues with your function's code and configuration. For example, Lambda returns <code>TooManyRequestsException</code> if executing the function would cause you to exceed a concurrency limit at either the account level (<code>ConcurrentInvocationLimitExceeded</code>) or function level (<code>ReservedFunctionConcurrentInvocationLimitExceeded</code>).</p> <p>For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.</p> <p>This operation requires permission for the <code>lambda:InvokeFunction</code> action.</p>"
"documentation":"<p>Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set <code>InvocationType</code> to <code>Event</code>.</p> <p>For <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html\">synchronous invocation</a>, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html\">execution log</a> and <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html\">trace</a>.</p> <p>When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/retries-on-errors.html\">Retry Behavior</a>.</p> <p>For <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html\">asynchronous invocation</a>, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq\">dead-letter queue</a>.</p> <p>The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/limits.html\">limit errors</a>, or issues with your function's code and configuration. For example, Lambda returns <code>TooManyRequestsException</code> if executing the function would cause you to exceed a concurrency limit at either the account level (<code>ConcurrentInvocationLimitExceeded</code>) or function level (<code>ReservedFunctionConcurrentInvocationLimitExceeded</code>).</p> <p>For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.</p> <p>This operation requires permission for the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html\">lambda:InvokeFunction</a> action.</p>"
},
"InvokeAsync":{
"name":"InvokeAsync",
@ -1017,7 +1017,7 @@
},
"SourceAccount":{
"shape":"SourceOwner",
"documentation":"<p>For AWS services, the ID of the account that owns the resource. Use this instead of <code>SourceArn</code> to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with <code>SourceArn</code> to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.</p>"
"documentation":"<p>For Amazon S3, the ID of the account that owns the resource. Use this together with <code>SourceArn</code> to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.</p>"
},
"EventSourceToken":{
"shape":"EventSourceToken",
@ -1208,7 +1208,7 @@
},
"MaximumBatchingWindowInSeconds":{
"shape":"MaximumBatchingWindowInSeconds",
"documentation":"<p>The maximum amount of time to gather records before invoking the function, in seconds.</p>"
"documentation":"<p>(Streams) The maximum amount of time to gather records before invoking the function, in seconds.</p>"
},
"ParallelizationFactor":{
"shape":"ParallelizationFactor",
@ -1583,7 +1583,7 @@
},
"MaximumBatchingWindowInSeconds":{
"shape":"MaximumBatchingWindowInSeconds",
"documentation":"<p>The maximum amount of time to gather records before invoking the function, in seconds.</p>"
"documentation":"<p>(Streams) The maximum amount of time to gather records before invoking the function, in seconds.</p>"
},
"ParallelizationFactor":{
"shape":"ParallelizationFactor",
@ -3484,6 +3484,7 @@
"dotnetcore1.0",
"dotnetcore2.0",
"dotnetcore2.1",
"dotnetcore3.1",
"nodejs4.3-edge",
"go1.x",
"ruby2.5",
@ -3764,7 +3765,7 @@
},
"MaximumBatchingWindowInSeconds":{
"shape":"MaximumBatchingWindowInSeconds",
"documentation":"<p>The maximum amount of time to gather records before invoking the function, in seconds.</p>"
"documentation":"<p>(Streams) The maximum amount of time to gather records before invoking the function, in seconds.</p>"
},
"DestinationConfig":{
"shape":"DestinationConfig",

View file

@ -0,0 +1,758 @@
{
"version": "1.0",
"examples": {
"GetBot": [
{
"input": {
"name": "DocOrderPizza",
"versionOrAlias": "$LATEST"
},
"output": {
"version": "$LATEST",
"name": "DocOrderPizzaBot",
"abortStatement": {
"messages": [
{
"content": "I don't understand. Can you try again?",
"contentType": "PlainText"
},
{
"content": "I'm sorry, I don't understand.",
"contentType": "PlainText"
}
]
},
"checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9",
"childDirected": true,
"clarificationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "I'm sorry, I didn't hear that. Can you repeate what you just said?",
"contentType": "PlainText"
},
{
"content": "Can you say that again?",
"contentType": "PlainText"
}
]
},
"createdDate": 1494360160.133,
"description": "Orders a pizza from a local pizzeria.",
"idleSessionTTLInSeconds": 300,
"intents": [
{
"intentName": "DocOrderPizza",
"intentVersion": "$LATEST"
}
],
"lastUpdatedDate": 1494360160.133,
"locale": "en-US",
"status": "NOT_BUILT"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to get configuration information for a bot.",
"id": "to-get-information-about-a-bot-1494431724188",
"title": "To get information about a bot"
}
],
"GetBots": [
{
"input": {
"maxResults": 5,
"nextToken": ""
},
"output": {
"bots": [
{
"version": "$LATEST",
"name": "DocOrderPizzaBot",
"createdDate": 1494360160.133,
"description": "Orders a pizza from a local pizzeria.",
"lastUpdatedDate": 1494360160.133,
"status": "NOT_BUILT"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to get a list of all of the bots in your account.",
"id": "to-get-a-list-of-bots-1494432220036",
"title": "To get a list of bots"
}
],
"GetIntent": [
{
"input": {
"version": "$LATEST",
"name": "DocOrderPizza"
},
"output": {
"version": "$LATEST",
"name": "DocOrderPizza",
"checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6",
"conclusionStatement": {
"messages": [
{
"content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.",
"contentType": "PlainText"
},
{
"content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.",
"contentType": "PlainText"
}
],
"responseCard": "foo"
},
"confirmationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?",
"contentType": "PlainText"
}
]
},
"createdDate": 1494359783.453,
"description": "Order a pizza from a local pizzeria.",
"fulfillmentActivity": {
"type": "ReturnIntent"
},
"lastUpdatedDate": 1494359783.453,
"rejectionStatement": {
"messages": [
{
"content": "Ok, I'll cancel your order.",
"contentType": "PlainText"
},
{
"content": "I cancelled your order.",
"contentType": "PlainText"
}
]
},
"sampleUtterances": [
"Order me a pizza.",
"Order me a {Type} pizza.",
"I want a {Crust} crust {Type} pizza",
"I want a {Crust} crust {Type} pizza with {Sauce} sauce."
],
"slots": [
{
"name": "Type",
"description": "The type of pizza to order.",
"priority": 1,
"sampleUtterances": [
"Get me a {Type} pizza.",
"A {Type} pizza please.",
"I'd like a {Type} pizza."
],
"slotConstraint": "Required",
"slotType": "DocPizzaType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of pizza would you like?",
"contentType": "PlainText"
},
{
"content": "Vegie or cheese pizza?",
"contentType": "PlainText"
},
{
"content": "I can get you a vegie or a cheese pizza.",
"contentType": "PlainText"
}
]
}
},
{
"name": "Crust",
"description": "The type of pizza crust to order.",
"priority": 2,
"sampleUtterances": [
"Make it a {Crust} crust.",
"I'd like a {Crust} crust."
],
"slotConstraint": "Required",
"slotType": "DocPizzaCrustType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of crust would you like?",
"contentType": "PlainText"
},
{
"content": "Thick or thin crust?",
"contentType": "PlainText"
}
]
}
},
{
"name": "Sauce",
"description": "The type of sauce to use on the pizza.",
"priority": 3,
"sampleUtterances": [
"Make it {Sauce} sauce.",
"I'd like {Sauce} sauce."
],
"slotConstraint": "Required",
"slotType": "DocPizzaSauceType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "White or red sauce?",
"contentType": "PlainText"
},
{
"content": "Garlic or tomato sauce?",
"contentType": "PlainText"
}
]
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to get information about an intent.",
"id": "to-get-a-information-about-an-intent-1494432574147",
"title": "To get a information about an intent"
}
],
"GetIntents": [
{
"input": {
"maxResults": 10,
"nextToken": ""
},
"output": {
"intents": [
{
"version": "$LATEST",
"name": "DocOrderPizza",
"createdDate": 1494359783.453,
"description": "Order a pizza from a local pizzeria.",
"lastUpdatedDate": 1494359783.453
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to get a list of all of the intents in your account.",
"id": "to-get-a-list-of-intents-1494432416363",
"title": "To get a list of intents"
}
],
"GetSlotType": [
{
"input": {
"version": "$LATEST",
"name": "DocPizzaCrustType"
},
"output": {
"version": "$LATEST",
"name": "DocPizzaCrustType",
"checksum": "210b3d5a-90a3-4b22-ac7e-f50c2c71095f",
"createdDate": 1494359274.403,
"description": "Available crust types",
"enumerationValues": [
{
"value": "thick"
},
{
"value": "thin"
}
],
"lastUpdatedDate": 1494359274.403
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to get information about a slot type.",
"id": "to-get-information-about-a-slot-type-1494432961004",
"title": "To get information about a slot type"
}
],
"GetSlotTypes": [
{
"input": {
"maxResults": 10,
"nextToken": ""
},
"output": {
"slotTypes": [
{
"version": "$LATEST",
"name": "DocPizzaCrustType",
"createdDate": 1494359274.403,
"description": "Available crust types",
"lastUpdatedDate": 1494359274.403
},
{
"version": "$LATEST",
"name": "DocPizzaSauceType",
"createdDate": 1494356442.23,
"description": "Available pizza sauces",
"lastUpdatedDate": 1494356442.23
},
{
"version": "$LATEST",
"name": "DocPizzaType",
"createdDate": 1494359198.656,
"description": "Available pizzas",
"lastUpdatedDate": 1494359198.656
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to get a list of all of the slot types in your account.",
"id": "to-get-a-list-of-slot-types-1494432757458",
"title": "To get a list of slot types"
}
],
"PutBot": [
{
"input": {
"name": "DocOrderPizzaBot",
"abortStatement": {
"messages": [
{
"content": "I don't understand. Can you try again?",
"contentType": "PlainText"
},
{
"content": "I'm sorry, I don't understand.",
"contentType": "PlainText"
}
]
},
"childDirected": true,
"clarificationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "I'm sorry, I didn't hear that. Can you repeate what you just said?",
"contentType": "PlainText"
},
{
"content": "Can you say that again?",
"contentType": "PlainText"
}
]
},
"description": "Orders a pizza from a local pizzeria.",
"idleSessionTTLInSeconds": 300,
"intents": [
{
"intentName": "DocOrderPizza",
"intentVersion": "$LATEST"
}
],
"locale": "en-US",
"processBehavior": "SAVE"
},
"output": {
"version": "$LATEST",
"name": "DocOrderPizzaBot",
"abortStatement": {
"messages": [
{
"content": "I don't understand. Can you try again?",
"contentType": "PlainText"
},
{
"content": "I'm sorry, I don't understand.",
"contentType": "PlainText"
}
]
},
"checksum": "20172ee3-fa06-49b2-bbc5-667c090303e9",
"childDirected": true,
"clarificationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "I'm sorry, I didn't hear that. Can you repeate what you just said?",
"contentType": "PlainText"
},
{
"content": "Can you say that again?",
"contentType": "PlainText"
}
]
},
"createdDate": 1494360160.133,
"description": "Orders a pizza from a local pizzeria.",
"idleSessionTTLInSeconds": 300,
"intents": [
{
"intentName": "DocOrderPizza",
"intentVersion": "$LATEST"
}
],
"lastUpdatedDate": 1494360160.133,
"locale": "en-US",
"status": "NOT_BUILT"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to create a bot for ordering pizzas.",
"id": "to-create-a-bot-1494360003886",
"title": "To create a bot"
}
],
"PutIntent": [
{
"input": {
"name": "DocOrderPizza",
"conclusionStatement": {
"messages": [
{
"content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.",
"contentType": "PlainText"
},
{
"content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.",
"contentType": "PlainText"
}
],
"responseCard": "foo"
},
"confirmationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?",
"contentType": "PlainText"
}
]
},
"description": "Order a pizza from a local pizzeria.",
"fulfillmentActivity": {
"type": "ReturnIntent"
},
"rejectionStatement": {
"messages": [
{
"content": "Ok, I'll cancel your order.",
"contentType": "PlainText"
},
{
"content": "I cancelled your order.",
"contentType": "PlainText"
}
]
},
"sampleUtterances": [
"Order me a pizza.",
"Order me a {Type} pizza.",
"I want a {Crust} crust {Type} pizza",
"I want a {Crust} crust {Type} pizza with {Sauce} sauce."
],
"slots": [
{
"name": "Type",
"description": "The type of pizza to order.",
"priority": 1,
"sampleUtterances": [
"Get me a {Type} pizza.",
"A {Type} pizza please.",
"I'd like a {Type} pizza."
],
"slotConstraint": "Required",
"slotType": "DocPizzaType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of pizza would you like?",
"contentType": "PlainText"
},
{
"content": "Vegie or cheese pizza?",
"contentType": "PlainText"
},
{
"content": "I can get you a vegie or a cheese pizza.",
"contentType": "PlainText"
}
]
}
},
{
"name": "Crust",
"description": "The type of pizza crust to order.",
"priority": 2,
"sampleUtterances": [
"Make it a {Crust} crust.",
"I'd like a {Crust} crust."
],
"slotConstraint": "Required",
"slotType": "DocPizzaCrustType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of crust would you like?",
"contentType": "PlainText"
},
{
"content": "Thick or thin crust?",
"contentType": "PlainText"
}
]
}
},
{
"name": "Sauce",
"description": "The type of sauce to use on the pizza.",
"priority": 3,
"sampleUtterances": [
"Make it {Sauce} sauce.",
"I'd like {Sauce} sauce."
],
"slotConstraint": "Required",
"slotType": "DocPizzaSauceType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "White or red sauce?",
"contentType": "PlainText"
},
{
"content": "Garlic or tomato sauce?",
"contentType": "PlainText"
}
]
}
}
]
},
"output": {
"version": "$LATEST",
"name": "DocOrderPizza",
"checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6",
"conclusionStatement": {
"messages": [
{
"content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.",
"contentType": "PlainText"
},
{
"content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.",
"contentType": "PlainText"
}
],
"responseCard": "foo"
},
"confirmationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?",
"contentType": "PlainText"
}
]
},
"createdDate": 1494359783.453,
"description": "Order a pizza from a local pizzeria.",
"fulfillmentActivity": {
"type": "ReturnIntent"
},
"lastUpdatedDate": 1494359783.453,
"rejectionStatement": {
"messages": [
{
"content": "Ok, I'll cancel your order.",
"contentType": "PlainText"
},
{
"content": "I cancelled your order.",
"contentType": "PlainText"
}
]
},
"sampleUtterances": [
"Order me a pizza.",
"Order me a {Type} pizza.",
"I want a {Crust} crust {Type} pizza",
"I want a {Crust} crust {Type} pizza with {Sauce} sauce."
],
"slots": [
{
"name": "Sauce",
"description": "The type of sauce to use on the pizza.",
"priority": 3,
"sampleUtterances": [
"Make it {Sauce} sauce.",
"I'd like {Sauce} sauce."
],
"slotConstraint": "Required",
"slotType": "DocPizzaSauceType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "White or red sauce?",
"contentType": "PlainText"
},
{
"content": "Garlic or tomato sauce?",
"contentType": "PlainText"
}
]
}
},
{
"name": "Type",
"description": "The type of pizza to order.",
"priority": 1,
"sampleUtterances": [
"Get me a {Type} pizza.",
"A {Type} pizza please.",
"I'd like a {Type} pizza."
],
"slotConstraint": "Required",
"slotType": "DocPizzaType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of pizza would you like?",
"contentType": "PlainText"
},
{
"content": "Vegie or cheese pizza?",
"contentType": "PlainText"
},
{
"content": "I can get you a vegie or a cheese pizza.",
"contentType": "PlainText"
}
]
}
},
{
"name": "Crust",
"description": "The type of pizza crust to order.",
"priority": 2,
"sampleUtterances": [
"Make it a {Crust} crust.",
"I'd like a {Crust} crust."
],
"slotConstraint": "Required",
"slotType": "DocPizzaCrustType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of crust would you like?",
"contentType": "PlainText"
},
{
"content": "Thick or thin crust?",
"contentType": "PlainText"
}
]
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to create an intent for ordering pizzas.",
"id": "to-create-an-intent-1494358144659",
"title": "To create an intent"
}
],
"PutSlotType": [
{
"input": {
"name": "PizzaSauceType",
"description": "Available pizza sauces",
"enumerationValues": [
{
"value": "red"
},
{
"value": "white"
}
]
},
"output": {
"version": "$LATEST",
"name": "DocPizzaSauceType",
"checksum": "cfd00ed1-775d-4357-947c-aca7e73b44ba",
"createdDate": 1494356442.23,
"description": "Available pizza sauces",
"enumerationValues": [
{
"value": "red"
},
{
"value": "white"
}
],
"lastUpdatedDate": 1494356442.23
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example shows how to create a slot type that describes pizza sauces.",
"id": "to-create-a-slot-type-1494357262258",
"title": "To Create a Slot Type"
}
]
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version":"1.0",
"examples":{
}
}

View file

@ -310,6 +310,40 @@
],
"documentation":"<p>Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.</p>"
},
"UpdateMember":{
"name":"UpdateMember",
"http":{
"method":"PATCH",
"requestUri":"/networks/{networkId}/members/{memberId}"
},
"input":{"shape":"UpdateMemberInput"},
"output":{"shape":"UpdateMemberOutput"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Updates a member configuration with new parameters.</p>"
},
"UpdateNode":{
"name":"UpdateNode",
"http":{
"method":"PATCH",
"requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}"
},
"input":{"shape":"UpdateNodeInput"},
"output":{"shape":"UpdateNodeOutput"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Updates a node configuration with new parameters.</p>"
},
"VoteOnProposal":{
"name":"VoteOnProposal",
"http":{
@ -614,6 +648,10 @@
"STANDARD"
]
},
"Enabled":{
"type":"boolean",
"box":true
},
"Framework":{
"type":"string",
"enum":["HYPERLEDGER_FABRIC"]
@ -1092,6 +1130,26 @@
}
}
},
"LogConfiguration":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Enabled",
"documentation":"<p>Indicates whether logging is enabled.</p>"
}
},
"documentation":"<p>A configuration for logging events.</p>"
},
"LogConfigurations":{
"type":"structure",
"members":{
"Cloudwatch":{
"shape":"LogConfiguration",
"documentation":"<p>Parameters for publishing logs to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>A collection of log configurations.</p>"
},
"Member":{
"type":"structure",
"members":{
@ -1115,6 +1173,10 @@
"shape":"MemberFrameworkAttributes",
"documentation":"<p>Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.</p>"
},
"LogPublishingConfiguration":{
"shape":"MemberLogPublishingConfiguration",
"documentation":"<p>Configuration properties for logging events associated with a member.</p>"
},
"Status":{
"shape":"MemberStatus",
"documentation":"<p>The status of a member.</p> <ul> <li> <p> <code>CREATING</code> - The AWS account is in the process of creating a member.</p> </li> <li> <p> <code>AVAILABLE</code> - The member has been created and can participate in the network.</p> </li> <li> <p> <code>CREATE_FAILED</code> - The AWS account attempted to create a member and creation failed.</p> </li> <li> <p> <code>DELETING</code> - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an <code>APPROVED</code> <code>PROPOSAL</code> to remove the member.</p> </li> <li> <p> <code>DELETED</code> - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an <code>APPROVED</code> <code>PROPOSAL</code> to remove the member.</p> </li> </ul>"
@ -1144,6 +1206,10 @@
"FrameworkConfiguration":{
"shape":"MemberFrameworkConfiguration",
"documentation":"<p>Configuration properties of the blockchain framework relevant to the member.</p>"
},
"LogPublishingConfiguration":{
"shape":"MemberLogPublishingConfiguration",
"documentation":"<p/>"
}
},
"documentation":"<p>Configuration properties of the member.</p>"
@ -1180,6 +1246,16 @@
},
"documentation":"<p>Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.</p>"
},
"MemberFabricLogPublishingConfiguration":{
"type":"structure",
"members":{
"CaLogs":{
"shape":"LogConfigurations",
"documentation":"<p>Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.</p>"
}
},
"documentation":"<p>Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.</p>"
},
"MemberFrameworkAttributes":{
"type":"structure",
"members":{
@ -1206,12 +1282,23 @@
"max":20,
"min":1
},
"MemberLogPublishingConfiguration":{
"type":"structure",
"members":{
"Fabric":{
"shape":"MemberFabricLogPublishingConfiguration",
"documentation":"<p>Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.</p>"
}
},
"documentation":"<p>Configuration properties for logging events associated with a member of a Managed Blockchain network.</p>"
},
"MemberStatus":{
"type":"string",
"enum":[
"CREATING",
"AVAILABLE",
"CREATE_FAILED",
"UPDATING",
"DELETING",
"DELETED"
]
@ -1311,7 +1398,7 @@
},
"Edition":{
"shape":"Edition",
"documentation":"<p>The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see <a href=\"https://aws.amazon.com/managed-blockchain/pricing/\">Amazon Managed Blockchain Pricing</a>.</p>"
"documentation":"<p>The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see <a href=\"http://aws.amazon.com/managed-blockchain/pricing/\">Amazon Managed Blockchain Pricing</a>.</p>"
}
},
"documentation":"<p>Attributes of Hyperledger Fabric for a network.</p>"
@ -1322,7 +1409,7 @@
"members":{
"Edition":{
"shape":"Edition",
"documentation":"<p>The edition of Amazon Managed Blockchain that the network uses. For more information, see <a href=\"https://aws.amazon.com/managed-blockchain/pricing/\">Amazon Managed Blockchain Pricing</a>.</p>"
"documentation":"<p>The edition of Amazon Managed Blockchain that the network uses. For more information, see <a href=\"http://aws.amazon.com/managed-blockchain/pricing/\">Amazon Managed Blockchain Pricing</a>.</p>"
}
},
"documentation":"<p>Hyperledger Fabric configuration properties for the network.</p>"
@ -1434,6 +1521,10 @@
"shape":"NodeFrameworkAttributes",
"documentation":"<p>Attributes of the blockchain framework being used.</p>"
},
"LogPublishingConfiguration":{
"shape":"NodeLogPublishingConfiguration",
"documentation":"<p/>"
},
"Status":{
"shape":"NodeStatus",
"documentation":"<p>The status of the node.</p>"
@ -1459,6 +1550,10 @@
"AvailabilityZone":{
"shape":"AvailabilityZoneString",
"documentation":"<p>The Availability Zone in which the node exists.</p>"
},
"LogPublishingConfiguration":{
"shape":"NodeLogPublishingConfiguration",
"documentation":"<p/>"
}
},
"documentation":"<p>Configuration properties of a peer node.</p>"
@ -1477,6 +1572,20 @@
},
"documentation":"<p>Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.</p>"
},
"NodeFabricLogPublishingConfiguration":{
"type":"structure",
"members":{
"ChaincodeLogs":{
"shape":"LogConfigurations",
"documentation":"<p>Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.</p>"
},
"PeerLogs":{
"shape":"LogConfigurations",
"documentation":"<p>Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node. </p>"
}
},
"documentation":"<p>Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.</p>"
},
"NodeFrameworkAttributes":{
"type":"structure",
"members":{
@ -1493,12 +1602,23 @@
"max":20,
"min":1
},
"NodeLogPublishingConfiguration":{
"type":"structure",
"members":{
"Fabric":{
"shape":"NodeFabricLogPublishingConfiguration",
"documentation":"<p>Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.</p>"
}
},
"documentation":"<p>Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.</p>"
},
"NodeStatus":{
"type":"string",
"enum":[
"CREATING",
"AVAILABLE",
"CREATE_FAILED",
"UPDATING",
"DELETING",
"DELETED",
"FAILED"
@ -1575,7 +1695,7 @@
},
"Status":{
"shape":"ProposalStatus",
"documentation":"<p>The status of the proposal. Values are as follows:</p> <ul> <li> <p> <code>IN_PROGRESS</code> - The proposal is active and open for member voting.</p> </li> <li> <p> <code>APPROVED</code> - The proposal was approved with sufficient <code>YES</code> votes among members according to the <code>VotingPolicy</code> specified for the <code>Network</code>. The specified proposal actions are carried out.</p> </li> <li> <p> <code>REJECTED</code> - The proposal was rejected with insufficient <code>YES</code> votes among members according to the <code>VotingPolicy</code> specified for the <code>Network</code>. The specified <code>ProposalActions</code> are not carried out.</p> </li> <li> <p> <code>EXPIRED</code> - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified <code>ProposalActions</code> are not carried out.</p> </li> <li> <p> <code>ACTION_FAILED</code> - One or more of the specified <code>ProposalActions</code> in a proposal that was approved could not be completed because of an error.</p> </li> </ul>"
"documentation":"<p>The status of the proposal. Values are as follows:</p> <ul> <li> <p> <code>IN_PROGRESS</code> - The proposal is active and open for member voting.</p> </li> <li> <p> <code>APPROVED</code> - The proposal was approved with sufficient <code>YES</code> votes among members according to the <code>VotingPolicy</code> specified for the <code>Network</code>. The specified proposal actions are carried out.</p> </li> <li> <p> <code>REJECTED</code> - The proposal was rejected with insufficient <code>YES</code> votes among members according to the <code>VotingPolicy</code> specified for the <code>Network</code>. The specified <code>ProposalActions</code> are not carried out.</p> </li> <li> <p> <code>EXPIRED</code> - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified <code>ProposalActions</code> are not carried out.</p> </li> <li> <p> <code>ACTION_FAILED</code> - One or more of the specified <code>ProposalActions</code> in a proposal that was approved could not be completed because of an error. The <code>ACTION_FAILED</code> status occurs even if only one ProposalAction fails and other actions are successful.</p> </li> </ul>"
},
"CreationDate":{
"shape":"Timestamp",
@ -1777,6 +1897,73 @@
"type":"timestamp",
"timestampFormat":"iso8601"
},
"UpdateMemberInput":{
"type":"structure",
"required":[
"NetworkId",
"MemberId"
],
"members":{
"NetworkId":{
"shape":"ResourceIdString",
"documentation":"<p>The unique ID of the Managed Blockchain network to which the member belongs.</p>",
"location":"uri",
"locationName":"networkId"
},
"MemberId":{
"shape":"ResourceIdString",
"documentation":"<p>The unique ID of the member.</p>",
"location":"uri",
"locationName":"memberId"
},
"LogPublishingConfiguration":{
"shape":"MemberLogPublishingConfiguration",
"documentation":"<p>Configuration properties for publishing to Amazon CloudWatch Logs.</p>"
}
}
},
"UpdateMemberOutput":{
"type":"structure",
"members":{
}
},
"UpdateNodeInput":{
"type":"structure",
"required":[
"NetworkId",
"MemberId",
"NodeId"
],
"members":{
"NetworkId":{
"shape":"ResourceIdString",
"documentation":"<p>The unique ID of the Managed Blockchain network to which the node belongs.</p>",
"location":"uri",
"locationName":"networkId"
},
"MemberId":{
"shape":"ResourceIdString",
"documentation":"<p>The unique ID of the member that owns the node.</p>",
"location":"uri",
"locationName":"memberId"
},
"NodeId":{
"shape":"ResourceIdString",
"documentation":"<p>The unique ID of the node.</p>",
"location":"uri",
"locationName":"nodeId"
},
"LogPublishingConfiguration":{
"shape":"NodeLogPublishingConfiguration",
"documentation":"<p>Configuration properties for publishing to Amazon CloudWatch Logs.</p>"
}
}
},
"UpdateNodeOutput":{
"type":"structure",
"members":{
}
},
"UsernameString":{
"type":"string",
"max":16,

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -99,6 +99,48 @@
],
"documentation": "Adds Sources to flow"
},
"AddFlowVpcInterfaces": {
"name": "AddFlowVpcInterfaces",
"http": {
"method": "POST",
"requestUri": "/v1/flows/{flowArn}/vpcInterfaces",
"responseCode": 201
},
"input": {
"shape": "AddFlowVpcInterfacesRequest"
},
"output": {
"shape": "AddFlowVpcInterfacesResponse",
"documentation": "The following VPC interface was added to the Flow configuration."
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "The request that you submitted is not valid."
},
{
"shape": "InternalServerErrorException",
"documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape": "ForbiddenException",
"documentation": "You don't have the required permissions to perform this operation."
},
{
"shape": "NotFoundException",
"documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape": "ServiceUnavailableException",
"documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape": "TooManyRequestsException",
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation": "Adds VPC interfaces to flow"
},
"CreateFlow": {
"name": "CreateFlow",
"http": {
@ -453,6 +495,48 @@
],
"documentation": "Removes a source from an existing flow. This request can be made only if there is more than one source on the flow."
},
"RemoveFlowVpcInterface": {
"name": "RemoveFlowVpcInterface",
"http": {
"method": "DELETE",
"requestUri": "/v1/flows/{flowArn}/vpcInterfaces/{vpcInterfaceName}",
"responseCode": 200
},
"input": {
"shape": "RemoveFlowVpcInterfaceRequest"
},
"output": {
"shape": "RemoveFlowVpcInterfaceResponse",
"documentation": "VPC interface successfully removed from flow configuration."
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "The request that you submitted is not valid."
},
{
"shape": "InternalServerErrorException",
"documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
},
{
"shape": "ForbiddenException",
"documentation": "You don't have the required permissions to perform this operation."
},
{
"shape": "NotFoundException",
"documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request."
},
{
"shape": "ServiceUnavailableException",
"documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later."
},
{
"shape": "TooManyRequestsException",
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
}
],
"documentation": "Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface."
},
"RevokeFlowEntitlement": {
"name": "RevokeFlowEntitlement",
"http": {
@ -891,6 +975,42 @@
}
}
},
"AddFlowVpcInterfacesRequest": {
"type": "structure",
"members": {
"FlowArn": {
"shape": "__string",
"location": "uri",
"locationName": "flowArn",
"documentation": "The flow that you want to mutate."
},
"VpcInterfaces": {
"shape": "__listOfVpcInterfaceRequest",
"locationName": "vpcInterfaces",
"documentation": "A list of VPC interfaces that you want to add."
}
},
"documentation": "A request to add VPC interfaces to the flow.",
"required": [
"FlowArn",
"VpcInterfaces"
]
},
"AddFlowVpcInterfacesResponse": {
"type": "structure",
"members": {
"FlowArn": {
"shape": "__string",
"locationName": "flowArn",
"documentation": "The ARN of the flow that these VPC interfaces were added to."
},
"VpcInterfaces": {
"shape": "__listOfVpcInterface",
"locationName": "vpcInterfaces",
"documentation": "The details of the newly added VPC interfaces."
}
}
},
"AddOutputRequest": {
"type": "structure",
"members": {
@ -948,6 +1068,11 @@
"shape": "__string",
"locationName": "streamId",
"documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."
},
"VpcInterfaceAttachment": {
"shape": "VpcInterfaceAttachment",
"locationName": "vpcInterfaceAttachment",
"documentation": "The name of the VPC interface attachment to use for this output."
}
},
"documentation": "The output that you want to add to this flow.",
@ -1033,6 +1158,11 @@
"Sources": {
"shape": "__listOfSetSourceRequest",
"locationName": "sources"
},
"VpcInterfaces": {
"shape": "__listOfVpcInterfaceRequest",
"locationName": "vpcInterfaces",
"documentation": "The VPC interfaces you want on the flow."
}
},
"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).",
@ -1270,6 +1400,11 @@
"shape": "Status",
"locationName": "status",
"documentation": "The current status of the flow."
},
"VpcInterfaces": {
"shape": "__listOfVpcInterface",
"locationName": "vpcInterfaces",
"documentation": "The VPC Interfaces for this flow."
}
},
"documentation": "The settings for a flow, including its source, outputs, and entitlements.",
@ -1660,6 +1795,11 @@
"shape": "Transport",
"locationName": "transport",
"documentation": "Attributes related to the transport stream that are used in the output."
},
"VpcInterfaceAttachment": {
"shape": "VpcInterfaceAttachment",
"locationName": "vpcInterfaceAttachment",
"documentation": "The name of the VPC interface attachment to use for this output."
}
},
"documentation": "The settings for an output.",
@ -1750,6 +1890,47 @@
}
}
},
"RemoveFlowVpcInterfaceRequest": {
"type": "structure",
"members": {
"FlowArn": {
"shape": "__string",
"location": "uri",
"locationName": "flowArn",
"documentation": "The flow that you want to remove a VPC interface from."
},
"VpcInterfaceName": {
"shape": "__string",
"location": "uri",
"locationName": "vpcInterfaceName",
"documentation": "The name of the VPC interface that you want to remove."
}
},
"required": [
"FlowArn",
"VpcInterfaceName"
]
},
"RemoveFlowVpcInterfaceResponse": {
"type": "structure",
"members": {
"FlowArn": {
"shape": "__string",
"locationName": "flowArn",
"documentation": "The ARN of the flow that is associated with the VPC interface you removed."
},
"NonDeletedNetworkInterfaceIds": {
"shape": "__listOf__string",
"locationName": "nonDeletedNetworkInterfaceIds",
"documentation": "IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove."
},
"VpcInterfaceName": {
"shape": "__string",
"locationName": "vpcInterfaceName",
"documentation": "The name of the VPC interface that was removed."
}
}
},
"ResponseError": {
"type": "structure",
"members": {
@ -1866,6 +2047,11 @@
"locationName": "streamId",
"documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."
},
"VpcInterfaceName": {
"shape": "__string",
"locationName": "vpcInterfaceName",
"documentation": "The name of the VPC interface to use for this source."
},
"WhitelistCidr": {
"shape": "__string",
"locationName": "whitelistCidr",
@ -1922,6 +2108,11 @@
"locationName": "transport",
"documentation": "Attributes related to the transport stream that are used in the source."
},
"VpcInterfaceName": {
"shape": "__string",
"locationName": "vpcInterfaceName",
"documentation": "The name of the VPC Interface this Source is configured with."
},
"WhitelistCidr": {
"shape": "__string",
"locationName": "whitelistCidr",
@ -2303,6 +2494,11 @@
"shape": "__string",
"locationName": "streamId",
"documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."
},
"VpcInterfaceAttachment": {
"shape": "VpcInterfaceAttachment",
"locationName": "vpcInterfaceAttachment",
"documentation": "The name of the VPC interface attachment to use for this output."
}
},
"documentation": "The fields that you want to update in the output.",
@ -2408,6 +2604,11 @@
"locationName": "streamId",
"documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."
},
"VpcInterfaceName": {
"shape": "__string",
"locationName": "vpcInterfaceName",
"documentation": "The name of the VPC Interface to configure this Source with."
},
"WhitelistCidr": {
"shape": "__string",
"locationName": "whitelistCidr",
@ -2435,6 +2636,87 @@
}
}
},
"VpcInterface": {
"type": "structure",
"members": {
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "Immutable and has to be a unique against other VpcInterfaces in this Flow"
},
"NetworkInterfaceIds": {
"shape": "__listOf__string",
"locationName": "networkInterfaceIds",
"documentation": "IDs of the network interfaces created in customer's account by MediaConnect."
},
"RoleArn": {
"shape": "__string",
"locationName": "roleArn",
"documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account"
},
"SecurityGroupIds": {
"shape": "__listOf__string",
"locationName": "securityGroupIds",
"documentation": "Security Group IDs to be used on ENI."
},
"SubnetId": {
"shape": "__string",
"locationName": "subnetId",
"documentation": "Subnet must be in the AZ of the Flow"
}
},
"documentation": "The settings for a VPC Source.",
"required": [
"NetworkInterfaceIds",
"SubnetId",
"SecurityGroupIds",
"RoleArn",
"Name"
]
},
"VpcInterfaceAttachment": {
"type": "structure",
"members": {
"VpcInterfaceName": {
"shape": "__string",
"locationName": "vpcInterfaceName",
"documentation": "The name of the VPC interface to use for this output."
}
},
"documentation": "The settings for attaching a VPC interface to an output."
},
"VpcInterfaceRequest": {
"type": "structure",
"members": {
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "The name of the VPC Interface. This value must be unique within the current flow."
},
"RoleArn": {
"shape": "__string",
"locationName": "roleArn",
"documentation": "Role Arn MediaConnect can assumes to create ENIs in customer's account"
},
"SecurityGroupIds": {
"shape": "__listOf__string",
"locationName": "securityGroupIds",
"documentation": "Security Group IDs to be used on ENI."
},
"SubnetId": {
"shape": "__string",
"locationName": "subnetId",
"documentation": "Subnet must be in the AZ of the Flow"
}
},
"documentation": "Desired VPC Interface for a Flow",
"required": [
"SubnetId",
"SecurityGroupIds",
"RoleArn",
"Name"
]
},
"__boolean": {
"type": "boolean"
},
@ -2492,6 +2774,18 @@
"shape": "Source"
}
},
"__listOfVpcInterface": {
"type": "list",
"member": {
"shape": "VpcInterface"
}
},
"__listOfVpcInterfaceRequest": {
"type": "list",
"member": {
"shape": "VpcInterfaceRequest"
}
},
"__listOf__integer": {
"type": "list",
"member": {
@ -2529,4 +2823,4 @@
}
},
"documentation": "API for AWS Elemental MediaConnect"
}
}

View file

@ -1264,7 +1264,7 @@
"documentation": "Specify the conditions when the service will run your job with accelerated transcoding."
}
},
"documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.",
"documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content.",
"required": [
"Mode"
]
@ -1824,7 +1824,7 @@
},
"BillingTagsSource": {
"type": "string",
"documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.",
"documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.",
"enum": [
"QUEUE",
"PRESET",
@ -2142,6 +2142,22 @@
},
"documentation": "Set up captions in your outputs by first selecting them from your input here."
},
"CaptionSourceFramerate": {
"type": "structure",
"members": {
"FramerateDenominator": {
"shape": "__integerMin1Max1001",
"locationName": "framerateDenominator",
"documentation": "Specify the denominator of the fraction that represents the framerate for the setting Caption source framerate (CaptionSourceFramerate). Use this setting along with the setting Framerate numerator (framerateNumerator)."
},
"FramerateNumerator": {
"shape": "__integerMin1Max60000",
"locationName": "framerateNumerator",
"documentation": "Specify the numerator of the fraction that represents the framerate for the setting Caption source framerate (CaptionSourceFramerate). Use this setting along with the setting Framerate denominator (framerateDenominator)."
}
},
"documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing framerates between your input captions and input video, specify the framerate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps."
},
"CaptionSourceSettings": {
"type": "structure",
"members": {
@ -2664,7 +2680,7 @@
"AccelerationSettings": {
"shape": "AccelerationSettings",
"locationName": "accelerationSettings",
"documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide."
"documentation": "Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide."
},
"BillingTagsSource": {
"shape": "BillingTagsSource",
@ -2674,18 +2690,23 @@
"ClientRequestToken": {
"shape": "__string",
"locationName": "clientRequestToken",
"documentation": "Idempotency token for CreateJob operation.",
"documentation": "Optional. Idempotency token for CreateJob operation.",
"idempotencyToken": true
},
"HopDestinations": {
"shape": "__listOfHopDestination",
"locationName": "hopDestinations",
"documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide."
},
"JobTemplate": {
"shape": "__string",
"locationName": "jobTemplate",
"documentation": "When you create a job, you can either specify a job template or specify the transcoding settings individually"
"documentation": "Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually."
},
"Priority": {
"shape": "__integerMinNegative50Max50",
"locationName": "priority",
"documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0."
"documentation": "Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0."
},
"Queue": {
"shape": "__string",
@ -2705,22 +2726,22 @@
"SimulateReservedQueue": {
"shape": "SimulateReservedQueue",
"locationName": "simulateReservedQueue",
"documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default."
"documentation": "Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default."
},
"StatusUpdateInterval": {
"shape": "StatusUpdateInterval",
"locationName": "statusUpdateInterval",
"documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error."
"documentation": "Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error."
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
"documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key."
"documentation": "Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key."
},
"UserMetadata": {
"shape": "__mapOf__string",
"locationName": "userMetadata",
"documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs."
"documentation": "Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs."
}
},
"required": [
@ -2756,6 +2777,11 @@
"locationName": "description",
"documentation": "Optional. A description of the job template you are creating."
},
"HopDestinations": {
"shape": "__listOfHopDestination",
"locationName": "hopDestinations",
"documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -4080,6 +4106,11 @@
"locationName": "convert608To708",
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708."
},
"Framerate": {
"shape": "CaptionSourceFramerate",
"locationName": "framerate",
"documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing framerates between your input captions and input video, specify the framerate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps."
},
"SourceFile": {
"shape": "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI",
"locationName": "sourceFile",
@ -5589,6 +5620,27 @@
"TDRL"
]
},
"HopDestination": {
"type": "structure",
"members": {
"Priority": {
"shape": "__integerMinNegative50Max50",
"locationName": "priority",
"documentation": "Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue."
},
"Queue": {
"shape": "__string",
"locationName": "queue",
"documentation": "Optional unless the job is submitted on the default queue. When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue."
},
"WaitMinutes": {
"shape": "__integer",
"locationName": "waitMinutes",
"documentation": "Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 1440 minutes, inclusive."
}
},
"documentation": "Optional. Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed."
},
"Id3Insertion": {
"type": "structure",
"members": {
@ -6013,7 +6065,7 @@
"BillingTagsSource": {
"shape": "BillingTagsSource",
"locationName": "billingTagsSource",
"documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted."
"documentation": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up."
},
"CreatedAt": {
"shape": "__timestampUnix",
@ -6035,6 +6087,11 @@
"locationName": "errorMessage",
"documentation": "Error message of Job"
},
"HopDestinations": {
"shape": "__listOfHopDestination",
"locationName": "hopDestinations",
"documentation": "Optional list of hop destinations."
},
"Id": {
"shape": "__string",
"locationName": "id",
@ -6068,7 +6125,12 @@
"Queue": {
"shape": "__string",
"locationName": "queue",
"documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html"
"documentation": "When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html"
},
"QueueTransitions": {
"shape": "__listOfQueueTransition",
"locationName": "queueTransitions",
"documentation": "The job's queue hopping history."
},
"RetryCount": {
"shape": "__integer",
@ -6232,6 +6294,11 @@
"locationName": "description",
"documentation": "An optional description you create for each job template."
},
"HopDestinations": {
"shape": "__listOfHopDestination",
"locationName": "hopDestinations",
"documentation": "Optional list of hop destinations."
},
"LastUpdated": {
"shape": "__timestampUnix",
"locationName": "lastUpdated",
@ -6561,7 +6628,7 @@
"Order": {
"shape": "Order",
"locationName": "order",
"documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"location": "querystring"
}
}
@ -6593,25 +6660,25 @@
"NextToken": {
"shape": "__string",
"locationName": "nextToken",
"documentation": "Use this string, provided with the response to a previous request, to request the next batch of jobs.",
"documentation": "Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.",
"location": "querystring"
},
"Order": {
"shape": "Order",
"locationName": "order",
"documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"location": "querystring"
},
"Queue": {
"shape": "__string",
"locationName": "queue",
"documentation": "Provide a queue name to get back only jobs from that queue.",
"documentation": "Optional. Provide a queue name to get back only jobs from that queue.",
"location": "querystring"
},
"Status": {
"shape": "JobStatus",
"locationName": "status",
"documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.",
"documentation": "Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.",
"location": "querystring"
}
}
@ -6661,7 +6728,7 @@
"Order": {
"shape": "Order",
"locationName": "order",
"documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"location": "querystring"
}
}
@ -6705,7 +6772,7 @@
"Order": {
"shape": "Order",
"locationName": "order",
"documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"location": "querystring"
}
}
@ -7997,7 +8064,7 @@
},
"Order": {
"type": "string",
"documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.",
"enum": [
"ASCENDING",
"DESCENDING"
@ -8476,6 +8543,27 @@
"PAUSED"
]
},
"QueueTransition": {
"type": "structure",
"members": {
"DestinationQueue": {
"shape": "__string",
"locationName": "destinationQueue",
"documentation": "The queue that the job was on after the transition."
},
"SourceQueue": {
"shape": "__string",
"locationName": "sourceQueue",
"documentation": "The queue that the job was on before the transition."
},
"Timestamp": {
"shape": "__timestampUnix",
"locationName": "timestamp",
"documentation": "The time, in Unix epoch format, that the job moved from the source queue to the destination queue."
}
},
"documentation": "Description of the source and destination queues between which the job has moved, along with the timestamp of the move"
},
"Rectangle": {
"type": "structure",
"members": {
@ -9095,6 +9183,11 @@
"locationName": "description",
"documentation": "The new description for the job template, if you are changing it."
},
"HopDestinations": {
"shape": "__listOfHopDestination",
"locationName": "hopDestinations",
"documentation": "Optional list of hop destinations."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -9758,6 +9851,11 @@
"min": 1,
"max": 6
},
"__integerMin1Max60000": {
"type": "integer",
"min": 1,
"max": 60000
},
"__integerMin1Max64": {
"type": "integer",
"min": 1,
@ -9947,6 +10045,12 @@
"shape": "HlsCaptionLanguageMapping"
}
},
"__listOfHopDestination": {
"type": "list",
"member": {
"shape": "HopDestination"
}
},
"__listOfId3Insertion": {
"type": "list",
"member": {
@ -10037,6 +10141,12 @@
"shape": "Queue"
}
},
"__listOfQueueTransition": {
"type": "list",
"member": {
"shape": "QueueTransition"
}
},
"__listOfTeletextPageType": {
"type": "list",
"member": {
@ -10306,4 +10416,4 @@
}
},
"documentation": "AWS Elemental MediaConvert"
}
}

View file

@ -2572,6 +2572,25 @@
"COMMON"
]
},
"AutomaticInputFailoverSettings": {
"type": "structure",
"members": {
"InputPreference": {
"shape": "InputPreference",
"locationName": "inputPreference",
"documentation": "Input preference when deciding which input to make active when a previously failed input has recovered."
},
"SecondaryInputId": {
"shape": "__string",
"locationName": "secondaryInputId",
"documentation": "The input ID of the secondary input in the automatic input failover pair."
}
},
"documentation": "The settings for Automatic Input Failover.",
"required": [
"SecondaryInputId"
]
},
"AvailBlanking": {
"type": "structure",
"members": {
@ -5727,6 +5746,14 @@
"ENABLED"
]
},
"H264ForceFieldPictures": {
"type": "string",
"documentation": "H264 Force Field Pictures",
"enum": [
"DISABLED",
"ENABLED"
]
},
"H264FramerateControl": {
"type": "string",
"documentation": "H264 Framerate Control",
@ -5882,6 +5909,11 @@
"locationName": "flickerAq",
"documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames."
},
"ForceFieldPictures": {
"shape": "H264ForceFieldPictures",
"locationName": "forceFieldPictures",
"documentation": "This setting applies only when scan type is \"interlaced.\" It controls whether coding is on a field basis or a frame basis. (When the video is progressive, the coding is always on a frame basis.)\nenabled: Always code on a field basis, so that odd and even sets of fields are coded separately.\ndisabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis, using PAFF or MBAFF), depending on what is most appropriate for the content."
},
"FramerateControl": {
"shape": "H264FramerateControl",
"locationName": "framerateControl",
@ -7112,6 +7144,11 @@
"InputAttachment": {
"type": "structure",
"members": {
"AutomaticInputFailoverSettings": {
"shape": "AutomaticInputFailoverSettings",
"locationName": "automaticInputFailoverSettings",
"documentation": "User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input."
},
"InputAttachmentName": {
"shape": "__string",
"locationName": "inputAttachmentName",
@ -7373,6 +7410,14 @@
"MAX_50_MBPS"
]
},
"InputPreference": {
"type": "string",
"documentation": "Input preference when deciding which input to make active when a previously failed input has recovered.\nIf \\\"EQUAL_INPUT_PREFERENCE\\\", then the active input will stay active as long as it is healthy.\nIf \\\"PRIMARY_INPUT_PREFERRED\\\", then always switch back to the primary input when it is healthy.\n",
"enum": [
"EQUAL_INPUT_PREFERENCE",
"PRIMARY_INPUT_PREFERRED"
]
},
"InputResolution": {
"type": "string",
"documentation": "Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines\n",

View file

@ -61,7 +61,7 @@
"description": "Wait until a channel has is stopped",
"operation": "DescribeChannel",
"delay": 5,
"maxAttempts": 28,
"maxAttempts": 60,
"acceptors": [
{
"state": "success",
@ -86,7 +86,7 @@
"description": "Wait until a channel has been deleted",
"operation": "DescribeChannel",
"delay": 5,
"maxAttempts": 20,
"maxAttempts": 84,
"acceptors": [
{
"state": "success",

View file

@ -444,6 +444,49 @@
"documentation": "A collection of MediaPackage VOD PackagingGroup resources.",
"shape": "ListPackagingGroupsResponse"
}
},
"ListTagsForResource": {
"documentation": "List tags for a given MediaPackage VOD resource",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/tags/{resource-arn}",
"responseCode": 200
},
"input": {
"shape": "ListTagsForResourceRequest"
},
"name": "ListTagsForResource",
"output": {
"documentation": "200 response",
"shape": "ListTagsForResourceResponse"
}
},
"TagResource": {
"documentation": "Set tags for a given MediaPackage VOD resource",
"errors": [],
"http": {
"method": "POST",
"requestUri": "/tags/{resource-arn}",
"responseCode": 204
},
"input": {
"shape": "TagResourceRequest"
},
"name": "TagResource"
},
"UntagResource": {
"documentation": "Delete tags for a given MediaPackage VOD resource",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/tags/{resource-arn}",
"responseCode": 204
},
"input": {
"shape": "UntagResourceRequest"
},
"name": "UntagResource"
}
},
"shapes": {
@ -497,6 +540,10 @@
"documentation": "The IAM role_arn used to access the source S3 bucket.",
"locationName": "sourceRoleArn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -528,6 +575,10 @@
"documentation": "The IAM role ARN used to access the source S3 bucket.",
"locationName": "sourceRoleArn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"required": [
@ -591,6 +642,10 @@
"documentation": "The IAM role ARN used to access the source S3 bucket.",
"locationName": "sourceRoleArn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -658,6 +713,10 @@
"documentation": "The IAM role ARN used to access the source S3 bucket.",
"locationName": "sourceRoleArn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"required": [
@ -709,6 +768,10 @@
"documentation": "The IAM role_arn used to access the source S3 bucket.",
"locationName": "sourceRoleArn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -741,6 +804,10 @@
"documentation": "The ID of a PackagingGroup.",
"locationName": "packagingGroupId",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"required": [
@ -781,6 +848,10 @@
"documentation": "The ID of a PackagingGroup.",
"locationName": "packagingGroupId",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -792,6 +863,10 @@
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"required": [
@ -815,6 +890,10 @@
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -1004,6 +1083,10 @@
"documentation": "The IAM role_arn used to access the source S3 bucket.",
"locationName": "sourceRoleArn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -1054,6 +1137,10 @@
"documentation": "The ID of a PackagingGroup.",
"locationName": "packagingGroupId",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -1088,6 +1175,10 @@
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -1337,6 +1428,28 @@
},
"type": "structure"
},
"ListTagsForResourceRequest": {
"members": {
"ResourceArn": {
"location": "uri",
"locationName": "resource-arn",
"shape": "__string"
}
},
"required": [
"ResourceArn"
],
"type": "structure"
},
"ListTagsForResourceResponse": {
"members": {
"Tags": {
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"ManifestLayout": {
"enum": [
"FULL",
@ -1447,6 +1560,10 @@
"documentation": "The ID of a PackagingGroup.",
"locationName": "packagingGroupId",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -1479,6 +1596,10 @@
"documentation": "The ID of a PackagingGroup.",
"locationName": "packagingGroupId",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"required": [
@ -1520,6 +1641,10 @@
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
@ -1531,6 +1656,10 @@
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"required": [
@ -1638,6 +1767,46 @@
},
"type": "structure"
},
"TagResourceRequest": {
"members": {
"ResourceArn": {
"location": "uri",
"locationName": "resource-arn",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"ResourceArn",
"Tags"
],
"type": "structure"
},
"Tags": {
"documentation": "A collection of tags associated with a resource",
"key": {
"shape": "__string"
},
"type": "map",
"value": {
"shape": "__string"
}
},
"TagsModel": {
"members": {
"Tags": {
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"Tags"
],
"type": "structure"
},
"TooManyRequestsException": {
"documentation": "The client has exceeded their resource or throttling limits.",
"error": {
@ -1666,6 +1835,26 @@
},
"type": "structure"
},
"UntagResourceRequest": {
"members": {
"ResourceArn": {
"location": "uri",
"locationName": "resource-arn",
"shape": "__string"
},
"TagKeys": {
"documentation": "The key(s) of tag to be deleted",
"location": "querystring",
"locationName": "tagKeys",
"shape": "__listOf__string"
}
},
"required": [
"TagKeys",
"ResourceArn"
],
"type": "structure"
},
"__PeriodTriggersElement": {
"enum": [
"ADS"
@ -1738,6 +1927,15 @@
"__long": {
"type": "long"
},
"__mapOf__string": {
"key": {
"shape": "__string"
},
"type": "map",
"value": {
"shape": "__string"
}
},
"__string": {
"type": "string"
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -92,6 +92,22 @@
],
"documentation":"<p>Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.</p>"
},
"DeleteMetricPolicy":{
"name":"DeleteMetricPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteMetricPolicyInput"},
"output":{"shape":"DeleteMetricPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"PolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.</p>"
},
"DescribeContainer":{
"name":"DescribeContainer",
"http":{
@ -154,6 +170,22 @@
],
"documentation":"<p>Retrieves the object lifecycle policy that is assigned to a container.</p>"
},
"GetMetricPolicy":{
"name":"GetMetricPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetMetricPolicyInput"},
"output":{"shape":"GetMetricPolicyOutput"},
"errors":[
{"shape":"ContainerNotFoundException"},
{"shape":"PolicyNotFoundException"},
{"shape":"ContainerInUseException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the metric policy for the specified container. </p>"
},
"ListContainers":{
"name":"ListContainers",
"http":{
@ -227,6 +259,21 @@
],
"documentation":"<p>Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.</p> <p>For information about how to construct an object lifecycle policy, see <a href=\"https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html\">Components of an Object Lifecycle Policy</a>.</p>"
},
"PutMetricPolicy":{
"name":"PutMetricPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutMetricPolicyInput"},
"output":{"shape":"PutMetricPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.</p>"
},
"StartAccessLogging":{
"name":"StartAccessLogging",
"http":{
@ -352,6 +399,13 @@
"documentation":"<p>The container that you specified in the request already exists or is being updated.</p>",
"exception":true
},
"ContainerLevelMetrics":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"ContainerList":{
"type":"list",
"member":{"shape":"Container"}
@ -520,6 +574,21 @@
"members":{
}
},
"DeleteMetricPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that is associated with the metric policy that you want to delete.</p>"
}
}
},
"DeleteMetricPolicyOutput":{
"type":"structure",
"members":{
}
},
"DescribeContainerInput":{
"type":"structure",
"members":{
@ -616,6 +685,26 @@
}
}
},
"GetMetricPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that is associated with the metric policy.</p>"
}
}
},
"GetMetricPolicyOutput":{
"type":"structure",
"required":["MetricPolicy"],
"members":{
"MetricPolicy":{
"shape":"MetricPolicy",
"documentation":"<p>The metric policy that is associated with the specific container.</p>"
}
}
},
"Header":{
"type":"string",
"max":8192,
@ -705,6 +794,57 @@
"HEAD"
]
},
"MetricPolicy":{
"type":"structure",
"required":["ContainerLevelMetrics"],
"members":{
"ContainerLevelMetrics":{
"shape":"ContainerLevelMetrics",
"documentation":"<p>A setting to enable or disable metrics at the container level.</p>"
},
"MetricPolicyRules":{
"shape":"MetricPolicyRules",
"documentation":"<p>A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also <a href=\"https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas\">request a quota increase</a> to allow up to 300 rules per policy.</p>"
}
},
"documentation":"<p>The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.</p> <p>To view examples of how to construct a metric policy for your use case, see <a href=\"https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html\">Example Metric Policies</a>.</p>"
},
"MetricPolicyRule":{
"type":"structure",
"required":[
"ObjectGroup",
"ObjectGroupName"
],
"members":{
"ObjectGroup":{
"shape":"ObjectGroup",
"documentation":"<p>A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable.</p>"
},
"ObjectGroupName":{
"shape":"ObjectGroupName",
"documentation":"<p>A name that allows you to refer to the object group.</p>"
}
},
"documentation":"<p>A setting that enables metrics at the object level. Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also <a href=\"https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas\">request a quota increase</a> to allow up to 300 rules per policy.</p>"
},
"MetricPolicyRules":{
"type":"list",
"member":{"shape":"MetricPolicyRule"},
"max":300,
"min":1
},
"ObjectGroup":{
"type":"string",
"max":900,
"min":1,
"pattern":"/?(?:[A-Za-z0-9_=:\\.\\-\\~\\*]+/){0,10}(?:[A-Za-z0-9_=:\\.\\-\\~\\*]+)?/?"
},
"ObjectGroupName":{
"type":"string",
"max":30,
"min":1,
"pattern":"[a-zA-Z0-9_]+"
},
"Origin":{
"type":"string",
"max":2048,
@ -791,6 +931,28 @@
"members":{
}
},
"PutMetricPolicyInput":{
"type":"structure",
"required":[
"ContainerName",
"MetricPolicy"
],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that you want to add the metric policy to.</p>"
},
"MetricPolicy":{
"shape":"MetricPolicy",
"documentation":"<p>The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:</p> <ul> <li> <p>An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.</p> </li> <li> <p>An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).</p> </li> </ul>"
}
}
},
"PutMetricPolicyOutput":{
"type":"structure",
"members":{
}
},
"StartAccessLoggingInput":{
"type":"structure",
"required":["ContainerName"],
@ -839,7 +1001,8 @@
"TagKey":{
"type":"string",
"max":128,
"min":1
"min":1,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*"
},
"TagKeyList":{
"type":"list",
@ -847,7 +1010,9 @@
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
"member":{"shape":"Tag"},
"max":200,
"min":1
},
"TagResourceInput":{
"type":"structure",
@ -874,7 +1039,8 @@
"TagValue":{
"type":"string",
"max":256,
"min":0
"min":0,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*"
},
"TimeStamp":{"type":"timestamp"},
"UntagResourceInput":{

View file

@ -141,6 +141,20 @@
}
},
"shapes": {
"AvailSuppression" : {
"type" : "structure",
"documentation" : "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>",
"members" : {
"Mode" : {
"documentation" : "Sets the mode for avail suppression, also known as ad suppression. By default, ad suppression is off and all ad breaks are filled by MediaTailor with ads or slate.",
"shape" : "Mode"
},
"Value" : {
"documentation" : "The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. ",
"shape" : "__string"
}
}
},
"BadRequestException": {
"documentation": "<p>Invalid request parameters.</p>",
"error": {
@ -242,6 +256,10 @@
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression" : {
"shape" : "AvailSuppression",
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
@ -368,14 +386,25 @@
"MULTI_PERIOD"
],
"type": "string"
},
},
"Mode": {
"enum": [
"OFF",
"BEHIND_LIVE_EDGE"
],
"type": "string"
},
"PlaybackConfiguration": {
"documentation": "<p>The AWSMediaTailor configuration.</p>",
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
},
"AvailSuppression":{
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>",
"shape": "AvailSuppression"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
@ -447,7 +476,11 @@
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
},
"AvailSuppression" : {
"shape" : "AvailSuppression",
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
@ -493,7 +526,11 @@
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
},
"AvailSuppression" : {
"shape" : "AvailSuppression",
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"

View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View file

@ -22,6 +22,7 @@
"output":{"shape":"AssociateCreatedArtifactResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -42,6 +43,7 @@
"output":{"shape":"AssociateDiscoveredResourceResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -63,6 +65,7 @@
"output":{"shape":"CreateProgressUpdateStreamResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -82,6 +85,7 @@
"output":{"shape":"DeleteProgressUpdateStreamResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -102,6 +106,7 @@
"output":{"shape":"DescribeApplicationStateResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -121,6 +126,7 @@
"output":{"shape":"DescribeMigrationTaskResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -139,6 +145,7 @@
"output":{"shape":"DisassociateCreatedArtifactResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -159,6 +166,7 @@
"output":{"shape":"DisassociateDiscoveredResourceResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -179,6 +187,7 @@
"output":{"shape":"ImportMigrationTaskResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -199,6 +208,7 @@
"output":{"shape":"ListApplicationStatesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -216,6 +226,7 @@
"output":{"shape":"ListCreatedArtifactsResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -234,6 +245,7 @@
"output":{"shape":"ListDiscoveredResourcesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -252,6 +264,7 @@
"output":{"shape":"ListMigrationTasksResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -271,6 +284,7 @@
"output":{"shape":"ListProgressUpdateStreamsResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
@ -288,6 +302,7 @@
"output":{"shape":"NotifyApplicationStateResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -309,6 +324,7 @@
"output":{"shape":"NotifyMigrationTaskStateResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -329,6 +345,7 @@
"output":{"shape":"PutResourceAttributesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
@ -352,7 +369,8 @@
"ApplicationId":{
"type":"string",
"max":1600,
"min":1
"min":1,
"pattern":"^.{1,1600}$"
},
"ApplicationIds":{
"type":"list",
@ -456,7 +474,9 @@
},
"ConfigurationId":{
"type":"string",
"min":1
"max":1600,
"min":1,
"pattern":"^.{1,1600}$"
},
"CreateProgressUpdateStreamRequest":{
"type":"structure",
@ -495,7 +515,8 @@
"CreatedArtifactDescription":{
"type":"string",
"max":500,
"min":0
"min":0,
"pattern":"^.{0,500}$"
},
"CreatedArtifactList":{
"type":"list",
@ -655,7 +676,8 @@
"DiscoveredResourceDescription":{
"type":"string",
"max":500,
"min":0
"min":0,
"pattern":"^.{0,500}$"
},
"DiscoveredResourceList":{
"type":"list",
@ -1156,12 +1178,14 @@
"ResourceAttributeValue":{
"type":"string",
"max":256,
"min":1
"min":1,
"pattern":"^.{1,256}$"
},
"ResourceName":{
"type":"string",
"max":1600,
"min":1
"min":1,
"pattern":"^.{1,1600}$"
},
"ResourceNotFoundException":{
"type":"structure",
@ -1171,6 +1195,7 @@
"documentation":"<p>Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.</p>",
"exception":true
},
"RetryAfterSeconds":{"type":"integer"},
"ServiceUnavailableException":{
"type":"structure",
"members":{
@ -1192,7 +1217,8 @@
"StatusDetail":{
"type":"string",
"max":500,
"min":0
"min":0,
"pattern":"^.{0,500}$"
},
"Task":{
"type":"structure",
@ -1213,7 +1239,28 @@
},
"documentation":"<p>Task object encapsulating task information.</p>"
},
"Token":{"type":"string"},
"ThrottlingException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{
"shape":"ErrorMessage",
"documentation":"<p>A message that provides information about the exception.</p>"
},
"RetryAfterSeconds":{
"shape":"RetryAfterSeconds",
"documentation":"<p>The number of seconds the caller should wait before retrying.</p>"
}
},
"documentation":"<p>The request was denied due to request throttling.</p>",
"exception":true
},
"Token":{
"type":"string",
"max":2048,
"min":0,
"pattern":"^[a-zA-Z0-9\\/\\+\\=]{0,2048}$"
},
"UnauthorizedOperation":{
"type":"structure",
"members":{

View file

@ -25,6 +25,7 @@
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"DryRunOperation"},
{"shape":"InvalidInputException"}
],
@ -42,9 +43,10 @@
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>This API permits filtering on the <code>ControlId</code>, <code>HomeRegion</code>, and <code>RegionControlScope</code> fields.</p>"
"documentation":"<p>This API permits filtering on the <code>ControlId</code> and <code>HomeRegion</code> fields.</p>"
},
"GetHomeRegion":{
"name":"GetHomeRegion",
@ -58,6 +60,7 @@
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns the calling accounts home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call <code>GetHomeRegion</code> at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.</p>"
@ -227,6 +230,7 @@
"exception":true
},
"RequestedTime":{"type":"timestamp"},
"RetryAfterSeconds":{"type":"integer"},
"ServiceUnavailableException":{
"type":"structure",
"members":{
@ -261,6 +265,19 @@
"type":"string",
"enum":["ACCOUNT"]
},
"ThrottlingException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"ErrorMessage"},
"RetryAfterSeconds":{
"shape":"RetryAfterSeconds",
"documentation":"<p>The number of seconds the caller should wait before retrying.</p>"
}
},
"documentation":"<p>The request was denied due to request throttling.</p>",
"exception":true
},
"Token":{
"type":"string",
"max":2048,
@ -268,5 +285,5 @@
"pattern":"^[a-zA-Z0-9\\/\\+\\=]{0,2048}$"
}
},
"documentation":"<p>The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.</p> <p>You can use these APIs within your home region only. If you call these APIs from outside your home region, your calls are rejected, except for the ability to register your agents and connectors. </p> <p> You must call <code>GetHomeRegion</code> at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's Migration Hub home region.</p> <p>The <code>StartDataCollection</code> API call in AWS Application Discovery Service allows your agents and connectors to begin collecting data that flows directly into the home region, and it will prevent you from enabling data collection information to be sent outside the home region. </p> <p>For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference. </p> <note> <p>The Migration Hub Home Region APIs do not support AWS Organizations.</p> </note>"
"documentation":"<p>The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.</p> <ul> <li> <p>You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a <code>HomeRegionNotSetException</code> error is returned.</p> </li> <li> <p>API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.</p> </li> <li> <p>If you call a write API outside the home region, an <code>InvalidInputException</code> is returned.</p> </li> <li> <p>You can call <code>GetHomeRegion</code> action to obtain the account's Migration Hub home region.</p> </li> </ul> <p>For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference. </p>"
}

Some files were not shown because too many files have changed in this diff Show more