dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

New upstream version 1.12.103+repack

Browse source
This commit is contained in:
TANIGUCHI Takaki 2019-02-27 16:30:11 +09:00
parent b72d60923d
commit 5aa18848d9
203 changed files with 19661 additions and 2566 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
PKG-INFO
View file

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

2
botocore.egg-info/PKG-INFO
View file

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

13
botocore.egg-info/SOURCES.txt
View file

@ -83,6 +83,8 @@ botocore/data/autoscaling-plans/2018-01-06/service-2.json
botocore/data/autoscaling/2011-01-01/examples-1.json
botocore/data/autoscaling/2011-01-01/paginators-1.json
botocore/data/autoscaling/2011-01-01/service-2.json
botocore/data/backup/2018-11-15/paginators-1.json
botocore/data/backup/2018-11-15/service-2.json
botocore/data/batch/2016-08-10/examples-1.json
botocore/data/batch/2016-08-10/paginators-1.json
botocore/data/batch/2016-08-10/service-2.json
@ -231,6 +233,9 @@ botocore/data/dms/2016-01-01/examples-1.json
botocore/data/dms/2016-01-01/paginators-1.json
botocore/data/dms/2016-01-01/service-2.json
botocore/data/dms/2016-01-01/waiters-2.json
botocore/data/docdb/2014-10-31/paginators-1.json
botocore/data/docdb/2014-10-31/service-2.json
botocore/data/docdb/2014-10-31/waiters-2.json
botocore/data/ds/2015-04-16/examples-1.json
botocore/data/ds/2015-04-16/paginators-1.json
botocore/data/ds/2015-04-16/service-2.json
@ -330,6 +335,7 @@ botocore/data/globalaccelerator/2018-08-08/paginators-1.json
botocore/data/globalaccelerator/2018-08-08/service-2.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
botocore/data/greengrass/2017-06-07/service-2.json
botocore/data/guardduty/2017-11-28/paginators-1.json
botocore/data/guardduty/2017-11-28/service-2.json
@ -352,6 +358,7 @@ botocore/data/iot-jobs-data/2017-09-29/service-2.json
botocore/data/iot/2015-05-28/examples-1.json
botocore/data/iot/2015-05-28/paginators-1.json
botocore/data/iot/2015-05-28/service-2.json
botocore/data/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/paginators-1.json
botocore/data/iot1click-projects/2018-05-14/service-2.json
@ -447,6 +454,7 @@ 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
botocore/data/pinpoint-email/2018-07-26/service-2.json
botocore/data/pinpoint-sms-voice/2018-09-05/service-2.json
botocore/data/pinpoint/2016-12-01/examples-1.json
botocore/data/pinpoint/2016-12-01/service-2.json
botocore/data/polly/2016-06-10/examples-1.json
@ -568,6 +576,8 @@ botocore/data/waf/2015-08-24/paginators-1.json
botocore/data/waf/2015-08-24/service-2.json
botocore/data/workdocs/2016-05-01/paginators-1.json
botocore/data/workdocs/2016-05-01/service-2.json
botocore/data/worklink/2018-09-25/paginators-1.json
botocore/data/worklink/2018-09-25/service-2.json
botocore/data/workmail/2017-10-01/paginators-1.json
botocore/data/workmail/2017-10-01/service-2.json
botocore/data/workspaces/2015-04-08/examples-1.json
@ -769,7 +779,6 @@ 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
@ -807,6 +816,7 @@ tests/functional/docs/test_glacier.py
tests/functional/docs/test_lex.py
tests/functional/docs/test_s3.py
tests/functional/docs/test_shared_example_config.py
tests/functional/docs/test_sms_voice.py
tests/functional/docs/test_streaming_body.py
tests/functional/leak/__init__.py
tests/functional/leak/test_resource_leaks.py
@ -1074,7 +1084,6 @@ tests/unit/protocols/input/query.json
tests/unit/protocols/input/rest-json.json
tests/unit/protocols/input/rest-xml.json
tests/unit/protocols/output/ec2.json
tests/unit/protocols/output/event-stream.json
tests/unit/protocols/output/json.json
tests/unit/protocols/output/query.json
tests/unit/protocols/output/rest-json.json

2
botocore/__init__.py
View file

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

4
botocore/config.py
View file

@ -35,12 +35,12 @@ class Config(object):
:param user_agent_extra: The value to append to the current User-Agent
header value.
:type connect_timeout: int
:type connect_timeout: float or int
:param connect_timeout: The time in seconds till a timeout exception is
thrown when attempting to make a connection. The default is 60
seconds.
:type read_timeout: int
:type read_timeout: float or int
:param read_timeout: The time in seconds till a timeout exception is
thrown when attempting to read from a connection. The default is
60 seconds.

6
botocore/data/acm-pca/2017-08-22/paginators-1.json
View file

@ -5,6 +5,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "CertificateAuthorities"
},
"ListTags": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Tags"
}
}
}

12
botocore/data/acm-pca/2017-08-22/service-2.json
View file

@ -24,6 +24,7 @@
"errors":[
{"shape":"InvalidArgsException"},
{"shape":"InvalidPolicyException"},
{"shape":"InvalidTagException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this operation returns the Amazon Resource Name (ARN) of the CA.</p>",
@ -231,6 +232,7 @@
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"RequestAlreadyProcessedException"},
{"shape":"RequestInProgressException"},
@ -564,6 +566,10 @@
"IdempotencyToken":{
"shape":"IdempotencyToken",
"documentation":"<p>Alphanumeric string that can be used to distinguish between calls to <b>CreateCertificateAuthority</b>. Idempotency tokens time out after five minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate. As a result, ACM PCA issues only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA.</p>"
}
}
},
@ -1170,7 +1176,7 @@
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagList":{
"type":"list",
@ -1182,7 +1188,7 @@
"type":"string",
"max":256,
"min":0,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TooManyTagsException":{
"type":"structure",
@ -1257,5 +1263,5 @@
]
}
},
"documentation":"<p>You can use the ACM PCA API to create a private certificate authority (CA). You must first call the <a>CreateCertificateAuthority</a> operation. If successful, the operation returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the <a>GetCertificateAuthorityCsr</a> operation to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the <a>ImportCertificateAuthorityCertificate</a> to import your signed private CA certificate into ACM PCA. </p> <p>Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the <a>IssueCertificate</a> operation to issue a certificate. Call the <a>RevokeCertificate</a> operation to revoke a certificate. </p> <note> <p>Certificates issued by your private CA can be trusted only within your organization, not publicly.</p> </note> <p>Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a <a>RevocationConfiguration</a> object when you call the <a>CreateCertificateAuthority</a> operation. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission. </p> <p>You can also call the <a>CreateCertificateAuthorityAuditReport</a> to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the <b>IssueCertificate</b> or <b>RevokeCertificate</b> operation is called. </p>"
"documentation":"<p>You can use the ACM PCA API to create a private certificate authority (CA). You must first call the <a>CreateCertificateAuthority</a> operation. If successful, the operation returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the <a>GetCertificateAuthorityCsr</a> operation to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the <a>ImportCertificateAuthorityCertificate</a> to import your signed private CA certificate into ACM PCA. </p> <p>Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the <a>IssueCertificate</a> operation to issue a certificate. Call the <a>RevokeCertificate</a> operation to revoke a certificate. </p> <note> <p>Certificates issued by your private CA can be trusted only within your organization, not publicly.</p> </note> <p>Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a <a>RevocationConfiguration</a> object when you call the <a>CreateCertificateAuthority</a> operation. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission. </p> <p>You can also call the <a>CreateCertificateAuthorityAuditReport</a> to create an optional audit report, which enumerates all of the issued, valid, expired, and revoked certificates from the CA.</p> <note> <p>Each ACM PCA API operation has a throttling limit which determines the number of times the operation can be called per second. For more information, see <a href=\"acm-pca/latest/userguide/PcaLimits.html#PcaLimits-api\">API Rate Limits in ACM PCA</a> in the ACM PCA user guide.</p> </note>"
}

6
botocore/data/acm-pca/2017-08-22/waiters-2.json
View file

@ -48,6 +48,12 @@
"matcher": "path",
"argument": "AuditReportStatus",
"expected": "SUCCESS"
},
{
"state": "failure",
"matcher": "path",
"argument": "AuditReportStatus",
"expected": "FAILED"
}
]
}

36
botocore/data/alexaforbusiness/2017-11-09/paginators-1.json
View file

@ -41,6 +41,42 @@
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListBusinessReportSchedules": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "BusinessReportSchedules"
},
"ListConferenceProviders": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ConferenceProviders"
},
"ListDeviceEvents": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DeviceEvents"
},
"ListSkillsStoreCategories": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "CategoryList"
},
"ListSkillsStoreSkillsByCategory": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SkillsStoreSkills"
},
"ListSmartHomeAppliances": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SmartHomeAppliances"
}
}
}

27
botocore/data/amplify/2017-07-25/paginators-1.json
View file

@ -1,3 +1,28 @@
{
"pagination": {}
"pagination": {
"ListApps": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "apps"
},
"ListBranches": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "branches"
},
"ListDomainAssociations": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "domainAssociations"
},
"ListJobs": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "jobSummaries"
}
}
}

36
botocore/data/apigateway/2015-07-09/paginators-1.json
View file

@ -71,6 +71,42 @@
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetAuthorizers": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetDocumentationParts": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetDocumentationVersions": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetGatewayResponses": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetRequestValidators": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetSdkTypes": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
}
}
}

4
botocore/data/apigatewaymanagementapi/2018-11-29/service-2.json
View file

@ -40,7 +40,7 @@
"shapes" : {
"Data" : {
"type" : "blob",
"max" : "131072",
"max" : 131072,
"documentation" : "<p>The data to be sent to the client specified by its connection id.</p>"
},
"ForbiddenException" : {
@ -106,4 +106,4 @@
}
},
"documentation" : "<p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>"
}
}

63
botocore/data/apigatewayv2/2018-11-29/paginators-1.json
View file

@ -1,3 +1,64 @@
{
"pagination": {}
"pagination": {
"GetApis": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetAuthorizers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetDeployments": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetDomainNames": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetIntegrationResponses": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetIntegrations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetModels": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetRouteResponses": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetRoutes": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetStages": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
}
}
}

6
botocore/data/application-autoscaling/2016-02-06/paginators-1.json
View file

@ -17,6 +17,12 @@
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "ScalingPolicies"
},
"DescribeScheduledActions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScheduledActions"
}
}
}

130
botocore/data/application-autoscaling/2016-02-06/service-2.json
View file

@ -59,7 +59,7 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Deregisters a 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 a 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>"
},
"DescribeScalableTargets":{
"name":"DescribeScalableTargets",
@ -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 register the 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>"
"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 in and scale out. 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>"
},
"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 register the 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>"
"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>"
},
"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 or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.</p> <p>After you register a scalable target, you can create and apply scaling policies using <a>PutScalingPolicy</a>. You can view the scaling policies for a service namespace using <a>DescribeScalableTargets</a>. If you no longer need a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
"documentation":"<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Each scalable target has a resource ID, scalable dimension, and namespace, as well as values for minimum and maximum capacity. </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 using <a>DescribeScalableTargets</a>. </p> <p>If you no longer need a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
}
},
"shapes":{
@ -228,7 +228,7 @@
"members":{
"MetricName":{
"shape":"MetricName",
"documentation":"<p>The name of the metric.</p>"
"documentation":"<p>The name of the metric. </p>"
},
"Namespace":{
"shape":"MetricNamespace",
@ -236,7 +236,7 @@
},
"Dimensions":{
"shape":"MetricDimensions",
"documentation":"<p>The dimensions of the metric.</p>"
"documentation":"<p>The dimensions of the metric. </p> <p>Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.</p>"
},
"Statistic":{
"shape":"MetricStatistic",
@ -247,7 +247,7 @@
"documentation":"<p>The unit of the metric.</p>"
}
},
"documentation":"<p>Configures a customized metric for a target tracking policy.</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>"
},
"DeleteScalingPolicyRequest":{
"type":"structure",
@ -268,11 +268,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
}
}
},
@ -286,7 +286,8 @@
"required":[
"ServiceNamespace",
"ScheduledActionName",
"ResourceId"
"ResourceId",
"ScalableDimension"
],
"members":{
"ServiceNamespace":{
@ -299,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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
}
}
},
@ -326,11 +327,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
}
}
},
@ -349,11 +350,11 @@
},
"ResourceIds":{
"shape":"ResourceIdsMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -388,11 +389,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -431,11 +432,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -474,11 +475,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. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
@ -510,7 +511,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> on your behalf.</p>",
"documentation":"<p>Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> on your behalf.</p>",
"exception":true
},
"InternalServiceException":{
@ -534,7 +535,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>A per-account resource limit is exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/ApplicationAutoScaling/latest/userguide/application-auto-scaling-limits.html\">Application Auto Scaling Limits</a>.</p>",
"documentation":"<p>A per-account resource limit is exceeded. For more information, see <a href=\"https://docs.aws.amazon.com/ApplicationAutoScaling/latest/userguide/application-auto-scaling-limits.html\">Application Auto Scaling Limits</a>.</p>",
"exception":true
},
"MaxResults":{"type":"integer"},
@ -562,7 +563,7 @@
"documentation":"<p>The value of the dimension.</p>"
}
},
"documentation":"<p>Describes the dimension of a metric.</p>"
"documentation":"<p>Describes the dimension names and values associated with a metric.</p>"
},
"MetricDimensionName":{"type":"string"},
"MetricDimensionValue":{"type":"string"},
@ -635,7 +636,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>Configures a predefined metric for a target tracking policy.</p>"
"documentation":"<p>Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.</p>"
},
"PutScalingPolicyRequest":{
"type":"structure",
@ -656,15 +657,15 @@
},
"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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"PolicyType":{
"shape":"PolicyType",
"documentation":"<p>The policy type. This parameter is required if you are creating a policy.</p> <p>For DynamoDB, only <code>TargetTrackingScaling</code> is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both <code>StepScaling</code> and <code>TargetTrackingScaling</code> are supported. For any other service, only <code>StepScaling</code> is supported.</p>"
"documentation":"<p>The policy type. This parameter is required if you are creating a scaling policy.</p> <p>For information on which services do not support <code>StepScaling</code> or <code>TargetTrackingScaling</code>, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies for Application Auto Scaling</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies for Application Auto Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
},
"StepScalingPolicyConfiguration":{
"shape":"StepScalingPolicyConfiguration",
@ -672,7 +673,7 @@
},
"TargetTrackingScalingPolicyConfiguration":{
"shape":"TargetTrackingScalingPolicyConfiguration",
"documentation":"<p>A target tracking policy.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>TargetTrackingScaling</code>.</p>"
"documentation":"<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>TargetTrackingScaling</code>.</p>"
}
}
},
@ -686,7 +687,7 @@
},
"Alarms":{
"shape":"Alarms",
"documentation":"<p>The CloudWatch alarms created for the target tracking policy.</p>"
"documentation":"<p>The CloudWatch alarms created for the target tracking scaling policy.</p>"
}
}
},
@ -695,7 +696,8 @@
"required":[
"ServiceNamespace",
"ScheduledActionName",
"ResourceId"
"ResourceId",
"ScalableDimension"
],
"members":{
"ServiceNamespace":{
@ -704,7 +706,7 @@
},
"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=\"http://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>"
},
"ScheduledActionName":{
"shape":"ScheduledActionName",
@ -712,11 +714,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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </ul>"
},
"ScalableDimension":{
"shape":"ScalableDimension",
"documentation":"<p>The scalable dimension. This parameter is required if you are creating a scheduled action. 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.</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> </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> </ul>"
},
"StartTime":{
"shape":"TimestampType",
@ -751,23 +753,23 @@
},
"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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"MinCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.</p>"
"documentation":"<p>The minimum value to scale to in response to a scale-in event. This parameter is required to register a scalable target.</p>"
},
"MaxCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.</p>"
"documentation":"<p>The maximum value to scale to in response to a scale-out event. This parameter is required to register 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=\"http://docs.aws.amazon.com/autoscaling/application/userguide/application-autoscaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>"
"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 resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>"
}
}
},
@ -830,19 +832,19 @@
},
"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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"MinCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The minimum value to scale to in response to a scale in event.</p>"
"documentation":"<p>The minimum value to scale to in response to a scale-in event.</p>"
},
"MaxCapacity":{
"shape":"ResourceCapacity",
"documentation":"<p>The maximum value to scale to in response to a scale out event.</p>"
"documentation":"<p>The maximum value to scale to in response to a scale-out event.</p>"
},
"RoleARN":{
"shape":"ResourceIdMaxLen1600",
@ -900,11 +902,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"Description":{
"shape":"XmlString",
@ -979,11 +981,11 @@
},
"ResourceId":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"PolicyType":{
"shape":"PolicyType",
@ -995,7 +997,7 @@
},
"TargetTrackingScalingPolicyConfiguration":{
"shape":"TargetTrackingScalingPolicyConfiguration",
"documentation":"<p>A target tracking policy.</p>"
"documentation":"<p>A target tracking scaling policy.</p>"
},
"Alarms":{
"shape":"Alarms",
@ -1006,7 +1008,7 @@
"documentation":"<p>The Unix timestamp for when the scaling policy was created.</p>"
}
},
"documentation":"<p>Represents a scaling policy.</p>"
"documentation":"<p>Represents a scaling policy to use with Application Auto Scaling.</p>"
},
"ScheduledAction":{
"type":"structure",
@ -1033,15 +1035,15 @@
},
"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=\"http://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>"
},
"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 resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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.</p> </li> </ul>"
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <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 variants - 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> </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.</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> </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> </ul>"
},
"StartTime":{
"shape":"TimestampType",
@ -1121,18 +1123,18 @@
},
"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>"
"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>"
},
"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 event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
},
"MetricAggregationType":{
"shape":"MetricAggregationType",
"documentation":"<p>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>.</p>"
"documentation":"<p>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the value is treated as <code>Average</code>.</p>"
}
},
"documentation":"<p>Represents a step scaling policy configuration.</p>"
"documentation":"<p>Represents a step scaling policy configuration to use with Application Auto Scaling.</p>"
},
"TargetTrackingScalingPolicyConfiguration":{
"type":"structure",
@ -1144,26 +1146,26 @@
},
"PredefinedMetricSpecification":{
"shape":"PredefinedMetricSpecification",
"documentation":"<p>A predefined metric.</p>"
"documentation":"<p>A predefined metric. You can specify either a predefined metric or a customized metric.</p>"
},
"CustomizedMetricSpecification":{
"shape":"CustomizedMetricSpecification",
"documentation":"<p>A customized metric.</p>"
"documentation":"<p>A customized metric. You can specify either a predefined metric or a customized metric.</p>"
},
"ScaleOutCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>"
"documentation":"<p>The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>"
},
"ScaleInCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
"documentation":"<p>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>"
},
"DisableScaleIn":{
"shape":"DisableScaleIn",
"documentation":"<p>Indicates whether scale in by the target tracking policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking 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 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>Represents a target tracking scaling policy configuration.</p>"
"documentation":"<p>Represents a target tracking scaling policy configuration to use with Application Auto Scaling.</p>"
},
"TimestampType":{"type":"timestamp"},
"ValidationException":{
@ -1179,5 +1181,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 your scalable resources. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS or custom resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>Schedule one-time or recurring scaling actions</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Integrating.AutoScaling.html\">Using Amazon Aurora Auto Scaling with Aurora Replicas</a>.</p> </li> <li> <p>Amazon SageMaker endpoint variants. For more information, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html\">Automatically Scaling Amazon SageMaker Models</a>.</p> </li> <li> <p>Custom resources provided by your own applications or services. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>. </p> </li> </ul> <p>To learn more about Application Auto Scaling, see the <a href=\"http://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p> <p>To configure automatic scaling for multiple resources across multiple services, use AWS Auto Scaling to create a scaling plan for your application. For more information, see the <a href=\"http://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html\">AWS Auto Scaling User Guide</a>.</p>"
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for your scalable resources. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS or custom resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>Schedule one-time or recurring scaling actions</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"https://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Integrating.AutoScaling.html\">Using Amazon Aurora Auto Scaling with Aurora Replicas</a>.</p> </li> <li> <p>Amazon SageMaker endpoint variants. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html\">Automatically Scaling Amazon SageMaker Models</a>.</p> </li> <li> <p>Custom resources provided by your own applications or services. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>. </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>"
}

56
botocore/data/appmesh/2018-10-01/service-2.json
View file

@ -11,7 +11,7 @@
"signingName": "appmesh",
"uid": "appmesh-2018-10-01"
},
"documentation": "<p>AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control containerized microservices. App Mesh standardizes how your microservices\n communicate, giving you end-to-end visibility and helping to ensure high-availability for\n your applications.</p>\n <p>App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with Amazon ECS\n (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.</p>\n <note>\n <p>App Mesh supports containerized microservice applications that use service discovery\n naming for their components. To use App Mesh, you must have a containerized application\n running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For\n more information about service discovery on Amazon ECS, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguideservice-discovery.html\">Service Discovery</a> in the\n <i>Amazon Elastic Container Service Developer Guide</i>. Kubernetes <code>kube-dns</code> is supported.\n For more information, see <a href=\"https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/\">DNS\n for Services and Pods</a> in the Kubernetes documentation.</p>\n </note>",
"documentation": "<p>AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control containerized microservices. App Mesh standardizes how your microservices\n communicate, giving you end-to-end visibility and helping to ensure high-availability for\n your applications.</p>\n <p>App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with Amazon ECS\n (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.</p>\n <note>\n <p>App Mesh supports containerized microservice applications that use service discovery\n naming for their components. To use App Mesh, you must have a containerized application\n running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For\n more information about service discovery on Amazon ECS, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a> in the\n <i>Amazon Elastic Container Service Developer Guide</i>. Kubernetes <code>kube-dns</code> is supported.\n For more information, see <a href=\"https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/\">DNS\n for Services and Pods</a> in the Kubernetes documentation.</p>\n </note>",
"operations": {
"CreateMesh": {
"name": "CreateMesh",
@ -370,7 +370,7 @@
"shape": "TooManyRequestsException"
}
],
"documentation": "<p>Describes an existing cluster.</p>"
"documentation": "<p>Describes an existing service mesh.</p>"
},
"DescribeRoute": {
"name": "DescribeRoute",
@ -763,6 +763,11 @@
"fault": true
}
},
"HealthCheckThreshold": {
"type": "integer",
"min": 2,
"max": 10
},
"DeleteMeshOutput": {
"type": "structure",
"members": {
@ -907,6 +912,12 @@
"senderFault": true
}
},
"HealthCheckIntervalMillis": {
"type": "long",
"box": true,
"min": 5000,
"max": 300000
},
"VirtualNodeRef": {
"type": "structure",
"members": {
@ -1011,14 +1022,6 @@
},
"max": 10
},
"DurationMillis": {
"type": "long",
"box": true
},
"NonNegativeInt": {
"type": "integer",
"min": 0
},
"MeshRef": {
"type": "structure",
"members": {
@ -1113,6 +1116,12 @@
"documentation": "",
"payload": "virtualRouter"
},
"HealthCheckTimeoutMillis": {
"type": "long",
"box": true,
"min": 2000,
"max": 60000
},
"CreateVirtualRouterInput": {
"type": "structure",
"required": [
@ -1672,11 +1681,11 @@
},
"createdAt": {
"shape": "Timestamp",
"documentation": "<p>The Unix epoch timestamp in seconds for when the cluster was created.</p>"
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt": {
"shape": "Timestamp",
"documentation": "<p>The Unix epoch timestamp in seconds for when the cluster was last updated.</p>"
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"uid": {
"shape": "String",
@ -1878,7 +1887,7 @@
"members": {
"healthCheck": {
"shape": "HealthCheckPolicy",
"documentation": "<p>The health check information for the listener.</p>\n <note>\n <p>Listener health checks are not available during the App Mesh preview.</p>\n </note>"
"documentation": "<p>The health check information for the listener.</p>"
},
"portMapping": {
"shape": "PortMapping",
@ -1892,37 +1901,44 @@
},
"HealthCheckPolicy": {
"type": "structure",
"required": [
"healthyThreshold",
"intervalMillis",
"protocol",
"timeoutMillis",
"unhealthyThreshold"
],
"members": {
"healthyThreshold": {
"shape": "NonNegativeInt",
"shape": "HealthCheckThreshold",
"documentation": "<p>The number of consecutive successful health checks that must occur before declaring\n listener healthy.</p>"
},
"intervalMillis": {
"shape": "DurationMillis",
"shape": "HealthCheckIntervalMillis",
"documentation": "<p>The time period in milliseconds between each health check execution.</p>"
},
"path": {
"shape": "String",
"documentation": "<p>The destination path for the health check request.</p>"
"documentation": "<p>The destination path for the health check request. This is only required if the\n specified protocol is HTTP; if the protocol is TCP, then this parameter is ignored.</p>"
},
"port": {
"shape": "PortNumber",
"documentation": "<p>The destination port for the health check request.</p>"
"documentation": "<p>The destination port for the health check request. This port must match the port defined\n in the <a>PortMapping</a> for the listener.</p>"
},
"protocol": {
"shape": "PortProtocol",
"documentation": "<p>The protocol for the health check request.</p>"
},
"timeoutMillis": {
"shape": "DurationMillis",
"shape": "HealthCheckTimeoutMillis",
"documentation": "<p>The amount of time to wait when receiving a response from the health check, in\n milliseconds.</p>"
},
"unhealthyThreshold": {
"shape": "NonNegativeInt",
"shape": "HealthCheckThreshold",
"documentation": "<p>The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy. </p>"
}
},
"documentation": "<p>An object representing the health check policy for a virtual node's listener.</p>\n <note>\n <p>Listener health checks are not available during the App Mesh preview.</p>\n </note>"
"documentation": "<p>An object representing the health check policy for a virtual node's listener.</p>"
},
"ListVirtualRoutersInput": {
"type": "structure",

156
botocore/data/appstream/2016-12-01/service-2.json
View file

@ -376,7 +376,7 @@
"errors":[
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a user ID is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>"
"documentation":"<p>Retrieves a list that describes the active streaming sessions for a specified stack and fleet. If a value for <code>UserId</code> is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>"
},
"DescribeStacks":{
"name":"DescribeStacks",
@ -416,7 +416,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Retrieves a list that describes one or more specified users in the user pool, if user names are provided. Otherwise, all users in the user pool are described.</p>"
"documentation":"<p>Retrieves a list that describes one or more specified users in the user pool.</p>"
},
"DisableUser":{
"name":"DisableUser",
@ -501,7 +501,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
},
"StartFleet":{
"name":"StartFleet",
@ -579,7 +579,7 @@
{"shape":"InvalidAccountStatusException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -592,7 +592,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
},
"UpdateDirectoryConfig":{
"name":"UpdateDirectoryConfig",
@ -698,7 +698,7 @@
},
"DisplayName":{
"shape":"String",
"documentation":"<p>The application name for display.</p>"
"documentation":"<p>The application name to display.</p>"
},
"IconURL":{
"shape":"String",
@ -999,19 +999,19 @@
},
"MaxUserDurationInSeconds":{
"shape":"Integer",
"documentation":"<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>"
"documentation":"<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000.</p>"
},
"DisconnectTimeoutInSeconds":{
"shape":"Integer",
"documentation":"<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>"
"documentation":"<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The fleet name for display.</p>"
"documentation":"<p>The fleet name to display.</p>"
},
"EnableDefaultInternetAccess":{
"shape":"BooleanObject",
@ -1019,7 +1019,11 @@
},
"DomainJoinInfo":{
"shape":"DomainJoinInfo",
"documentation":"<p>The information needed to join a Microsoft Active Directory domain.</p>"
"documentation":"<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
}
}
},
@ -1045,7 +1049,7 @@
},
"ImageName":{
"shape":"String",
"documentation":"<p>The name of the image used to create the builder.</p>"
"documentation":"<p>The name of the image used to create the image builder.</p>"
},
"ImageArn":{
"shape":"Arn",
@ -1057,11 +1061,11 @@
},
"Description":{
"shape":"Description",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The image builder name for display.</p>"
"documentation":"<p>The image builder name to display.</p>"
},
"VpcConfig":{
"shape":"VpcConfig",
@ -1073,11 +1077,15 @@
},
"DomainJoinInfo":{
"shape":"DomainJoinInfo",
"documentation":"<p>The information needed to join a Microsoft Active Directory domain.</p>"
"documentation":"<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>"
},
"AppstreamAgentVersion":{
"shape":"AppstreamAgentVersion",
"documentation":"<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
}
}
},
@ -1127,11 +1135,11 @@
},
"Description":{
"shape":"Description",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The stack name for display.</p>"
"documentation":"<p>The stack name to display.</p>"
},
"StorageConnectors":{
"shape":"StorageConnectorList",
@ -1152,6 +1160,10 @@
"ApplicationSettings":{
"shape":"ApplicationSettings",
"documentation":"<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
}
}
},
@ -1182,7 +1194,7 @@
},
"UserId":{
"shape":"StreamingUrlUserId",
"documentation":"<p>The ID of the user.</p>"
"documentation":"<p>The identifier of the user.</p>"
},
"ApplicationId":{
"shape":"String",
@ -1194,7 +1206,7 @@
},
"SessionContext":{
"shape":"String",
"documentation":"<p>The session context. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>The session context. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
}
}
},
@ -1307,7 +1319,7 @@
},
"SharedAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The 12-digit ID of the AWS account for which to delete image permissions.</p>"
"documentation":"<p>The 12-digit identifier of the AWS account for which to delete image permissions.</p>"
}
}
},
@ -1472,7 +1484,7 @@
},
"SharedAwsAccountIds":{
"shape":"AwsAccountIdList",
"documentation":"<p>The 12-digit ID of one or more AWS accounts with which the image is shared.</p>"
"documentation":"<p>The 12-digit identifier of one or more AWS accounts with which the image is shared.</p>"
},
"NextToken":{
"shape":"String",
@ -1558,7 +1570,7 @@
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The user ID.</p>"
"documentation":"<p>The user identifier.</p>"
},
"NextToken":{
"shape":"String",
@ -1570,7 +1582,7 @@
},
"AuthenticationType":{
"shape":"AuthenticationType",
"documentation":"<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>"
"documentation":"<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL, <code>SAML</code> for a SAML 2.0-federated user, or <code>USERPOOL</code> for a user in the AppStream 2.0 user pool. The default is to authenticate users using a streaming URL.</p>"
}
}
},
@ -1707,7 +1719,7 @@
"documentation":"<p>The time the directory configuration was created.</p>"
}
},
"documentation":"<p>Configuration information for the directory used to join domains.</p>"
"documentation":"<p>Describes the configuration information for the directory used to join a streaming instance to a Microsoft Active Directory domain.</p>"
},
"DirectoryConfigList":{
"type":"list",
@ -1783,7 +1795,7 @@
"documentation":"<p>The distinguished name of the organizational unit for computer accounts.</p>"
}
},
"documentation":"<p>Contains the information needed to join a Microsoft Active Directory domain.</p>"
"documentation":"<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>"
},
"DomainList":{
"type":"list",
@ -1822,7 +1834,7 @@
"members":{
"SessionId":{
"shape":"String",
"documentation":"<p>The ID of the streaming session.</p>"
"documentation":"<p>The identifier of the streaming session.</p>"
}
}
},
@ -1855,11 +1867,11 @@
},
"DisplayName":{
"shape":"String",
"documentation":"<p>The fleet name for display.</p>"
"documentation":"<p>The fleet name to display.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"ImageName":{
"shape":"String",
@ -1883,11 +1895,11 @@
},
"MaxUserDurationInSeconds":{
"shape":"Integer",
"documentation":"<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>"
"documentation":"<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000.</p>"
},
"DisconnectTimeoutInSeconds":{
"shape":"Integer",
"documentation":"<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>"
"documentation":"<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000. By default, this value is 900 seconds (15 minutes).</p>"
},
"State":{
"shape":"FleetState",
@ -1911,10 +1923,10 @@
},
"DomainJoinInfo":{
"shape":"DomainJoinInfo",
"documentation":"<p>The information needed to join a Microsoft Active Directory domain.</p>"
"documentation":"<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>"
}
},
"documentation":"<p>Contains the parameters for a fleet.</p>"
"documentation":"<p>Describes the parameters for a fleet.</p>"
},
"FleetAttribute":{
"type":"string",
@ -2018,7 +2030,7 @@
},
"DisplayName":{
"shape":"String",
"documentation":"<p>The image name for display.</p>"
"documentation":"<p>The image name to display.</p>"
},
"State":{
"shape":"ImageState",
@ -2038,7 +2050,7 @@
},
"Description":{
"shape":"String",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"StateChangeReason":{
"shape":"ImageStateChangeReason",
@ -2085,11 +2097,11 @@
},
"Description":{
"shape":"String",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"DisplayName":{
"shape":"String",
"documentation":"<p>The image builder name for display.</p>"
"documentation":"<p>The image builder name to display.</p>"
},
"VpcConfig":{
"shape":"VpcConfig",
@ -2121,7 +2133,7 @@
},
"DomainJoinInfo":{
"shape":"DomainJoinInfo",
"documentation":"<p>The information needed to join a Microsoft Active Directory domain.</p>"
"documentation":"<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>"
},
"ImageBuilderErrors":{
"shape":"ResourceErrors",
@ -2129,10 +2141,10 @@
},
"AppstreamAgentVersion":{
"shape":"AppstreamAgentVersion",
"documentation":"<p>The version of the AppStream 2.0 agent that is currently being used by this image builder. </p>"
"documentation":"<p>The version of the AppStream 2.0 agent that is currently being used by the image builder. </p>"
}
},
"documentation":"<p>Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.</p>"
"documentation":"<p>Describes a virtual machine that is used to create an image. </p>"
},
"ImageBuilderList":{
"type":"list",
@ -2372,7 +2384,7 @@
"documentation":"<p>The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.</p>"
}
},
"documentation":"<p>The network details of the fleet instance for the streaming session.</p>"
"documentation":"<p>Describes the network details of the fleet instance for the streaming session.</p>"
},
"OperationNotPermittedException":{
"type":"structure",
@ -2472,7 +2484,7 @@
"SecurityGroupIdList":{
"type":"list",
"member":{"shape":"String"},
"documentation":"<p>The security group IDs.</p>",
"documentation":"<p>The security group identifiers.</p>",
"max":5
},
"ServiceAccountCredentials":{
@ -2505,7 +2517,7 @@
"members":{
"Id":{
"shape":"String",
"documentation":"<p>The ID of the streaming session.</p>"
"documentation":"<p>The identifier of the streaming session.</p>"
},
"UserId":{
"shape":"UserId",
@ -2523,9 +2535,21 @@
"shape":"SessionState",
"documentation":"<p>The current state of the streaming session.</p>"
},
"ConnectionState":{
"shape":"SessionConnectionState",
"documentation":"<p>Specifies whether a user is connected to the streaming session. </p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The time when a streaming instance is dedicated for the user. </p>"
},
"MaxExpirationTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the streaming session is set to expire. This time is based on the <code>MaxUserDurationinSeconds</code> value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in <code>SessionMaxExpirationTime</code>, when the <code>DisconnectTimeOutInSeconds</code> elapses or the user chooses to end his or her session. If the <code>DisconnectTimeOutInSeconds</code> elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.</p>"
},
"AuthenticationType":{
"shape":"AuthenticationType",
"documentation":"<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML federation (<code>SAML</code>).</p>"
"documentation":"<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>), SAML 2.0 federation (<code>SAML</code>), or the AppStream 2.0 user pool (<code>USERPOOL</code>). The default is to authenticate users using a streaming URL. </p>"
},
"NetworkAccessConfiguration":{
"shape":"NetworkAccessConfiguration",
@ -2534,6 +2558,13 @@
},
"documentation":"<p>Describes a streaming session.</p>"
},
"SessionConnectionState":{
"type":"string",
"enum":[
"CONNECTED",
"NOT_CONNECTED"
]
},
"SessionList":{
"type":"list",
"member":{"shape":"Session"},
@ -2541,7 +2572,6 @@
},
"SessionState":{
"type":"string",
"documentation":"<p>Possible values for the state of a streaming session.</p>",
"enum":[
"ACTIVE",
"PENDING",
@ -2561,7 +2591,7 @@
"members":{
"sharedAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The 12-digit ID of the AWS account with which the image is shared.</p>"
"documentation":"<p>The 12-digit identifier of the AWS account with which the image is shared.</p>"
},
"imagePermissions":{
"shape":"ImagePermissions",
@ -2588,11 +2618,11 @@
},
"Description":{
"shape":"String",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"DisplayName":{
"shape":"String",
"documentation":"<p>The stack name for display.</p>"
"documentation":"<p>The stack name to display.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
@ -2759,7 +2789,7 @@
},
"Domains":{
"shape":"DomainList",
"documentation":"<p>The names of the domains for the G Suite account.</p>"
"documentation":"<p>The names of the domains for the account.</p>"
}
},
"documentation":"<p>Describes a connector to enable persistent storage for users.</p>"
@ -2795,7 +2825,7 @@
"SubnetIdList":{
"type":"list",
"member":{"shape":"String"},
"documentation":"<p>The subnet IDs.</p>"
"documentation":"<p>The subnet identifiers.</p>"
},
"TagKey":{
"type":"string",
@ -2822,7 +2852,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate. A tag is a key-value pair (the value is optional). For example, <code>Environment=Test</code>, or, if you do not specify a value, <code>Environment=</code>. </p> <p>If you do not specify a value, we set the value to an empty string.</p>"
"documentation":"<p>The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p>"
}
}
},
@ -2923,11 +2953,11 @@
},
"MaxUserDurationInSeconds":{
"shape":"Integer",
"documentation":"<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>"
"documentation":"<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 360000. By default, the value is 900 seconds (15 minutes).</p>"
},
"DisconnectTimeoutInSeconds":{
"shape":"Integer",
"documentation":"<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>"
"documentation":"<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 360000. By default, the value is 900 seconds (15 minutes).</p>"
},
"DeleteVpcConfig":{
"shape":"Boolean",
@ -2936,11 +2966,11 @@
},
"Description":{
"shape":"Description",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The fleet name for display.</p>"
"documentation":"<p>The fleet name to display.</p>"
},
"EnableDefaultInternetAccess":{
"shape":"BooleanObject",
@ -2948,7 +2978,7 @@
},
"DomainJoinInfo":{
"shape":"DomainJoinInfo",
"documentation":"<p>The information needed to join a Microsoft Active Directory domain.</p>"
"documentation":"<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>"
},
"AttributesToDelete":{
"shape":"FleetAttributes",
@ -2979,7 +3009,7 @@
},
"SharedAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The 12-digit ID of the AWS account for which you want add or update image permissions.</p>"
"documentation":"<p>The 12-digit identifier of the AWS account for which you want add or update image permissions.</p>"
},
"ImagePermissions":{
"shape":"ImagePermissions",
@ -2998,11 +3028,11 @@
"members":{
"DisplayName":{
"shape":"DisplayName",
"documentation":"<p>The stack name for display.</p>"
"documentation":"<p>The stack name to display.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description for display.</p>"
"documentation":"<p>The description to display.</p>"
},
"Name":{
"shape":"String",
@ -3023,7 +3053,7 @@
},
"FeedbackURL":{
"shape":"FeedbackURL",
"documentation":"<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"
"documentation":"<p>The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"
},
"AttributesToDelete":{
"shape":"StackAttributes",
@ -3206,15 +3236,15 @@
"members":{
"SubnetIds":{
"shape":"SubnetIdList",
"documentation":"<p>The subnets to which a network interface is established from the fleet instance.</p>"
"documentation":"<p>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or two subnets. Image builder instances use one subnet.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIdList",
"documentation":"<p>The security groups for the fleet.</p>"
"documentation":"<p>The identifiers of the security groups for the fleet or image builder.</p>"
}
},
"documentation":"<p>Describes VPC configuration information.</p>"
"documentation":"<p>Describes VPC configuration information for fleets and image builders.</p>"
}
},
"documentation":"<fullname>Amazon AppStream 2.0</fullname> <p>You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.</p>"
"documentation":"<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This reference provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed application streaming service. You centrally manage your desktop applications on AppStream 2.0 and securely deliver them to any computer. AppStream 2.0 manages the AWS resources required to host and run your applications, scales automatically, and provides access to your users on demand.</p> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/appstream2\">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/appstream2\">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>"
}

45
botocore/data/appsync/2017-07-25/paginators-1.json
View file

@ -1,3 +1,46 @@
{
"pagination": {}
"pagination": {
"ListApiKeys": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "apiKeys"
},
"ListDataSources": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "dataSources"
},
"ListFunctions": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "functions"
},
"ListGraphqlApis": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "graphqlApis"
},
"ListResolvers": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "resolvers"
},
"ListResolversByFunction": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "resolvers"
},
"ListTypes": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "types"
}
}
}

600
botocore/data/athena/2017-05-18/service-2.json
View file

@ -24,7 +24,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Use <a>ListNamedQueries</a> to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries are different from executed queries. Use <a>BatchGetQueryExecution</a> to get details about each unique query execution, and <a>ListQueryExecutions</a> to get a list of query execution IDs.</p>"
"documentation":"<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries differ from executed queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of query execution IDs.</p>"
},
"BatchGetQueryExecution":{
"name":"BatchGetQueryExecution",
@ -38,7 +38,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. To get a list of query execution IDs, use <a>ListQueryExecutions</a>. Query executions are different from named (saved) queries. Use <a>BatchGetNamedQuery</a> to get details about named queries.</p>"
"documentation":"<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details about named queries.</p>"
},
"CreateNamedQuery":{
"name":"CreateNamedQuery",
@ -52,9 +52,23 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"documentation":"<p>Creates a named query 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>",
"idempotent":true
},
"CreateWorkGroup":{
"name":"CreateWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateWorkGroupInput"},
"output":{"shape":"CreateWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates a workgroup with the specified name.</p>"
},
"DeleteNamedQuery":{
"name":"DeleteNamedQuery",
"http":{
@ -67,7 +81,22 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"documentation":"<p>Deletes the named query if you have access to the workgroup in which the query was saved.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"DeleteWorkGroup":{
"name":"DeleteWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteWorkGroupInput"},
"output":{"shape":"DeleteWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.</p>",
"idempotent":true
},
"GetNamedQuery":{
@ -82,7 +111,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns information about a single query.</p>"
"documentation":"<p>Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.</p>"
},
"GetQueryExecution":{
"name":"GetQueryExecution",
@ -96,7 +125,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique ID.</p>"
"documentation":"<p>Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.</p>"
},
"GetQueryResults":{
"name":"GetQueryResults",
@ -110,7 +139,21 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>"
"documentation":"<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code> if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>"
},
"GetWorkGroup":{
"name":"GetWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetWorkGroupInput"},
"output":{"shape":"GetWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns information about the workgroup with the specified name.</p>"
},
"ListNamedQueries":{
"name":"ListNamedQueries",
@ -124,7 +167,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of all available query IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
"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>"
},
"ListQueryExecutions":{
"name":"ListQueryExecutions",
@ -138,7 +181,36 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of all available query execution IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
"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>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceInput"},
"output":{"shape":"ListTagsForResourceOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the tags associated with this workgroup.</p>"
},
"ListWorkGroups":{
"name":"ListWorkGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListWorkGroupsInput"},
"output":{"shape":"ListWorkGroupsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists available workgroups for the account.</p>"
},
"StartQueryExecution":{
"name":"StartQueryExecution",
@ -153,7 +225,7 @@
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Runs (executes) the SQL query statements contained in the <code>Query</code> string.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"documentation":"<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to have access to the workgroup in which the query 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>",
"idempotent":true
},
"StopQueryExecution":{
@ -168,11 +240,60 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Stops a query execution.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"documentation":"<p>Stops a query execution. Requires you to have access to the workgroup in which the query 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>",
"idempotent":true
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceInput"},
"output":{"shape":"TagResourceOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">AWS Tagging Strategies</a>. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceInput"},
"output":{"shape":"UntagResourceOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.</p>"
},
"UpdateWorkGroup":{
"name":"UpdateWorkGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateWorkGroupInput"},
"output":{"shape":"UpdateWorkGroupOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.</p>"
}
},
"shapes":{
"AmazonResourceName":{
"type":"string",
"max":1011,
"min":1
},
"BatchGetNamedQueryInput":{
"type":"structure",
"required":["NamedQueryIds"],
@ -220,6 +341,11 @@
}
},
"Boolean":{"type":"boolean"},
"BoxedBoolean":{"type":"boolean"},
"BytesScannedCutoffValue":{
"type":"long",
"min":10000000
},
"ColumnInfo":{
"type":"structure",
"required":[
@ -292,11 +418,11 @@
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The plain language name for the query.</p>"
"documentation":"<p>The query name.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>A brief explanation of the query.</p>"
"documentation":"<p>The query description.</p>"
},
"Database":{
"shape":"DatabaseString",
@ -304,12 +430,16 @@
},
"QueryString":{
"shape":"QueryString",
"documentation":"<p>The text of the query itself. In other words, all query statements.</p>"
"documentation":"<p>The contents of the query with all query statements.</p>"
},
"ClientRequestToken":{
"shape":"IdempotencyToken",
"documentation":"<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>CreateNamedQuery</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>",
"idempotencyToken":true
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the named query is being created.</p>"
}
}
},
@ -322,9 +452,36 @@
}
}
},
"CreateWorkGroupInput":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup name.</p>"
},
"Configuration":{
"shape":"WorkGroupConfiguration",
"documentation":"<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tags, separated by commas, that you want to attach to the workgroup as you create it.</p>"
}
}
},
"CreateWorkGroupOutput":{
"type":"structure",
"members":{
}
},
"DatabaseString":{
"type":"string",
"max":32,
"max":255,
"min":1
},
"Date":{"type":"timestamp"},
@ -354,6 +511,25 @@
"members":{
}
},
"DeleteWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The unique name of the workgroup to delete.</p>"
},
"RecursiveDeleteOption":{
"shape":"BoxedBoolean",
"documentation":"<p>The option to delete the workgroup and its contents even if the workgroup contains any named queries.</p>"
}
}
},
"DeleteWorkGroupOutput":{
"type":"structure",
"members":{
}
},
"DescriptionString":{
"type":"string",
"max":1024,
@ -365,7 +541,7 @@
"members":{
"EncryptionOption":{
"shape":"EncryptionOption",
"documentation":"<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p>"
"documentation":"<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. </p>"
},
"KmsKey":{
"shape":"String",
@ -462,6 +638,25 @@
}
}
},
"GetWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup.</p>"
}
}
},
"GetWorkGroupOutput":{
"type":"structure",
"members":{
"WorkGroup":{
"shape":"WorkGroup",
"documentation":"<p>Information about the workgroup.</p>"
}
}
},
"IdempotencyToken":{
"type":"string",
"max":128,
@ -496,6 +691,10 @@
"MaxResults":{
"shape":"MaxNamedQueriesCount",
"documentation":"<p>The maximum number of queries to return in this request.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup from which the named queries are being returned.</p>"
}
}
},
@ -522,6 +721,10 @@
"MaxResults":{
"shape":"MaxQueryExecutionsCount",
"documentation":"<p>The maximum number of query executions to return in this request.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup from which queries are being returned.</p>"
}
}
},
@ -538,6 +741,63 @@
}
}
},
"ListTagsForResourceInput":{
"type":"structure",
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>Lists the tags for the workgroup resource with the specified ARN.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN.</p>"
},
"MaxResults":{
"shape":"MaxTagsCount",
"documentation":"<p>The maximum number of results to be returned per request that lists the tags for the workgroup resource.</p>"
}
}
},
"ListTagsForResourceOutput":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>The list of tags associated with this workgroup.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"ListWorkGroupsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
},
"MaxResults":{
"shape":"MaxWorkGroupsCount",
"documentation":"<p>The maximum number of workgroups to return in this request.</p>"
}
}
},
"ListWorkGroupsOutput":{
"type":"structure",
"members":{
"WorkGroups":{
"shape":"WorkGroupsList",
"documentation":"<p>The list of workgroups, including their names, descriptions, creation times, and states.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
}
}
},
"Long":{"type":"long"},
"MaxNamedQueriesCount":{
"type":"integer",
@ -557,6 +817,17 @@
"max":1000,
"min":0
},
"MaxTagsCount":{
"type":"integer",
"box":true,
"min":75
},
"MaxWorkGroupsCount":{
"type":"integer",
"box":true,
"max":50,
"min":1
},
"NameString":{
"type":"string",
"max":128,
@ -572,11 +843,11 @@
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The plain-language name of the query.</p>"
"documentation":"<p>The query name.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>A brief description of the query.</p>"
"documentation":"<p>The query description.</p>"
},
"Database":{
"shape":"DatabaseString",
@ -589,9 +860,13 @@
"NamedQueryId":{
"shape":"NamedQueryId",
"documentation":"<p>The unique identifier of the query.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup that contains the named query.</p>"
}
},
"documentation":"<p>A query, where <code>QueryString</code> is the SQL query statements that comprise the query.</p>"
"documentation":"<p>A query, where <code>QueryString</code> is the list of SQL query statements that comprise the query.</p>"
},
"NamedQueryId":{"type":"string"},
"NamedQueryIdList":{
@ -621,7 +896,7 @@
},
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.</p>"
"documentation":"<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>"
},
"QueryExecutionContext":{
"shape":"QueryExecutionContext",
@ -634,6 +909,10 @@
"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>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the query ran.</p>"
}
},
"documentation":"<p>Information about a single instance of a query execution.</p>"
@ -688,7 +967,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 error. <code>FAILED</code> indicates that the query experienced an error and did not complete processing.<code>CANCELLED</code> indicates that user input interrupted query execution. </p>"
"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>"
},
"StateChangeReason":{
"shape":"String",
@ -710,20 +989,50 @@
"max":262144,
"min":1
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceName":{"shape":"AmazonResourceName"}
},
"documentation":"<p>A resource, such as a workgroup, was not found.</p>",
"exception":true
},
"ResultConfiguration":{
"type":"structure",
"required":["OutputLocation"],
"members":{
"OutputLocation":{
"shape":"String",
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files. </a> </p>"
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
"documentation":"<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information.</p>"
"documentation":"<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>"
"documentation":"<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>"
},
"ResultConfigurationUpdates":{
"type":"structure",
"members":{
"OutputLocation":{
"shape":"String",
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"RemoveOutputLocation":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
"documentation":"<p>The encryption configuration for the query results.</p>"
},
"RemoveEncryptionConfiguration":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The information about the updates in the query results, such as output location and encryption configuration for the query results.</p>"
},
"ResultSet":{
"type":"structure",
@ -765,10 +1074,7 @@
},
"StartQueryExecutionInput":{
"type":"structure",
"required":[
"QueryString",
"ResultConfiguration"
],
"required":["QueryString"],
"members":{
"QueryString":{
"shape":"QueryString",
@ -785,7 +1091,11 @@
},
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>Specifies information about where and how to save the results of the query execution.</p>"
"documentation":"<p>Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the query is being started.</p>"
}
}
},
@ -823,19 +1133,77 @@
}
},
"String":{"type":"string"},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource. </p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive. </p>"
}
},
"documentation":"<p>A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. </p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TagResourceInput":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tags, separated by commas, to be added to the resource, such as a workgroup.</p>"
}
}
},
"TagResourceOutput":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"ThrottleReason":{
"type":"string",
"documentation":"<p>The reason for the query throttling, for example, when it exceeds the concurrent query limit.</p>",
"enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"]
},
"Token":{"type":"string"},
"Token":{
"type":"string",
"max":1024,
"min":1
},
"TooManyRequestsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Reason":{"shape":"ThrottleReason"}
},
"documentation":"<p>Indicates that the request was throttled and includes the reason for throttling, for example, the limit of concurrent queries has been exceeded.</p>",
"documentation":"<p>Indicates that the request was throttled.</p>",
"exception":true
},
"UnprocessedNamedQueryId":{
@ -882,6 +1250,174 @@
"type":"list",
"member":{"shape":"UnprocessedQueryExecutionId"}
},
"UntagResourceInput":{
"type":"structure",
"required":[
"ResourceARN",
"TagKeys"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>Removes one or more tags from the workgroup resource for the specified ARN.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>Removes the tags associated with one or more tag keys from the workgroup resource.</p>"
}
}
},
"UntagResourceOutput":{
"type":"structure",
"members":{
}
},
"UpdateWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The specified workgroup that will be updated.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"ConfigurationUpdates":{
"shape":"WorkGroupConfigurationUpdates",
"documentation":"<p>The workgroup configuration that will be updated for the given workgroup.</p>"
},
"State":{
"shape":"WorkGroupState",
"documentation":"<p>The workgroup state that will be updated for the given workgroup.</p>"
}
}
},
"UpdateWorkGroupOutput":{
"type":"structure",
"members":{
}
},
"WorkGroup":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup name.</p>"
},
"State":{
"shape":"WorkGroupState",
"documentation":"<p>The state of the workgroup: ENABLED or DISABLED.</p>"
},
"Configuration":{
"shape":"WorkGroupConfiguration",
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"CreationTime":{
"shape":"Date",
"documentation":"<p>The date and time the workgroup was created.</p>"
}
},
"documentation":"<p>A workgroup, which contains a name, description, creation time, state, and other configuration, listed under <a>WorkGroup$Configuration</a>. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"WorkGroupConfiguration":{
"type":"structure",
"members":{
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>"
},
"EnforceWorkGroupConfiguration":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"PublishCloudWatchMetricsEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</p>"
},
"BytesScannedCutoffPerQuery":{
"shape":"BytesScannedCutoffValue",
"documentation":"<p>The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
}
},
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"WorkGroupConfigurationUpdates":{
"type":"structure",
"members":{
"EnforceWorkGroupConfiguration":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\" client-side settings are used. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
},
"ResultConfigurationUpdates":{
"shape":"ResultConfigurationUpdates",
"documentation":"<p>The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.</p>"
},
"PublishCloudWatchMetricsEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>"
},
"BytesScannedCutoffPerQuery":{
"shape":"BytesScannedCutoffValue",
"documentation":"<p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
},
"RemoveBytesScannedCutoffPerQuery":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a> </p>"
}
},
"documentation":"<p>The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.</p>"
},
"WorkGroupDescriptionString":{
"type":"string",
"max":1024,
"min":0
},
"WorkGroupName":{
"type":"string",
"pattern":"[a-zA-z0-9._-]{1,128}"
},
"WorkGroupState":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"WorkGroupSummary":{
"type":"structure",
"members":{
"Name":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup.</p>"
},
"State":{
"shape":"WorkGroupState",
"documentation":"<p>The state of the workgroup.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
"documentation":"<p>The workgroup description.</p>"
},
"CreationTime":{
"shape":"Date",
"documentation":"<p>The workgroup creation date and time.</p>"
}
},
"documentation":"<p>The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.</p>"
},
"WorkGroupsList":{
"type":"list",
"member":{"shape":"WorkGroupSummary"},
"max":50,
"min":0
},
"datumList":{
"type":"list",
"member":{"shape":"Datum"}

15
botocore/data/autoscaling-plans/2018-01-06/paginators-1.json
View file

@ -1,3 +1,16 @@
{
"pagination": {}
"pagination": {
"DescribeScalingPlanResources": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScalingPlanResources"
},
"DescribeScalingPlans": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScalingPlans"
}
}
}

12
botocore/data/autoscaling/2011-01-01/paginators-1.json
View file

@ -47,6 +47,18 @@
"output_token": "NextToken",
"limit_key": "MaxRecords",
"result_key": "Tags"
},
"DescribeLoadBalancerTargetGroups": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "LoadBalancerTargetGroups"
},
"DescribeLoadBalancers": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "LoadBalancers"
}
}
}

109
botocore/data/autoscaling/2011-01-01/service-2.json
View file

@ -39,7 +39,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group. </p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html\">Attaching a Load Balancer to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancers":{
"name":"AttachLoadBalancers",
@ -56,7 +56,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group.</p> <p>To attach an Application Load Balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group.</p> <p>To attach an Application Load Balancer or a Network Load Balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html\">Attaching a Load Balancer to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"BatchDeleteScheduledAction":{
"name":"BatchDeleteScheduledAction",
@ -121,7 +121,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CreateLaunchConfiguration":{
"name":"CreateLaunchConfiguration",
@ -135,7 +135,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CreateOrUpdateTags":{
"name":"CreateOrUpdateTags",
@ -258,7 +258,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"DescribeAdjustmentTypes":{
"name":"DescribeAdjustmentTypes",
@ -402,7 +402,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the load balancers for the specified Auto Scaling group.</p> <p>This operation describes only Classic Load Balancers. If you have Application Load Balancers, use <a>DescribeLoadBalancerTargetGroups</a> instead.</p>"
"documentation":"<p>Describes the load balancers for the specified Auto Scaling group.</p> <p>This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use <a>DescribeLoadBalancerTargetGroups</a> instead.</p>"
},
"DescribeMetricCollectionTypes":{
"name":"DescribeMetricCollectionTypes",
@ -581,7 +581,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p> <p>This operation detaches only Classic Load Balancers. If you have Application Load Balancers, use <a>DetachLoadBalancerTargetGroups</a> instead.</p> <p>When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. The instances remain running.</p>"
"documentation":"<p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p> <p>This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use <a>DetachLoadBalancerTargetGroups</a> instead.</p> <p>When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. The instances remain running.</p>"
},
"DisableMetricsCollection":{
"name":"DisableMetricsCollection",
@ -667,7 +667,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.</p>"
},
"PutNotificationConfiguration":{
"name":"PutNotificationConfiguration",
@ -681,7 +681,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html\">Getting Amazon SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
@ -699,7 +699,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p> <p>If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p>"
},
"PutScheduledUpdateGroupAction":{
"name":"PutScheduledUpdateGroupAction",
@ -755,7 +755,7 @@
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/WhatIsAutoScaling.html\">What Is Amazon EC2 Auto Scaling?</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">What Is Amazon EC2 Auto Scaling?</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SetInstanceHealth":{
"name":"SetInstanceHealth",
@ -784,7 +784,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SuspendProcesses":{
"name":"SuspendProcesses",
@ -924,7 +924,7 @@
"documentation":"<p>The policy adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>"
}
},
"documentation":"<p>Describes a policy adjustment type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a policy adjustment type.</p>"
},
"AdjustmentTypes":{
"type":"list",
@ -1112,7 +1112,7 @@
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the placement group into which to launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The name of the placement group into which to launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
@ -1136,7 +1136,7 @@
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ServiceLinkedRoleARN":{
"shape":"ResourceName",
@ -1157,7 +1157,7 @@
"members":{
"AutoScalingGroupNames":{
"shape":"AutoScalingGroupNames",
"documentation":"<p>The names of the Auto Scaling groups. You can specify up to <code>MaxRecords</code> names. If you omit this parameter, all Auto Scaling groups are described.</p>"
"documentation":"<p>The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the <code>MaxRecords</code> parameter. </p> <p>If you omit this parameter, all Auto Scaling groups are described.</p>"
},
"NextToken":{
"shape":"XmlString",
@ -1165,7 +1165,7 @@
},
"MaxRecords":{
"shape":"MaxRecords",
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100. </p>"
}
}
},
@ -1228,7 +1228,7 @@
},
"ProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
}
},
"documentation":"<p>Describes an EC2 instance associated with an Auto Scaling group.</p>"
@ -1445,7 +1445,7 @@
},
"LoadBalancerNames":{
"shape":"LoadBalancerNames",
"documentation":"<p>One or more Classic Load Balancers. To specify an Application Load Balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"TargetGroupARNs":{
"shape":"TargetGroupARNs",
@ -1461,7 +1461,7 @@
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the placement group into which to launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The name of the placement group into which to launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
@ -1469,11 +1469,11 @@
},
"TerminationPolicies":{
"shape":"TerminationPolicies",
"documentation":"<p>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p> <p>For more information about preventing instances from terminating on scale in, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"LifecycleHookSpecificationList":{
"shape":"LifecycleHookSpecifications",
@ -1499,27 +1499,27 @@
},
"ImageId":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"KeyName":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the key pair. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The name of the key pair. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 Key Pairs</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"SecurityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>One or more security groups with which to associate the instances.</p> <p>If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>If your instances are launched into a VPC, specify security group IDs. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>"
"documentation":"<p>One or more security groups with which to associate the instances.</p> <p>If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>If your instances are launched into a VPC, specify security group IDs. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>"
},
"ClassicLinkVPCId":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ClassicLinkVPCSecurityGroups":{
"shape":"ClassicLinkVPCSecurityGroups",
"documentation":"<p>The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"UserData":{
"shape":"XmlStringUserData",
"documentation":"<p>The user data to make available to the launched EC2 instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html\">Instance Metadata and User Data</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The user data to make available to the launched EC2 instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html\">Instance Metadata and User Data</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
@ -1527,7 +1527,7 @@
},
"InstanceType":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The instance type of the EC2 instance.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>InstanceType</code>.</p> <p>For information about available instance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> </p>"
"documentation":"<p>The instance type of the EC2 instance.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>InstanceType</code>.</p> <p>For information about available instance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon EC2 User Guide for Linux Instances.</i> </p>"
},
"KernelId":{
"shape":"XmlStringMaxLen255",
@ -1539,7 +1539,7 @@
},
"BlockDeviceMappings":{
"shape":"BlockDeviceMappings",
"documentation":"<p>One or more mappings that specify how block devices are exposed to the instance. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html\">Block Device Mapping</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>One or more mappings that specify how block devices are exposed to the instance. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html\">Block Device Mapping</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"InstanceMonitoring":{
"shape":"InstanceMonitoring",
@ -1551,11 +1551,11 @@
},
"IamInstanceProfile":{
"shape":"XmlStringMaxLen1600",
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html\">Launch Auto Scaling Instances with an IAM Role</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html\">Use an IAM Role for Applications That Run on Amazon EC2 Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"EbsOptimized":{
"shape":"EbsOptimized",
"documentation":"<p>Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html\">Amazon EBS-Optimized Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html\">Amazon EBS-Optimized Instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"AssociatePublicIpAddress":{
"shape":"AssociatePublicIpAddress",
@ -1606,7 +1606,7 @@
"documentation":"<p>The unit of the metric.</p>"
}
},
"documentation":"<p>Configures a customized metric for a target tracking policy.</p>"
"documentation":"<p>Configures a customized metric for a target tracking policy to use with Amazon EC2 Auto Scaling.</p>"
},
"DeleteAutoScalingGroupType":{
"type":"structure",
@ -1707,11 +1707,11 @@
"members":{
"MaxNumberOfAutoScalingGroups":{
"shape":"MaxNumberOfAutoScalingGroups",
"documentation":"<p>The maximum number of groups allowed for your AWS account. The default limit is 20 per region.</p>"
"documentation":"<p>The maximum number of groups allowed for your AWS account. The default limit is 200 per region.</p>"
},
"MaxNumberOfLaunchConfigurations":{
"shape":"MaxNumberOfLaunchConfigurations",
"documentation":"<p>The maximum number of launch configurations allowed for your AWS account. The default limit is 100 per region.</p>"
"documentation":"<p>The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region.</p>"
},
"NumberOfAutoScalingGroups":{
"shape":"NumberOfAutoScalingGroups",
@ -2099,7 +2099,7 @@
},
"VolumeType":{
"shape":"BlockDeviceEbsVolumeType",
"documentation":"<p>The volume type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS Volume Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> </p>"
"documentation":"<p>The volume type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS Volume Types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> </p>"
},
"DeleteOnTermination":{
"shape":"BlockDeviceEbsDeleteOnTermination",
@ -2111,7 +2111,7 @@
},
"Encrypted":{
"shape":"BlockDeviceEbsEncrypted",
"documentation":"<p>Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
}
},
"documentation":"<p>Describes an Amazon EBS volume.</p>"
@ -2318,7 +2318,7 @@
},
"ProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
}
},
"documentation":"<p>Describes an EC2 instance.</p>"
@ -2366,8 +2366,8 @@
"documentation":"<p>The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the <b>Overrides</b> array of <a>LaunchTemplate</a>. </p> <p>The range is 1–20 and the default is 2. </p>"
},
"SpotMaxPrice":{
"shape":"SpotPrice",
"documentation":"<p>The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave this value blank (which is the default), the maximum Spot price is set at the On-Demand price. </p>"
"shape":"MixedInstanceSpotPrice",
"documentation":"<p>The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.</p> <p>To remove a value that you previously set, include the parameter but leave the value blank.</p>"
}
},
"documentation":"<p>Describes an instances distribution for an Auto Scaling group with <a>MixedInstancesPolicy</a>.</p> <p>The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types.</p>"
@ -2419,11 +2419,11 @@
},
"ClassicLinkVPCId":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ClassicLinkVPCSecurityGroups":{
"shape":"ClassicLinkVPCSecurityGroups",
"documentation":"<p>The IDs of one or more security groups for the VPC specified in <code>ClassicLinkVPCId</code>. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The IDs of one or more security groups for the VPC specified in <code>ClassicLinkVPCId</code>. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic Instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"UserData":{
"shape":"XmlStringUserData",
@ -2619,7 +2619,7 @@
"documentation":"<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>"
}
},
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"LifecycleHookNames":{
"type":"list",
@ -2662,7 +2662,7 @@
"documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>"
}
},
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Amazon EC2 Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"LifecycleHookSpecifications":{
"type":"list",
@ -2834,6 +2834,11 @@
"type":"integer",
"deprecated":true
},
"MixedInstanceSpotPrice":{
"type":"string",
"max":255,
"min":0
},
"MixedInstancesPolicy":{
"type":"structure",
"members":{
@ -2932,7 +2937,7 @@
},
"ResourceLabel":{
"shape":"XmlStringMaxLen1023",
"documentation":"<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - Average number of bytes received on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed per target in an Application Load Balancer target group.</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code>, and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>"
"documentation":"<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - Average number of bytes received on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all network interfaces by the Auto Scaling group.</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - Number of requests completed per target in an Application Load Balancer or a Network Load Balancer target group.</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code>, and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>"
}
},
"documentation":"<p>Configures a predefined metric for a target tracking policy.</p>"
@ -3122,7 +3127,7 @@
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The recurring schedule for this action, in Unix cron syntax format. For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p>"
"documentation":"<p>The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -3400,7 +3405,7 @@
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The recurring schedule for the action, in Unix cron syntax format. For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p>"
"documentation":"<p>The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -3671,7 +3676,7 @@
"documentation":"<p>Indicates whether scaling in by the target tracking policy is disabled. If scaling in is disabled, the target tracking policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking policy can remove instances from the Auto Scaling group. The default is disabled.</p>"
}
},
"documentation":"<p>Represents a target tracking policy configuration.</p>"
"documentation":"<p>Represents a target tracking policy configuration to use with Amazon EC2 Auto Scaling.</p>"
},
"TerminateInstanceInAutoScalingGroupType":{
"type":"structure",
@ -3745,7 +3750,7 @@
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the placement group into which to launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
"documentation":"<p>The name of the placement group into which to launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
@ -3753,11 +3758,11 @@
},
"TerminationPolicies":{
"shape":"TerminationPolicies",
"documentation":"<p>A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p> <p>For more information about preventing instances from terminating on scale in, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ServiceLinkedRoleARN":{
"shape":"ResourceName",
@ -3827,5 +3832,5 @@
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
},
"documentation":"<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.</p> <p>For more information, see the <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a>.</p>"
"documentation":"<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.</p> <p>For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html\">Amazon EC2 Auto Scaling User Guide</a>.</p>"
}

3
botocore/data/backup/2018-11-15/paginators-1.json Normal file
View file

@ -0,0 +1,3 @@
{
"pagination": {}
}

3148
botocore/data/backup/2018-11-15/service-2.json Normal file
View file

@ -0,0 +1,3148 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-11-15",
"endpointPrefix":"backup",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Backup",
"serviceId":"Backup",
"signatureVersion":"v4",
"uid":"backup-2018-11-15"
},
"operations":{
"CreateBackupPlan":{
"name":"CreateBackupPlan",
"http":{
"method":"PUT",
"requestUri":"/backup/plans/"
},
"input":{"shape":"CreateBackupPlanInput"},
"output":{"shape":"CreateBackupPlanOutput"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"AlreadyExistsException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.</p> <p>If you call <code>CreateBackupPlan</code> with a plan that already exists, the existing <code>backupPlanId</code> is returned.</p>",
"idempotent":true
},
"CreateBackupSelection":{
"name":"CreateBackupSelection",
"http":{
"method":"PUT",
"requestUri":"/backup/plans/{backupPlanId}/selections/"
},
"input":{"shape":"CreateBackupSelectionInput"},
"output":{"shape":"CreateBackupSelectionOutput"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"AlreadyExistsException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a <code>ListOfTags</code> and selected <code>Resources</code>. </p> <p>For example, consider the following patterns:</p> <ul> <li> <p> <code>Resources: \"arn:aws:ec2:region:account-id:volume/volume-id\"</code> </p> </li> <li> <p> <code>ConditionKey:\"department\"</code> </p> <p> <code>ConditionValue:\"finance\"</code> </p> <p> <code>ConditionType:\"StringEquals\"</code> </p> </li> <li> <p> <code>ConditionKey:\"importance\"</code> </p> <p> <code>ConditionValue:\"critical\"</code> </p> <p> <code>ConditionType:\"StringEquals\"</code> </p> </li> </ul> <p>Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as <code>\"department=finance\"</code>, <code>\"importance=critical\"</code>, in addition to an EBS volume with the specified volume Id.</p> <p>Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.</p>",
"idempotent":true
},
"CreateBackupVault":{
"name":"CreateBackupVault",
"http":{
"method":"PUT",
"requestUri":"/backup-vaults/{backupVaultName}"
},
"input":{"shape":"CreateBackupVaultInput"},
"output":{"shape":"CreateBackupVaultOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"},
{"shape":"AlreadyExistsException"}
],
"documentation":"<p>Creates a logical container where backups are stored. A <code>CreateBackupVault</code> request includes a name, optionally one or more resource tags, an encryption key, and a request ID.</p> <note> <p>Sensitive data, such as passport numbers, should not be included the name of a backup vault.</p> </note>",
"idempotent":true
},
"DeleteBackupPlan":{
"name":"DeleteBackupPlan",
"http":{
"method":"DELETE",
"requestUri":"/backup/plans/{backupPlanId}"
},
"input":{"shape":"DeleteBackupPlanInput"},
"output":{"shape":"DeleteBackupPlanOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.</p>"
},
"DeleteBackupSelection":{
"name":"DeleteBackupSelection",
"http":{
"method":"DELETE",
"requestUri":"/backup/plans/{backupPlanId}/selections/{selectionId}"
},
"input":{"shape":"DeleteBackupSelectionInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes the resource selection associated with a backup plan that is specified by the <code>SelectionId</code>.</p>"
},
"DeleteBackupVault":{
"name":"DeleteBackupVault",
"http":{
"method":"DELETE",
"requestUri":"/backup-vaults/{backupVaultName}"
},
"input":{"shape":"DeleteBackupVaultInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.</p>"
},
"DeleteBackupVaultAccessPolicy":{
"name":"DeleteBackupVaultAccessPolicy",
"http":{
"method":"DELETE",
"requestUri":"/backup-vaults/{backupVaultName}/access-policy"
},
"input":{"shape":"DeleteBackupVaultAccessPolicyInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes the policy document that manages permissions on a backup vault.</p>",
"idempotent":true
},
"DeleteBackupVaultNotifications":{
"name":"DeleteBackupVaultNotifications",
"http":{
"method":"DELETE",
"requestUri":"/backup-vaults/{backupVaultName}/notification-configuration"
},
"input":{"shape":"DeleteBackupVaultNotificationsInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes event notifications for the specified backup vault.</p>",
"idempotent":true
},
"DeleteRecoveryPoint":{
"name":"DeleteRecoveryPoint",
"http":{
"method":"DELETE",
"requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}"
},
"input":{"shape":"DeleteRecoveryPointInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the recovery point specified by a recovery point ID.</p>",
"idempotent":true
},
"DescribeBackupJob":{
"name":"DescribeBackupJob",
"http":{
"method":"GET",
"requestUri":"/backup-jobs/{backupJobId}"
},
"input":{"shape":"DescribeBackupJobInput"},
"output":{"shape":"DescribeBackupJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"DependencyFailureException"}
],
"documentation":"<p>Returns metadata associated with creating a backup of a resource.</p>",
"idempotent":true
},
"DescribeBackupVault":{
"name":"DescribeBackupVault",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/{backupVaultName}"
},
"input":{"shape":"DescribeBackupVaultInput"},
"output":{"shape":"DescribeBackupVaultOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata about a backup vault specified by its name.</p>",
"idempotent":true
},
"DescribeProtectedResource":{
"name":"DescribeProtectedResource",
"http":{
"method":"GET",
"requestUri":"/resources/{resourceArn}"
},
"input":{"shape":"DescribeProtectedResourceInput"},
"output":{"shape":"DescribeProtectedResourceOutput"},
"errors":[
{"shape":"MissingParameterValueException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.</p>",
"idempotent":true
},
"DescribeRecoveryPoint":{
"name":"DescribeRecoveryPoint",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}"
},
"input":{"shape":"DescribeRecoveryPointInput"},
"output":{"shape":"DescribeRecoveryPointOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.</p>",
"idempotent":true
},
"DescribeRestoreJob":{
"name":"DescribeRestoreJob",
"http":{
"method":"GET",
"requestUri":"/restore-jobs/{restoreJobId}"
},
"input":{"shape":"DescribeRestoreJobInput"},
"output":{"shape":"DescribeRestoreJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"DependencyFailureException"}
],
"documentation":"<p>Returns metadata associated with a restore job that is specified by a job ID.</p>",
"idempotent":true
},
"ExportBackupPlanTemplate":{
"name":"ExportBackupPlanTemplate",
"http":{
"method":"GET",
"requestUri":"/backup/plans/{backupPlanId}/toTemplate/"
},
"input":{"shape":"ExportBackupPlanTemplateInput"},
"output":{"shape":"ExportBackupPlanTemplateOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns the backup plan that is specified by the plan ID as a backup template.</p>"
},
"GetBackupPlan":{
"name":"GetBackupPlan",
"http":{
"method":"GET",
"requestUri":"/backup/plans/{backupPlanId}/"
},
"input":{"shape":"GetBackupPlanInput"},
"output":{"shape":"GetBackupPlanOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns the body of a backup plan in JSON format, in addition to plan metadata.</p>",
"idempotent":true
},
"GetBackupPlanFromJSON":{
"name":"GetBackupPlanFromJSON",
"http":{
"method":"POST",
"requestUri":"/backup/template/json/toPlan"
},
"input":{"shape":"GetBackupPlanFromJSONInput"},
"output":{"shape":"GetBackupPlanFromJSONOutput"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns a valid JSON document specifying a backup plan or an error.</p>"
},
"GetBackupPlanFromTemplate":{
"name":"GetBackupPlanFromTemplate",
"http":{
"method":"GET",
"requestUri":"/backup/template/plans/{templateId}/toPlan"
},
"input":{"shape":"GetBackupPlanFromTemplateInput"},
"output":{"shape":"GetBackupPlanFromTemplateOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns the template specified by its <code>templateId</code> as a backup plan.</p>"
},
"GetBackupSelection":{
"name":"GetBackupSelection",
"http":{
"method":"GET",
"requestUri":"/backup/plans/{backupPlanId}/selections/{selectionId}"
},
"input":{"shape":"GetBackupSelectionInput"},
"output":{"shape":"GetBackupSelectionOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.</p>",
"idempotent":true
},
"GetBackupVaultAccessPolicy":{
"name":"GetBackupVaultAccessPolicy",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/{backupVaultName}/access-policy"
},
"input":{"shape":"GetBackupVaultAccessPolicyInput"},
"output":{"shape":"GetBackupVaultAccessPolicyOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns the access policy document that is associated with the named backup vault.</p>",
"idempotent":true
},
"GetBackupVaultNotifications":{
"name":"GetBackupVaultNotifications",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/{backupVaultName}/notification-configuration"
},
"input":{"shape":"GetBackupVaultNotificationsInput"},
"output":{"shape":"GetBackupVaultNotificationsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns event notifications for the specified backup vault.</p>",
"idempotent":true
},
"GetRecoveryPointRestoreMetadata":{
"name":"GetRecoveryPointRestoreMetadata",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/restore-metadata"
},
"input":{"shape":"GetRecoveryPointRestoreMetadataInput"},
"output":{"shape":"GetRecoveryPointRestoreMetadataOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.</p> <p>These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored.</p>",
"idempotent":true
},
"GetSupportedResourceTypes":{
"name":"GetSupportedResourceTypes",
"http":{
"method":"GET",
"requestUri":"/supported-resource-types"
},
"output":{"shape":"GetSupportedResourceTypesOutput"},
"errors":[
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns the AWS resource types supported by AWS Backup.</p>"
},
"ListBackupJobs":{
"name":"ListBackupJobs",
"http":{
"method":"GET",
"requestUri":"/backup-jobs/"
},
"input":{"shape":"ListBackupJobsInput"},
"output":{"shape":"ListBackupJobsOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata about your backup jobs.</p>",
"idempotent":true
},
"ListBackupPlanTemplates":{
"name":"ListBackupPlanTemplates",
"http":{
"method":"GET",
"requestUri":"/backup/template/plans"
},
"input":{"shape":"ListBackupPlanTemplatesInput"},
"output":{"shape":"ListBackupPlanTemplatesOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.</p>"
},
"ListBackupPlanVersions":{
"name":"ListBackupPlanVersions",
"http":{
"method":"GET",
"requestUri":"/backup/plans/{backupPlanId}/versions/"
},
"input":{"shape":"ListBackupPlanVersionsInput"},
"output":{"shape":"ListBackupPlanVersionsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.</p>",
"idempotent":true
},
"ListBackupPlans":{
"name":"ListBackupPlans",
"http":{
"method":"GET",
"requestUri":"/backup/plans/"
},
"input":{"shape":"ListBackupPlansInput"},
"output":{"shape":"ListBackupPlansOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.</p>",
"idempotent":true
},
"ListBackupSelections":{
"name":"ListBackupSelections",
"http":{
"method":"GET",
"requestUri":"/backup/plans/{backupPlanId}/selections/"
},
"input":{"shape":"ListBackupSelectionsInput"},
"output":{"shape":"ListBackupSelectionsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns an array containing metadata of the resources associated with the target backup plan.</p>",
"idempotent":true
},
"ListBackupVaults":{
"name":"ListBackupVaults",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/"
},
"input":{"shape":"ListBackupVaultsInput"},
"output":{"shape":"ListBackupVaultsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns a list of recovery point storage containers along with information about them.</p>",
"idempotent":true
},
"ListProtectedResources":{
"name":"ListProtectedResources",
"http":{
"method":"GET",
"requestUri":"/resources/"
},
"input":{"shape":"ListProtectedResourcesInput"},
"output":{"shape":"ListProtectedResourcesOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.</p>",
"idempotent":true
},
"ListRecoveryPointsByBackupVault":{
"name":"ListRecoveryPointsByBackupVault",
"http":{
"method":"GET",
"requestUri":"/backup-vaults/{backupVaultName}/recovery-points/"
},
"input":{"shape":"ListRecoveryPointsByBackupVaultInput"},
"output":{"shape":"ListRecoveryPointsByBackupVaultOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns detailed information about the recovery points stored in a backup vault.</p>",
"idempotent":true
},
"ListRecoveryPointsByResource":{
"name":"ListRecoveryPointsByResource",
"http":{
"method":"GET",
"requestUri":"/resources/{resourceArn}/recovery-points/"
},
"input":{"shape":"ListRecoveryPointsByResourceInput"},
"output":{"shape":"ListRecoveryPointsByResourceOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).</p>",
"idempotent":true
},
"ListRestoreJobs":{
"name":"ListRestoreJobs",
"http":{
"method":"GET",
"requestUri":"/restore-jobs/"
},
"input":{"shape":"ListRestoreJobsInput"},
"output":{"shape":"ListRestoreJobsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.</p>",
"idempotent":true
},
"ListTags":{
"name":"ListTags",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}/"
},
"input":{"shape":"ListTagsInput"},
"output":{"shape":"ListTagsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.</p>",
"idempotent":true
},
"PutBackupVaultAccessPolicy":{
"name":"PutBackupVaultAccessPolicy",
"http":{
"method":"PUT",
"requestUri":"/backup-vaults/{backupVaultName}/access-policy"
},
"input":{"shape":"PutBackupVaultAccessPolicyInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.</p>",
"idempotent":true
},
"PutBackupVaultNotifications":{
"name":"PutBackupVaultNotifications",
"http":{
"method":"PUT",
"requestUri":"/backup-vaults/{backupVaultName}/notification-configuration"
},
"input":{"shape":"PutBackupVaultNotificationsInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Turns on notifications on a backup vault for the specified topic and events.</p>",
"idempotent":true
},
"StartBackupJob":{
"name":"StartBackupJob",
"http":{
"method":"PUT",
"requestUri":"/backup-jobs"
},
"input":{"shape":"StartBackupJobInput"},
"output":{"shape":"StartBackupJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Starts a job to create a one-time backup of the specified resource.</p>",
"idempotent":true
},
"StartRestoreJob":{
"name":"StartRestoreJob",
"http":{
"method":"PUT",
"requestUri":"/restore-jobs"
},
"input":{"shape":"StartRestoreJobInput"},
"output":{"shape":"StartRestoreJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Recovers the saved resource identified by an Amazon Resource Name (ARN). </p> <p>If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.</p>",
"idempotent":true
},
"StopBackupJob":{
"name":"StopBackupJob",
"http":{
"method":"POST",
"requestUri":"/backup-jobs/{backupJobId}"
},
"input":{"shape":"StopBackupJobInput"},
"errors":[
{"shape":"MissingParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidRequestException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Attempts to cancel a job to create a one-time backup of a resource.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"TagResourceInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).</p>",
"idempotent":true
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/untag/{resourceArn}"
},
"input":{"shape":"UntagResourceInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)</p>",
"idempotent":true
},
"UpdateBackupPlan":{
"name":"UpdateBackupPlan",
"http":{
"method":"POST",
"requestUri":"/backup/plans/{backupPlanId}"
},
"input":{"shape":"UpdateBackupPlanInput"},
"output":{"shape":"UpdateBackupPlanOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Replaces the body of a saved backup plan identified by its <code>backupPlanId</code> with the input document in JSON format. The new version is uniquely identified by a <code>VersionId</code>.</p>",
"idempotent":true
},
"UpdateRecoveryPointLifecycle":{
"name":"UpdateRecoveryPointLifecycle",
"http":{
"method":"POST",
"requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}"
},
"input":{"shape":"UpdateRecoveryPointLifecycleInput"},
"output":{"shape":"UpdateRecoveryPointLifecycleOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>",
"idempotent":true
}
},
"shapes":{
"ARN":{"type":"string"},
"AlreadyExistsException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p/>"
},
"Arn":{
"shape":"string",
"documentation":"<p/>"
},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>The required resource already exists.</p>",
"exception":true
},
"BackupJob":{
"type":"structure",
"members":{
"BackupJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>"
},
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"State":{
"shape":"BackupJobState",
"documentation":"<p>The current state of a resource recovery point.</p>"
},
"StatusMessage":{
"shape":"string",
"documentation":"<p>A detailed message explaining the status of the job to back up a resource.</p>"
},
"PercentDone":{
"shape":"string",
"documentation":"<p>Contains an estimated percentage complete of a job at the time the job status was queried.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of a backup.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"CreatedBy":{
"shape":"RecoveryPointCreator",
"documentation":"<p>Contains identifying information about the creation of a backup job, including the <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>, and <code>BackupRuleId</code> of the backup plan used to create it.</p>"
},
"ExpectedCompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>ExpectedCompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"StartBy":{
"shape":"timestamp",
"documentation":"<p>Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the <code>StartBy</code> time would be 8:00 PM on the date specified. The value of <code>StartBy</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
},
"BytesTransferred":{
"shape":"Long",
"documentation":"<p>The size in bytes transferred to a backup vault at the time that the job status was queried.</p>"
}
},
"documentation":"<p>Contains detailed information about a backup job.</p>"
},
"BackupJobState":{
"type":"string",
"enum":[
"CREATED",
"PENDING",
"RUNNING",
"ABORTING",
"ABORTED",
"COMPLETED",
"FAILED",
"EXPIRED"
]
},
"BackupJobsList":{
"type":"list",
"member":{"shape":"BackupJob"}
},
"BackupPlan":{
"type":"structure",
"required":[
"BackupPlanName",
"Rules"
],
"members":{
"BackupPlanName":{
"shape":"BackupPlanName",
"documentation":"<p>The display name of a backup plan.</p>"
},
"Rules":{
"shape":"BackupRules",
"documentation":"<p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task that is used to back up a selection of resources.</p>"
}
},
"documentation":"<p>Contains an optional backup plan display name and an array of <code>BackupRule</code> objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.</p>"
},
"BackupPlanInput":{
"type":"structure",
"required":[
"BackupPlanName",
"Rules"
],
"members":{
"BackupPlanName":{
"shape":"BackupPlanName",
"documentation":"<p>The display name of a backup plan.</p>"
},
"Rules":{
"shape":"BackupRulesInput",
"documentation":"<p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task that is used to back up a selection of resources.</p>"
}
},
"documentation":"<p>Contains an optional backup plan display name and an array of <code>BackupRule</code> objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.</p>"
},
"BackupPlanName":{"type":"string"},
"BackupPlanTemplatesList":{
"type":"list",
"member":{"shape":"BackupPlanTemplatesListMember"}
},
"BackupPlanTemplatesListMember":{
"type":"structure",
"members":{
"BackupPlanTemplateId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a stored backup plan template.</p>"
},
"BackupPlanTemplateName":{
"shape":"string",
"documentation":"<p>The optional display name of a backup plan template.</p>"
}
},
"documentation":"<p>An object specifying metadata associated with a backup plan template.</p>"
},
"BackupPlanVersionsList":{
"type":"list",
"member":{"shape":"BackupPlansListMember"}
},
"BackupPlansList":{
"type":"list",
"member":{"shape":"BackupPlansListMember"}
},
"BackupPlansListMember":{
"type":"structure",
"members":{
"BackupPlanArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
},
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"DeletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"VersionId":{
"shape":"string",
"documentation":"<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</p>"
},
"BackupPlanName":{
"shape":"BackupPlanName",
"documentation":"<p>The display name of a saved backup plan.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
},
"LastExecutionDate":{
"shape":"timestamp",
"documentation":"<p>The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
},
"documentation":"<p>Contains metadata about a backup plan.</p>"
},
"BackupRule":{
"type":"structure",
"required":[
"RuleName",
"TargetBackupVaultName"
],
"members":{
"RuleName":{
"shape":"BackupRuleName",
"documentation":"<p>An optional display name for a backup rule.</p>"
},
"TargetBackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"ScheduleExpression":{
"shape":"CronExpression",
"documentation":"<p>A CRON expression specifying when AWS Backup initiates a backup job.</p>"
},
"StartWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.</p>"
},
"CompletionWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"RecoveryPointTags":{
"shape":"Tags",
"documentation":"<p>An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.</p>"
},
"RuleId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a rule that is used to schedule the backup of a selection of resources.</p>"
}
},
"documentation":"<p>Specifies a scheduled task used to back up a selection of resources.</p>"
},
"BackupRuleInput":{
"type":"structure",
"required":[
"RuleName",
"TargetBackupVaultName"
],
"members":{
"RuleName":{
"shape":"BackupRuleName",
"documentation":"<p>&gt;An optional display name for a backup rule.</p>"
},
"TargetBackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"ScheduleExpression":{
"shape":"CronExpression",
"documentation":"<p>A CRON expression specifying when AWS Backup initiates a backup job.</p>"
},
"StartWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>The amount of time in minutes before beginning a backup.</p>"
},
"CompletionWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>The amount of time AWS Backup attempts a backup before canceling the job and returning an error.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"RecoveryPointTags":{
"shape":"Tags",
"documentation":"<p>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.</p>"
}
},
"documentation":"<p>Specifies a scheduled task used to back up a selection of resources.</p>"
},
"BackupRuleName":{
"type":"string",
"pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
},
"BackupRules":{
"type":"list",
"member":{"shape":"BackupRule"}
},
"BackupRulesInput":{
"type":"list",
"member":{"shape":"BackupRuleInput"}
},
"BackupSelection":{
"type":"structure",
"required":[
"SelectionName",
"IamRoleArn"
],
"members":{
"SelectionName":{
"shape":"BackupSelectionName",
"documentation":"<p>The display name of a resource selection document.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"Resources":{
"shape":"ResourceArns",
"documentation":"<p>An array of strings that either contain Amazon Resource Names (ARNs) or match patterns such as \"<code>arn:aws:ec2:us-east-1:123456789012:volume/*</code>\" of resources to assign to a backup plan.</p>"
},
"ListOfTags":{
"shape":"ListOfTags",
"documentation":"<p>An array of conditions used to specify a set of resources to assign to a backup plan; for example, <code>\"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\"</code>.</p>"
}
},
"documentation":"<p>Used to specify a set of resources to a backup plan.</p>"
},
"BackupSelectionName":{
"type":"string",
"pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
},
"BackupSelectionsList":{
"type":"list",
"member":{"shape":"BackupSelectionsListMember"}
},
"BackupSelectionsListMember":{
"type":"structure",
"members":{
"SelectionId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to assign a set of resources to a backup plan.</p>"
},
"SelectionName":{
"shape":"BackupSelectionName",
"documentation":"<p>The display name of a resource selection document.</p>"
},
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
}
},
"documentation":"<p>Contains metadata about a <code>BackupSelection</code> object.</p>"
},
"BackupVaultEvent":{
"type":"string",
"enum":[
"BACKUP_JOB_STARTED",
"BACKUP_JOB_COMPLETED",
"RESTORE_JOB_STARTED",
"RESTORE_JOB_COMPLETED",
"RECOVERY_POINT_MODIFIED",
"BACKUP_PLAN_CREATED",
"BACKUP_PLAN_MODIFIED"
]
},
"BackupVaultEvents":{
"type":"list",
"member":{"shape":"BackupVaultEvent"}
},
"BackupVaultList":{
"type":"list",
"member":{"shape":"BackupVaultListMember"}
},
"BackupVaultListMember":{
"type":"structure",
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
"documentation":"<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
},
"NumberOfRecoveryPoints":{
"shape":"long",
"documentation":"<p>The number of recovery points that are stored in a backup vault.</p>"
}
},
"documentation":"<p>Contains metadata about a backup vault.</p>"
},
"BackupVaultName":{
"type":"string",
"pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
},
"Boolean":{"type":"boolean"},
"CalculatedLifecycle":{
"type":"structure",
"members":{
"MoveToColdStorageAt":{
"shape":"timestamp",
"documentation":"<p>A timestamp that specifies when to transition a recovery point to cold storage.</p>"
},
"DeleteAt":{
"shape":"timestamp",
"documentation":"<p>A timestamp that specifies when to delete a recovery point.</p>"
}
},
"documentation":"<p>Contains <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps, which are used to specify a lifecycle for a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"Condition":{
"type":"structure",
"required":[
"ConditionType",
"ConditionKey",
"ConditionValue"
],
"members":{
"ConditionType":{
"shape":"ConditionType",
"documentation":"<p>An operation, such as <code>StringEquals</code>, that is applied to a key-value pair used to filter resources in a selection.</p>"
},
"ConditionKey":{
"shape":"ConditionKey",
"documentation":"<p>The key in a key-value pair. For example, in <code>\"ec2:ResourceTag/Department\": \"accounting\"</code>, <code>\"ec2:ResourceTag/Department\"</code> is the key.</p>"
},
"ConditionValue":{
"shape":"ConditionValue",
"documentation":"<p>The value in a key-value pair. For example, in <code>\"ec2:ResourceTag/Department\": \"accounting\"</code>, <code>\"accounting\"</code> is the value.</p>"
}
},
"documentation":"<p>Contains an array of triplets made up of a condition type (such as <code>StringEquals</code>), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.</p>"
},
"ConditionKey":{"type":"string"},
"ConditionType":{
"type":"string",
"enum":["STRINGEQUALS"]
},
"ConditionValue":{"type":"string"},
"CreateBackupPlanInput":{
"type":"structure",
"required":["BackupPlan"],
"members":{
"BackupPlan":{
"shape":"BackupPlanInput",
"documentation":"<p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>"
},
"BackupPlanTags":{
"shape":"Tags",
"documentation":"<p>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a <code>CreatorRequestId</code> that matches an existing backup plan, that plan is returned. This parameter is optional.</p>"
}
}
},
"CreateBackupPlanOutput":{
"type":"structure",
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"BackupPlanArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"VersionId":{
"shape":"string",
"documentation":"<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited.</p>"
}
}
},
"CreateBackupSelectionInput":{
"type":"structure",
"required":[
"BackupPlanId",
"BackupSelection"
],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the backup plan to be associated with the selection of resources.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"BackupSelection":{
"shape":"BackupSelection",
"documentation":"<p>Specifies the body of a request to assign a set of resources to a backup plan.</p> <p>It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
}
}
},
"CreateBackupSelectionOutput":{
"type":"structure",
"members":{
"SelectionId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</p>"
},
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"CreateBackupVaultInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"BackupVaultTags":{
"shape":"Tags",
"documentation":"<p>Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
"documentation":"<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
}
}
},
"CreateBackupVaultOutput":{
"type":"structure",
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"CronExpression":{"type":"string"},
"DeleteBackupPlanInput":{
"type":"structure",
"required":["BackupPlanId"],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
}
}
},
"DeleteBackupPlanOutput":{
"type":"structure",
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"BackupPlanArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
},
"DeletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"VersionId":{
"shape":"string",
"documentation":"<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.</p>"
}
}
},
"DeleteBackupSelectionInput":{
"type":"structure",
"required":[
"BackupPlanId",
"SelectionId"
],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"SelectionId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</p>",
"location":"uri",
"locationName":"selectionId"
}
}
},
"DeleteBackupVaultAccessPolicyInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
}
}
},
"DeleteBackupVaultInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"string",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and theAWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
}
}
},
"DeleteBackupVaultNotificationsInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
}
}
},
"DeleteRecoveryPointInput":{
"type":"structure",
"required":[
"BackupVaultName",
"RecoveryPointArn"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>",
"location":"uri",
"locationName":"recoveryPointArn"
}
}
},
"DependencyFailureException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.</p>",
"exception":true,
"fault":true
},
"DescribeBackupJobInput":{
"type":"structure",
"required":["BackupJobId"],
"members":{
"BackupJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>",
"location":"uri",
"locationName":"backupJobId"
}
}
},
"DescribeBackupJobOutput":{
"type":"structure",
"members":{
"BackupJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>"
},
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"State":{
"shape":"BackupJobState",
"documentation":"<p>The current state of a resource recovery point.</p>"
},
"StatusMessage":{
"shape":"string",
"documentation":"<p>A detailed message explaining the status of the job to back up a resource.</p>"
},
"PercentDone":{
"shape":"string",
"documentation":"<p>Contains an estimated percentage that is complete of a job at the time the job status was queried.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of a backup.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"CreatedBy":{
"shape":"RecoveryPointCreator",
"documentation":"<p>Contains identifying information about the creation of a backup job, including the <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>, and <code>BackupRuleId</code> of the backup plan that is used to create it.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
},
"BytesTransferred":{
"shape":"Long",
"documentation":"<p>The size in bytes transferred to a backup vault at the time that the job status was queried.</p>"
},
"ExpectedCompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>ExpectedCompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"StartBy":{
"shape":"timestamp",
"documentation":"<p>Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the <code>StartBy</code> time would be 8:00 PM on the date specified. The value of <code>StartBy</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"DescribeBackupVaultInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"string",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
}
}
},
"DescribeBackupVaultOutput":{
"type":"structure",
"members":{
"BackupVaultName":{
"shape":"string",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
"documentation":"<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
},
"NumberOfRecoveryPoints":{
"shape":"long",
"documentation":"<p>The number of recovery points that are stored in a backup vault.</p>"
}
}
},
"DescribeProtectedResourceInput":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"DescribeProtectedResourceOutput":{
"type":"structure",
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database.</p>"
},
"LastBackupTime":{
"shape":"timestamp",
"documentation":"<p>The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastBackupTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"DescribeRecoveryPointInput":{
"type":"structure",
"required":[
"BackupVaultName",
"RecoveryPointArn"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>",
"location":"uri",
"locationName":"recoveryPointArn"
}
}
},
"DescribeRecoveryPointOutput":{
"type":"structure",
"members":{
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
},
"CreatedBy":{
"shape":"RecoveryPointCreator",
"documentation":"<p>Contains identifying information about the creation of a recovery point, including the <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>, and <code>BackupRuleId</code> of the backup plan used to create it.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"Status":{
"shape":"RecoveryPointStatus",
"documentation":"<p>A status code specifying the state of the recovery point.</p> <note> <p>A partial status indicates that the recovery point was not successfully re-created and must be retried.</p> </note>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of a backup.</p>"
},
"CalculatedLifecycle":{
"shape":"CalculatedLifecycle",
"documentation":"<p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
"documentation":"<p>The server-side encryption key used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
},
"IsEncrypted":{
"shape":"boolean",
"documentation":"<p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"<p>Specifies the storage class of the recovery point. Valid values are <code>WARM</code> or <code>COLD</code>.</p>"
},
"LastRestoreTime":{
"shape":"timestamp",
"documentation":"<p>The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastRestoreTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"DescribeRestoreJobInput":{
"type":"structure",
"required":["RestoreJobId"],
"members":{
"RestoreJobId":{
"shape":"RestoreJobId",
"documentation":"<p>Uniquely identifies the job that restores a recovery point.</p>",
"location":"uri",
"locationName":"restoreJobId"
}
}
},
"DescribeRestoreJobOutput":{
"type":"structure",
"members":{
"RestoreJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the job that restores a recovery point.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"Status":{
"shape":"RestoreJobStatus",
"documentation":"<p>Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.</p>"
},
"StatusMessage":{
"shape":"string",
"documentation":"<p>A detailed message explaining the status of a job to restore a recovery point.</p>"
},
"PercentDone":{
"shape":"string",
"documentation":"<p>Contains an estimated percentage that is complete of a job at the time the job status was queried.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of the restored resource.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"ExpectedCompletionTimeMinutes":{
"shape":"Long",
"documentation":"<p>The amount of time in minutes that a job restoring a recovery point is expected to take.</p>"
},
"CreatedResourceArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.</p>"
}
}
},
"ExportBackupPlanTemplateInput":{
"type":"structure",
"required":["BackupPlanId"],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
}
}
},
"ExportBackupPlanTemplateOutput":{
"type":"structure",
"members":{
"BackupPlanTemplateJson":{
"shape":"string",
"documentation":"<p>The body of a backup plan template in JSON format.</p> <note> <p>This is a signed JSON document that cannot be modified before being passed to <code>GetBackupPlanFromJSON.</code> </p> </note>"
}
}
},
"GetBackupPlanFromJSONInput":{
"type":"structure",
"required":["BackupPlanTemplateJson"],
"members":{
"BackupPlanTemplateJson":{
"shape":"string",
"documentation":"<p>A customer-supplied backup plan document in JSON format.</p>"
}
}
},
"GetBackupPlanFromJSONOutput":{
"type":"structure",
"members":{
"BackupPlan":{
"shape":"BackupPlan",
"documentation":"<p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>"
}
}
},
"GetBackupPlanFromTemplateInput":{
"type":"structure",
"required":["BackupPlanTemplateId"],
"members":{
"BackupPlanTemplateId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a stored backup plan template.</p>",
"location":"uri",
"locationName":"templateId"
}
}
},
"GetBackupPlanFromTemplateOutput":{
"type":"structure",
"members":{
"BackupPlanDocument":{
"shape":"BackupPlan",
"documentation":"<p>Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.</p>"
}
}
},
"GetBackupPlanInput":{
"type":"structure",
"required":["BackupPlanId"],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"VersionId":{
"shape":"string",
"documentation":"<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</p>",
"location":"querystring",
"locationName":"versionId"
}
}
},
"GetBackupPlanOutput":{
"type":"structure",
"members":{
"BackupPlan":{
"shape":"BackupPlan",
"documentation":"<p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>"
},
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"BackupPlanArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
},
"VersionId":{
"shape":"string",
"documentation":"<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"DeletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"LastExecutionDate":{
"shape":"timestamp",
"documentation":"<p>The last time a job to back up resources was executed with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"GetBackupSelectionInput":{
"type":"structure",
"required":[
"BackupPlanId",
"SelectionId"
],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"SelectionId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</p>",
"location":"uri",
"locationName":"selectionId"
}
}
},
"GetBackupSelectionOutput":{
"type":"structure",
"members":{
"BackupSelection":{
"shape":"BackupSelection",
"documentation":"<p>Specifies the body of a request to assign a set of resources to a backup plan.</p> <p>It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service that the resource belongs to, and an optional array of tags used to identify a set of resources.</p>"
},
"SelectionId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</p>"
},
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CreatorRequestId":{
"shape":"string",
"documentation":"<p>A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.</p>"
}
}
},
"GetBackupVaultAccessPolicyInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
}
}
},
"GetBackupVaultAccessPolicyOutput":{
"type":"structure",
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"Policy":{
"shape":"IAMPolicy",
"documentation":"<p>The backup vault access policy document in JSON format.</p>"
}
}
},
"GetBackupVaultNotificationsInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
}
}
},
"GetBackupVaultNotificationsOutput":{
"type":"structure",
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"SNSTopicArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, <code>arn:aws:sns:us-west-2:111122223333:MyTopic</code>.</p>"
},
"BackupVaultEvents":{
"shape":"BackupVaultEvents",
"documentation":"<p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p>"
}
}
},
"GetRecoveryPointRestoreMetadataInput":{
"type":"structure",
"required":[
"BackupVaultName",
"RecoveryPointArn"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>",
"location":"uri",
"locationName":"recoveryPointArn"
}
}
},
"GetRecoveryPointRestoreMetadataOutput":{
"type":"structure",
"members":{
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"RestoreMetadata":{
"shape":"Metadata",
"documentation":"<p>A set of metadata key-value pairs that lists the metadata key-value pairs that are required to restore the recovery point.</p>"
}
}
},
"GetSupportedResourceTypesOutput":{
"type":"structure",
"members":{
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>SGW</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
}
}
},
"IAMPolicy":{"type":"string"},
"IAMRoleArn":{"type":"string"},
"InvalidParameterValueException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>",
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>",
"exception":true
},
"Lifecycle":{
"type":"structure",
"members":{
"MoveToColdStorageAfterDays":{
"shape":"Long",
"documentation":"<p>Specifies the number of days after creation that a recovery point is moved to cold storage.</p>"
},
"DeleteAfterDays":{
"shape":"Long",
"documentation":"<p>Specifies the number of days after creation that a recovery point is deleted. Must be greater than <code>MoveToColdStorageAfterDays</code>.</p>"
}
},
"documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p>"
},
"LimitExceededException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>",
"exception":true
},
"ListBackupJobsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"ByResourceArn":{
"shape":"ARN",
"documentation":"<p>Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"ByState":{
"shape":"BackupJobState",
"documentation":"<p>Returns only backup jobs that are in the specified state.</p>",
"location":"querystring",
"locationName":"state"
},
"ByBackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"querystring",
"locationName":"backupVaultName"
},
"ByCreatedBefore":{
"shape":"timestamp",
"documentation":"<p>Returns only backup jobs that were created before the specified date.</p>",
"location":"querystring",
"locationName":"createdBefore"
},
"ByCreatedAfter":{
"shape":"timestamp",
"documentation":"<p>Returns only backup jobs that were created after the specified date.</p>",
"location":"querystring",
"locationName":"createdAfter"
},
"ByResourceType":{
"shape":"ResourceType",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>SGW</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
}
}
},
"ListBackupJobsOutput":{
"type":"structure",
"members":{
"BackupJobs":{
"shape":"BackupJobsList",
"documentation":"<p>An array of structures containing metadata about your backup jobs returned in JSON format.</p>"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
}
}
},
"ListBackupPlanTemplatesInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListBackupPlanTemplatesOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"BackupPlanTemplatesList":{
"shape":"BackupPlanTemplatesList",
"documentation":"<p>An array of template list items containing metadata about your saved templates.</p>"
}
}
},
"ListBackupPlanVersionsInput":{
"type":"structure",
"required":["BackupPlanId"],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListBackupPlanVersionsOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"BackupPlanVersionsList":{
"shape":"BackupPlanVersionsList",
"documentation":"<p>An array of version list items containing metadata about your backup plans.</p>"
}
}
},
"ListBackupPlansInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"IncludeDeleted":{
"shape":"Boolean",
"documentation":"<p>A Boolean value with a default value of <code>FALSE</code> that returns deleted backup plans when set to <code>TRUE</code>.</p>",
"location":"querystring",
"locationName":"includeDeleted"
}
}
},
"ListBackupPlansOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"BackupPlansList":{
"shape":"BackupPlansList",
"documentation":"<p>An array of backup plan list items containing metadata about your saved backup plans.</p>"
}
}
},
"ListBackupSelectionsInput":{
"type":"structure",
"required":["BackupPlanId"],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListBackupSelectionsOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"BackupSelectionsList":{
"shape":"BackupSelectionsList",
"documentation":"<p>An array of backup selection list items containing metadata about each resource in the list.</p>"
}
}
},
"ListBackupVaultsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListBackupVaultsOutput":{
"type":"structure",
"members":{
"BackupVaultList":{
"shape":"BackupVaultList",
"documentation":"<p>An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.</p>"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
}
}
},
"ListOfTags":{
"type":"list",
"member":{"shape":"Condition"}
},
"ListProtectedResourcesInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListProtectedResourcesOutput":{
"type":"structure",
"members":{
"Results":{
"shape":"ProtectedResourcesList",
"documentation":"<p>An array of resources successfully backed up by AWS Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.</p>"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
}
}
},
"ListRecoveryPointsByBackupVaultInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"ByResourceArn":{
"shape":"ARN",
"documentation":"<p>Returns only recovery points that match the specified resource Amazon Resource Name (ARN).</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"ByResourceType":{
"shape":"ResourceType",
"documentation":"<p>Returns only recovery points that match the specified resource type.</p>",
"location":"querystring",
"locationName":"resourceType"
},
"ByBackupPlanId":{
"shape":"string",
"documentation":"<p>Returns only recovery points that match the specified backup plan ID.</p>",
"location":"querystring",
"locationName":"backupPlanId"
},
"ByCreatedBefore":{
"shape":"timestamp",
"documentation":"<p>Returns only recovery points that were created before the specified timestamp.</p>",
"location":"querystring",
"locationName":"createdBefore"
},
"ByCreatedAfter":{
"shape":"timestamp",
"documentation":"<p>Returns only recovery points that were created after the specified timestamp.</p>",
"location":"querystring",
"locationName":"createdAfter"
}
}
},
"ListRecoveryPointsByBackupVaultOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"RecoveryPoints":{
"shape":"RecoveryPointByBackupVaultList",
"documentation":"<p>An array of objects that contain detailed information about recovery points saved in a backup vault.</p>"
}
}
},
"ListRecoveryPointsByResourceInput":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListRecoveryPointsByResourceOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"RecoveryPoints":{
"shape":"RecoveryPointByResourceList",
"documentation":"<p>An array of objects that contain detailed information about recovery points of the specified resource type.</p>"
}
}
},
"ListRestoreJobsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListRestoreJobsOutput":{
"type":"structure",
"members":{
"RestoreJobs":{
"shape":"RestoreJobsList",
"documentation":"<p>An array of objects that contain detailed information about jobs to restore saved resources.</p>"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
}
}
},
"ListTagsInput":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for <code>ListTags</code> are recovery points, backup plans, and backup vaults.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListTagsOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.</p>"
}
}
},
"Long":{"type":"long"},
"MaxResults":{
"type":"integer",
"max":1000,
"min":1
},
"Metadata":{
"type":"map",
"key":{"shape":"MetadataKey"},
"value":{"shape":"MetadataValue"}
},
"MetadataKey":{"type":"string"},
"MetadataValue":{"type":"string"},
"MissingParameterValueException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>Indicates that a required parameter is missing.</p>",
"exception":true
},
"ProtectedResource":{
"type":"structure",
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
},
"LastBackupTime":{
"shape":"timestamp",
"documentation":"<p>The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastBackupTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
},
"documentation":"<p>A structure that contains information about a backed-up resource.</p>"
},
"ProtectedResourcesList":{
"type":"list",
"member":{"shape":"ProtectedResource"}
},
"PutBackupVaultAccessPolicyInput":{
"type":"structure",
"required":["BackupVaultName"],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"Policy":{
"shape":"IAMPolicy",
"documentation":"<p>The backup vault access policy document in JSON format.</p>"
}
}
},
"PutBackupVaultNotificationsInput":{
"type":"structure",
"required":[
"BackupVaultName",
"SNSTopicArn",
"BackupVaultEvents"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"SNSTopicArn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, <code>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</code>.</p>"
},
"BackupVaultEvents":{
"shape":"BackupVaultEvents",
"documentation":"<p>An array of events that indicate the status of jobs to back up resources to the backup vault.</p>"
}
}
},
"RecoveryPointByBackupVault":{
"type":"structure",
"members":{
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
},
"CreatedBy":{
"shape":"RecoveryPointCreator",
"documentation":"<p>Contains identifying information about the creation of a recovery point, including the <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>, and <code>BackupRuleId</code> of the backup plan that is used to create it.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"Status":{
"shape":"RecoveryPointStatus",
"documentation":"<p>A status code specifying the state of the recovery point.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of a backup.</p>"
},
"CalculatedLifecycle":{
"shape":"CalculatedLifecycle",
"documentation":"<p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
"documentation":"<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
},
"IsEncrypted":{
"shape":"boolean",
"documentation":"<p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>"
},
"LastRestoreTime":{
"shape":"timestamp",
"documentation":"<p>The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of <code>LastRestoreTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
},
"documentation":"<p>Contains detailed information about the recovery points stored in a backup vault.</p>"
},
"RecoveryPointByBackupVaultList":{
"type":"list",
"member":{"shape":"RecoveryPointByBackupVault"}
},
"RecoveryPointByResource":{
"type":"structure",
"members":{
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"Status":{
"shape":"RecoveryPointStatus",
"documentation":"<p>A status code specifying the state of the recovery point.</p>"
},
"EncryptionKeyArn":{
"shape":"ARN",
"documentation":"<p>The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
},
"BackupSizeBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of a backup.</p>"
},
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
}
},
"documentation":"<p>Contains detailed information about a saved recovery point.</p>"
},
"RecoveryPointByResourceList":{
"type":"list",
"member":{"shape":"RecoveryPointByResource"}
},
"RecoveryPointCreator":{
"type":"structure",
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"BackupPlanArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
},
"BackupPlanVersion":{
"shape":"string",
"documentation":"<p>Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.</p>"
},
"BackupRuleId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a rule used to schedule the backup of a selection of resources.</p>"
}
},
"documentation":"<p>Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.</p>"
},
"RecoveryPointStatus":{
"type":"string",
"enum":[
"COMPLETED",
"PARTIAL",
"DELETING",
"EXPIRED"
]
},
"ResourceArns":{
"type":"list",
"member":{"shape":"ARN"}
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>A resource that is required for the action doesn't exist.</p>",
"exception":true
},
"ResourceType":{
"type":"string",
"pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
},
"ResourceTypes":{
"type":"list",
"member":{"shape":"ResourceType"}
},
"RestoreJobId":{"type":"string"},
"RestoreJobStatus":{
"type":"string",
"enum":[
"PENDING",
"RUNNING",
"COMPLETED",
"ABORTED",
"FAILED"
]
},
"RestoreJobsList":{
"type":"list",
"member":{"shape":"RestoreJobsListMember"}
},
"RestoreJobsListMember":{
"type":"structure",
"members":{
"RestoreJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies the job that restores a recovery point.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"Status":{
"shape":"RestoreJobStatus",
"documentation":"<p>A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.</p>"
},
"StatusMessage":{
"shape":"string",
"documentation":"<p>A detailed message explaining the status of the job to restore a recovery point.</p>"
},
"PercentDone":{
"shape":"string",
"documentation":"<p>Contains an estimated percentage complete of a job at the time the job status was queried.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of the restored resource.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"ExpectedCompletionTimeMinutes":{
"shape":"Long",
"documentation":"<p>The amount of time in minutes that a job restoring a recovery point is expected to take.</p>"
},
"CreatedResourceArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
}
},
"documentation":"<p>Contains metadata about a restore job.</p>"
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>The request failed due to a temporary failure of the server.</p>",
"exception":true,
"fault":true
},
"StartBackupJobInput":{
"type":"structure",
"required":[
"BackupVaultName",
"ResourceArn",
"IamRoleArn"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>"
},
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"IdempotencyToken":{
"shape":"string",
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartBackupJob</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>StartBackupJob</code> multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.</p>"
},
"StartWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>The amount of time in minutes before beginning a backup.</p>"
},
"CompleteWindowMinutes":{
"shape":"WindowMinutes",
"documentation":"<p>The amount of time AWS Backup attempts a backup before canceling the job and returning an error.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"RecoveryPointTags":{
"shape":"Tags",
"documentation":"<p>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.</p>"
}
}
},
"StartBackupJobOutput":{
"type":"structure",
"members":{
"BackupJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
}
},
"StartRestoreJobInput":{
"type":"structure",
"required":[
"RecoveryPointArn",
"Metadata",
"IamRoleArn"
],
"members":{
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>A set of metadata key-value pairs. Lists the metadata that the recovery point was created with.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
},
"IdempotencyToken":{
"shape":"string",
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartRestoreJob</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>StartRestoreJob</code> multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores. </p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>SGW</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
}
}
},
"StartRestoreJobOutput":{
"type":"structure",
"members":{
"RestoreJobId":{
"shape":"RestoreJobId",
"documentation":"<p>Uniquely identifies the job that restores a recovery point.</p>"
}
}
},
"StopBackupJobInput":{
"type":"structure",
"required":["BackupJobId"],
"members":{
"BackupJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>",
"location":"uri",
"locationName":"backupJobId"
}
}
},
"StorageClass":{
"type":"string",
"enum":[
"WARM",
"COLD",
"DELETED"
]
},
"TagKey":{"type":"string"},
"TagKeyList":{
"type":"list",
"member":{"shape":"string"},
"sensitive":true
},
"TagResourceInput":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. </p>"
}
}
},
"TagValue":{"type":"string"},
"Tags":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"sensitive":true
},
"UntagResourceInput":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeyList"
],
"members":{
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"TagKeyList":{
"shape":"TagKeyList",
"documentation":"<p>A list of keys to identify which key-value tags to remove from a resource.</p>"
}
}
},
"UpdateBackupPlanInput":{
"type":"structure",
"required":[
"BackupPlanId",
"BackupPlan"
],
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>",
"location":"uri",
"locationName":"backupPlanId"
},
"BackupPlan":{
"shape":"BackupPlanInput",
"documentation":"<p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.</p>"
}
}
},
"UpdateBackupPlanOutput":{
"type":"structure",
"members":{
"BackupPlanId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a backup plan.</p>"
},
"BackupPlanArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"VersionId":{
"shape":"string",
"documentation":"<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.</p>"
}
}
},
"UpdateRecoveryPointLifecycleInput":{
"type":"structure",
"required":[
"BackupVaultName",
"RecoveryPointArn"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>",
"location":"uri",
"locationName":"recoveryPointArn"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
}
}
},
"UpdateRecoveryPointLifecycleOutput":{
"type":"structure",
"members":{
"BackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
},
"Lifecycle":{
"shape":"Lifecycle",
"documentation":"<p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"CalculatedLifecycle":{
"shape":"CalculatedLifecycle",
"documentation":"<p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps.</p>"
}
}
},
"WindowMinutes":{"type":"long"},
"boolean":{"type":"boolean"},
"long":{"type":"long"},
"string":{"type":"string"},
"timestamp":{"type":"timestamp"}
},
"documentation":"<fullname>AWS Backup</fullname> <p>AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.</p>"
}

27
botocore/data/batch/2016-08-10/paginators-1.json
View file

@ -1,3 +1,28 @@
{
"pagination": {}
"pagination": {
"DescribeComputeEnvironments": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "computeEnvironments"
},
"DescribeJobDefinitions": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "jobDefinitions"
},
"DescribeJobQueues": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "jobQueues"
},
"ListJobs": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "jobSummaryList"
}
}
}

21
botocore/data/budgets/2016-10-20/paginators-1.json
View file

@ -1,3 +1,22 @@
{
"pagination": {}
"pagination": {
"DescribeBudgets": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Budgets"
},
"DescribeNotificationsForBudget": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Notifications"
},
"DescribeSubscribersForNotification": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Subscribers"
}
}
}

12
botocore/data/ce/2017-10-25/service-2.json
View file

@ -657,7 +657,7 @@
},
"GroupBy":{
"shape":"GroupDefinitions",
"documentation":"<p>You can group the data by the following attributes:</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>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul>"
"documentation":"<p>You can group the data by the following attributes:</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>TENANCY</p> </li> </ul>"
},
"Granularity":{
"shape":"Granularity",
@ -667,7 +667,10 @@
"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>"
},
"Metrics":{"shape":"MetricNames"},
"Metrics":{
"shape":"MetricNames",
"documentation":"<p>The measurement that you want your reservation coverage reported in.</p> <p>Valid values are <code>Hour</code>, <code>Unit</code>, and <code>Cost</code>. You can use multiple values in a request.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
"documentation":"<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>"
@ -1220,7 +1223,10 @@
"ReservationPurchaseRecommendationDetail":{
"type":"structure",
"members":{
"AccountId":{"shape":"GenericString"},
"AccountId":{
"shape":"GenericString",
"documentation":"<p>The account that this RI recommendation is for.</p>"
},
"InstanceDetails":{
"shape":"InstanceDetails",
"documentation":"<p>Details about the instances that AWS recommends that you purchase.</p>"

15
botocore/data/chime/2018-05-01/paginators-1.json
View file

@ -1,3 +1,16 @@
{
"pagination": {}
"pagination": {
"ListAccounts": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Accounts"
},
"ListUsers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Users"
}
}
}

18
botocore/data/chime/2018-05-01/service-2.json
View file

@ -28,7 +28,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Users suspended from a <code>Team</code> account are dissociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so.</p> <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and are no longer able to sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action. </p> <p>To sign out users without suspending them, use the <a>LogoutUser</a> action.</p>"
"documentation":"<p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Users suspended from a <code>Team</code> account are dissociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so.</p> <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and are no longer able to sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action. </p> <p>To sign out users without suspending them, use the <a>LogoutUser</a> action.</p>"
},
"BatchUnsuspendUser":{
"name":"BatchUnsuspendUser",
@ -48,7 +48,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime <code>EnterpriseLWA</code> account. Only users on <code>EnterpriseLWA</code> accounts can be unsuspended using this action. For more information about different account types, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Previously suspended users who are unsuspended using this action are returned to <code>Registered</code> status. Users who are not previously suspended are ignored.</p>"
"documentation":"<p>Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime <code>EnterpriseLWA</code> account. Only users on <code>EnterpriseLWA</code> accounts can be unsuspended using this action. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Previously suspended users who are unsuspended using this action are returned to <code>Registered</code> status. Users who are not previously suspended are ignored.</p>"
},
"BatchUpdateUser":{
"name":"BatchUpdateUser",
@ -88,7 +88,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Creates an Amazon Chime account under the administrator's AWS account. Only <code>Team</code> account types are currently supported for this action. For more information about different account types, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
"documentation":"<p>Creates an Amazon Chime account under the administrator's AWS account. Only <code>Team</code> account types are currently supported for this action. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
},
"DeleteAccount":{
"name":"DeleteAccount",
@ -147,7 +147,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
"documentation":"<p>Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
},
"GetUser":{
"name":"GetUser",
@ -307,7 +307,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
"documentation":"<p>Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
},
"UpdateUser":{
"name":"UpdateUser",
@ -353,7 +353,7 @@
},
"AccountType":{
"shape":"AccountType",
"documentation":"<p>The Amazon Chime account type. For more information about different account types, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
"documentation":"<p>The Amazon Chime account type. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
},
"CreatedTimestamp":{
"shape":"Iso8601Timestamp",
@ -389,10 +389,10 @@
},
"EnableDialOut":{
"shape":"Boolean",
"documentation":"<p>Setting that allows meeting participants to choose the <b>Call me at a phone number</b> option. For more information, see <a href=\"http://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html\">Join a Meeting without the Amazon Chime App</a>.</p>"
"documentation":"<p>Setting that allows meeting participants to choose the <b>Call me at a phone number</b> option. For more information, see <a href=\"https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html\">Join a Meeting without the Amazon Chime App</a>.</p>"
}
},
"documentation":"<p>Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
"documentation":"<p>Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/policies.html\">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
},
"AccountType":{
"type":"string",
@ -1145,5 +1145,5 @@
"member":{"shape":"User"}
}
},
"documentation":"<p>The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.</p> <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.</p> <dl> <dt>Using an AWS SDK</dt> <dd> <p>You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the <a href=\"http://aws.amazon.com/developer/\">AWS Developer Center</a>.</p> </dd> <dt>Using the AWS CLI</dt> <dd> <p>Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/installing.html\">Installing the AWS Command Line Interface</a> in the <i>AWS Command Line Interface User Guide</i>. For a list of available Amazon Chime commands, see the <a href=\"http://docs.aws.amazon.com/cli/latest/reference/chime/index.html\">Amazon Chime commands</a> in the <i>AWS CLI Command Reference</i>.</p> </dd> <dt>Using REST API</dt> <dd> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>When making REST API calls, use the service name <code>chime</code> and REST endpoint <code>https://service.chime.aws.amazon.com</code>.</p> </dd> </dl> <p>Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see <a href=\"http://docs.aws.amazon.com/chime/latest/ag/control-access.html\">Control Access to the Amazon Chime Console</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
"documentation":"<p>The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.</p> <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.</p> <dl> <dt>Using an AWS SDK</dt> <dd> <p>You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the <a href=\"http://aws.amazon.com/developer/\">AWS Developer Center</a>.</p> </dd> <dt>Using the AWS CLI</dt> <dd> <p>Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/installing.html\">Installing the AWS Command Line Interface</a> in the <i>AWS Command Line Interface User Guide</i>. For a list of available Amazon Chime commands, see the <a href=\"https://docs.aws.amazon.com/cli/latest/reference/chime/index.html\">Amazon Chime commands</a> in the <i>AWS CLI Command Reference</i>.</p> </dd> <dt>Using REST API</dt> <dd> <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>When making REST API calls, use the service name <code>chime</code> and REST endpoint <code>https://service.chime.aws.amazon.com</code>.</p> </dd> </dl> <p>Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/control-access.html\">Control Access to the Amazon Chime Console</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
}

35
botocore/data/cloud9/2017-09-23/service-2.json
View file

@ -459,13 +459,18 @@
"ownerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the environment owner.</p>"
},
"lifecycle":{
"shape":"EnvironmentLifecycle",
"documentation":"<p>The state of the environment in its creation or deletion lifecycle.</p>"
}
},
"documentation":"<p>Information about an AWS Cloud9 development environment.</p>"
},
"EnvironmentDescription":{
"type":"string",
"max":200
"max":200,
"sensitive":true
},
"EnvironmentId":{
"type":"string",
@ -475,6 +480,32 @@
"type":"list",
"member":{"shape":"EnvironmentId"}
},
"EnvironmentLifecycle":{
"type":"structure",
"members":{
"status":{
"shape":"EnvironmentLifecycleStatus",
"documentation":"<p>The current creation or deletion lifecycle state of the environment.</p> <ul> <li> <p> <code>CREATED</code>: The environment was successfully created.</p> </li> <li> <p> <code>DELETE_FAILED</code>: The environment failed to delete.</p> </li> <li> <p> <code>DELETING</code>: The environment is in the process of being deleted.</p> </li> </ul>"
},
"reason":{
"shape":"String",
"documentation":"<p>Any informational message about the lifecycle state of the environment.</p>"
},
"failureResource":{
"shape":"String",
"documentation":"<p>If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.</p>"
}
},
"documentation":"<p>Information about the current creation or deletion lifecycle state of an AWS Cloud9 development environment.</p>"
},
"EnvironmentLifecycleStatus":{
"type":"string",
"enum":[
"CREATED",
"DELETING",
"DELETE_FAILED"
]
},
"EnvironmentList":{
"type":"list",
"member":{"shape":"Environment"}
@ -689,7 +720,7 @@
},
"UserArn":{
"type":"string",
"pattern":"arn:aws:(iam|sts)::\\d+:\\S+"
"pattern":"arn:aws:(iam|sts)::\\d+:(root|user|federated-user|assumed-role)\\/?\\S*"
}
},
"documentation":"<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>For more information about AWS Cloud9, see the <a href=\"https://docs.aws.amazon.com/cloud9/latest/user-guide\">AWS Cloud9 User Guide</a>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>"

18
botocore/data/clouddirectory/2017-01-11/paginators-1.json
View file

@ -95,6 +95,24 @@
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListIncomingTypedLinks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "LinkSpecifiers"
},
"ListManagedSchemaArns": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SchemaArns"
},
"ListOutgoingTypedLinks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TypedLinkSpecifiers"
}
}
}

55
botocore/data/cloudformation/2010-05-15/paginators-1.json
View file

@ -1,5 +1,31 @@
{
"pagination": {
"DescribeAccountLimits": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "AccountLimits"
},
"DescribeChangeSet": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Changes",
"non_aggregate_keys": [
"ChangeSetName",
"ChangeSetId",
"StackId",
"StackName",
"Description",
"Parameters",
"CreationTime",
"ExecutionStatus",
"Status",
"StatusReason",
"NotificationARNs",
"RollbackConfiguration",
"Capabilities",
"Tags"
]
},
"DescribeStackEvents": {
"input_token": "NextToken",
"output_token": "NextToken",
@ -10,6 +36,17 @@
"output_token": "NextToken",
"result_key": "Stacks"
},
"ListChangeSets": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Summaries"
},
"ListStackInstances": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Summaries"
},
"ListStackResources": {
"input_token": "NextToken",
"output_token": "NextToken",
@ -20,6 +57,24 @@
"output_token": "NextToken",
"result_key": "StackSummaries"
},
"ListStackSetOperationResults": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Summaries"
},
"ListStackSetOperations": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Summaries"
},
"ListStackSets": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Summaries"
},
"ListExports": {
"input_token": "NextToken",
"output_token": "NextToken",

18
botocore/data/cloudhsm/2014-05-30/paginators-1.json
View file

@ -1,3 +1,19 @@
{
"pagination": {}
"pagination": {
"ListHapgs": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "HapgList"
},
"ListHsms": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "HsmList"
},
"ListLunaClients": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "ClientList"
}
}
}

10
botocore/data/cloudtrail/2013-11-01/paginators-1.json
View file

@ -5,6 +5,16 @@
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Events"
},
"ListPublicKeys": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "PublicKeyList"
},
"ListTags": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "ResourceTagList"
}
}
}

6
botocore/data/cloudwatch/2010-08-01/paginators-1.json
View file

@ -21,6 +21,12 @@
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Metrics"
},
"GetMetricData": {
"input_token": "NextToken",
"limit_key": "MaxDatapoints",
"output_token": "NextToken",
"result_key": "MetricDataResults"
}
}
}

34
botocore/data/cloudwatch/2010-08-01/service-2.json
View file

@ -137,7 +137,7 @@
"errors":[
{"shape":"InvalidNextToken"}
],
"documentation":"<p>You can use the <code>GetMetricData</code> API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p>"
"documentation":"<p>You can use the <code>GetMetricData</code> API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p>"
},
"GetMetricStatistics":{
"name":"GetMetricStatistics",
@ -156,7 +156,7 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"InternalServiceFault"}
],
"documentation":"<p>Gets statistics for the specified metric.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.</p> <p>CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1.</p> </li> <li> <p>The Min and the Max values of the statistic set are equal.</p> </li> </ul> <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p> <p>For information about metrics and dimensions supported by AWS services, see the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
"documentation":"<p>Gets statistics for the specified metric.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.</p> <p>CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1.</p> </li> <li> <p>The Min and the Max values of the statistic set are equal.</p> </li> </ul> <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p> <p>For information about metrics and dimensions supported by AWS services, see the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
},
"GetMetricWidgetImage":{
"name":"GetMetricWidgetImage",
@ -232,7 +232,7 @@
"errors":[
{"shape":"LimitExceededFault"}
],
"documentation":"<p>Creates or updates an alarm and associates it with the specified metric or metric math expression.</p> <p>When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.</p> <p>If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:</p> <ul> <li> <p> <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p> </li> <li> <p> <code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on EC2 instance status metrics</p> </li> <li> <p> <code>ec2:StopInstances</code> for alarms with stop actions</p> </li> <li> <p> <code>ec2:TerminateInstances</code> for alarms with terminate actions</p> </li> <li> <p> <code>ec2:DescribeInstanceRecoveryAttribute</code> and <code>ec2:RecoverInstances</code> for alarms with recover actions</p> </li> </ul> <p>If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.</p> <p>If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.</p> <p>If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.</p> <p>The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called <code>AWSServiceRoleForCloudWatchEvents</code>. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role\">AWS service-linked role</a>.</p>"
"documentation":"<p>Creates or updates an alarm and associates it with the specified metric or metric math expression.</p> <p>When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.</p> <p>If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:</p> <ul> <li> <p> <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p> </li> <li> <p> <code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on EC2 instance status metrics</p> </li> <li> <p> <code>ec2:StopInstances</code> for alarms with stop actions</p> </li> <li> <p> <code>ec2:TerminateInstances</code> for alarms with terminate actions</p> </li> <li> <p> <code>ec2:DescribeInstanceRecoveryAttribute</code> and <code>ec2:RecoverInstances</code> for alarms with recover actions</p> </li> </ul> <p>If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.</p> <p>If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.</p> <p>If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.</p> <p>The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called <code>AWSServiceRoleForCloudWatchEvents</code>. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role\">AWS service-linked role</a>.</p>"
},
"PutMetricData":{
"name":"PutMetricData",
@ -247,7 +247,7 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"InternalServiceFault"}
],
"documentation":"<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>You can publish either individual data points in the <code>Value</code> field, or arrays of values and the number of times each value occurred during the period by using the <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric with one <code>PutMetricData</code> request, and supports retrieving percentile statistics on this data.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricData</a> or <a>GetMetricStatistics</a> from the time they are submitted.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>, <code>Max</code>, and <code>Sum</code> are all equal.</p> </li> <li> <p>The <code>Min</code> and <code>Max</code> are equal, and <code>Sum</code> is equal to <code>Min</code> multiplied by <code>SampleCount</code>.</p> </li> </ul>"
"documentation":"<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>You can publish either individual data points in the <code>Value</code> field, or arrays of values and the number of times each value occurred during the period by using the <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric with one <code>PutMetricData</code> request, and supports retrieving percentile statistics on this data.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricData</a> or <a>GetMetricStatistics</a> from the time they are submitted.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>, <code>Max</code>, and <code>Sum</code> are all equal.</p> </li> <li> <p>The <code>Min</code> and <code>Max</code> are equal, and <code>Sum</code> is equal to <code>Min</code> multiplied by <code>SampleCount</code>.</p> </li> </ul>"
},
"SetAlarmState":{
"name":"SetAlarmState",
@ -784,11 +784,11 @@
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The time stamp indicating the earliest data to be returned.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response from CloudWatch then setting 12:07 or 12:29 as the <code>StartTime</code>.</p>"
"documentation":"<p>The time stamp indicating the earliest data to be returned.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time stamp indicating the latest data to be returned.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response from CloudWatch then setting 12:07 or 12:29 as the <code>EndTime</code>.</p>"
"documentation":"<p>The time stamp indicating the latest data to be returned.</p> <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values that align with the value of the metric's <code>Period</code> and sync up with the beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5 minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response from CloudWatch than setting 12:07 or 12:29 as the <code>EndTime</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -838,7 +838,7 @@
},
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p>The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations\">Dimension Combinations</a> in the <i>Amazon CloudWatch User Guide</i>. For more information about specifying dimensions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
"documentation":"<p>The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations\">Dimension Combinations</a> in the <i>Amazon CloudWatch User Guide</i>. For more information about specifying dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
},
"StartTime":{
"shape":"Timestamp",
@ -889,7 +889,7 @@
},
"OutputFormat":{
"shape":"OutputFormat",
"documentation":"<p>The format of the resulting image. Only PNG images are supported.</p> <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns an HTTP response with the content-type set to <code>text/xml</code>. The image data is in a <code>MetricWidgetImage</code> field. For example:</p> <p> <code> &lt;GetMetricWidgetImageResponse xmlns=\"http://monitoring.amazonaws.com/doc/2010-08-01/\"&gt;</code> </p> <p> <code> &lt;GetMetricWidgetImageResult&gt;</code> </p> <p> <code> &lt;MetricWidgetImage&gt;</code> </p> <p> <code> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...</code> </p> <p> <code> &lt;/MetricWidgetImage&gt;</code> </p> <p> <code> &lt;/GetMetricWidgetImageResult&gt;</code> </p> <p> <code> &lt;ResponseMetadata&gt;</code> </p> <p> <code> &lt;RequestId&gt;6f0d4192-4d42-11e8-82c1-f539a07e0e3b&lt;/RequestId&gt;</code> </p> <p> <code> &lt;/ResponseMetadata&gt;</code> </p> <p> <code>&lt;/GetMetricWidgetImageResponse&gt;</code> </p> <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use <code>png</code>. If you specify <code>image/png</code>, the HTTP response has a content-type set to <code>image/png</code>, and the body of the response is a PNG image. </p>"
"documentation":"<p>The format of the resulting image. Only PNG images are supported.</p> <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns an HTTP response with the content-type set to <code>text/xml</code>. The image data is in a <code>MetricWidgetImage</code> field. For example:</p> <p> <code> &lt;GetMetricWidgetImageResponse xmlns=&lt;URLstring&gt;&gt;</code> </p> <p> <code> &lt;GetMetricWidgetImageResult&gt;</code> </p> <p> <code> &lt;MetricWidgetImage&gt;</code> </p> <p> <code> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...</code> </p> <p> <code> &lt;/MetricWidgetImage&gt;</code> </p> <p> <code> &lt;/GetMetricWidgetImageResult&gt;</code> </p> <p> <code> &lt;ResponseMetadata&gt;</code> </p> <p> <code> &lt;RequestId&gt;6f0d4192-4d42-11e8-82c1-f539a07e0e3b&lt;/RequestId&gt;</code> </p> <p> <code> &lt;/ResponseMetadata&gt;</code> </p> <p> <code>&lt;/GetMetricWidgetImageResponse&gt;</code> </p> <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use <code>png</code>. If you specify <code>image/png</code>, the HTTP response has a content-type set to <code>image/png</code>, and the body of the response is a PNG image. </p>"
}
}
},
@ -1292,7 +1292,7 @@
},
"Expression":{
"shape":"MetricExpression",
"documentation":"<p>The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other expressions to use the result of those expressions. For more information about metric math expressions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Within each MetricDataQuery object, you must specify either <code>Expression</code> or <code>MetricStat</code> but not both.</p>"
"documentation":"<p>The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other expressions to use the result of those expressions. For more information about metric math expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Within each MetricDataQuery object, you must specify either <code>Expression</code> or <code>MetricStat</code> but not both.</p>"
},
"Label":{
"shape":"MetricLabel",
@ -1303,7 +1303,7 @@
"documentation":"<p>When used in <code>GetMetricData</code>, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify <code>False</code>. If you omit this, the default of <code>True</code> is used.</p> <p>When used in <code>PutMetricAlarm</code>, specify <code>True</code> for the one expression result to use as the alarm. For all other metrics and expressions in the same <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as False.</p>"
}
},
"documentation":"<p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported use of this structure is different for those two operations.</p> <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single <code>GetMetricData</code> call can include up to 100 <code>MetricDataQuery</code> structures.</p> <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a metric math expression. Each <code>MetricDataQuery</code> in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single <code>PutMetricAlarm</code> call can include up to 20 <code>MetricDataQuery</code> structures in the array. The 20 structures can include as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a metric, and as many as 10 structures that contain the <code>Expression</code> parameter to perform a math expression. Any expression used in a <code>PutMetricAlarm</code> operation must return a single time series. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code> operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>"
"documentation":"<p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported use of this structure is different for those two operations.</p> <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single <code>GetMetricData</code> call can include up to 100 <code>MetricDataQuery</code> structures.</p> <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a metric math expression. Each <code>MetricDataQuery</code> in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single <code>PutMetricAlarm</code> call can include up to 20 <code>MetricDataQuery</code> structures in the array. The 20 structures can include as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a metric, and as many as 10 structures that contain the <code>Expression</code> parameter to perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code> as the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p> <p>Any expression used in a <code>PutMetricAlarm</code> operation must return a single time series. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code> operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>"
},
"MetricDataResult":{
"type":"structure",
@ -1381,7 +1381,7 @@
},
"StorageResolution":{
"shape":"StorageResolution",
"documentation":"<p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics\">High-Resolution Metrics</a> in the <i>Amazon CloudWatch User Guide</i>. </p> <p>This field is optional, if you do not specify it the default of 60 is used.</p>"
"documentation":"<p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics\">High-Resolution Metrics</a> in the <i>Amazon CloudWatch User Guide</i>. </p> <p>This field is optional, if you do not specify it the default of 60 is used.</p>"
}
},
"documentation":"<p>Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.</p>"
@ -1521,11 +1521,11 @@
},
"AlarmActions":{
"shape":"ResourceList",
"documentation":"<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
"documentation":"<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
},
"InsufficientDataActions":{
"shape":"ResourceList",
"documentation":"<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>&gt;arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
"documentation":"<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>&gt;arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
},
"MetricName":{
"shape":"MetricName",
@ -1561,7 +1561,7 @@
},
"DatapointsToAlarm":{
"shape":"DatapointsToAlarm",
"documentation":"<p>The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation\">Evaluating an Alarm</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
"documentation":"<p>The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation\">Evaluating an Alarm</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
},
"Threshold":{
"shape":"Threshold",
@ -1573,15 +1573,15 @@
},
"TreatMissingData":{
"shape":"TreatMissingData",
"documentation":"<p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data\">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p> <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code> </p>"
"documentation":"<p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data\">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p> <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code> </p>"
},
"EvaluateLowSampleCountPercentile":{
"shape":"EvaluateLowSampleCountPercentile",
"documentation":"<p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state does not change during periods with too few data points to be statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples\">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p> <p>Valid Values: <code>evaluate | ignore</code> </p>"
"documentation":"<p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state does not change during periods with too few data points to be statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples\">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p> <p>Valid Values: <code>evaluate | ignore</code> </p>"
},
"Metrics":{
"shape":"MetricDataQueries",
"documentation":"<p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a metric math expression. Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p> <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>"
"documentation":"<p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a metric math expression. Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p> <p>One item in the <code>Metrics</code> array is the expression that the alarm watches. You designate this expression by setting <code>ReturnValue</code> to true for this object in the array. For more information, see <a>MetricDataQuery</a>.</p> <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>"
}
}
},

134
botocore/data/codebuild/2016-10-06/service-2.json
View file

@ -80,7 +80,7 @@
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.</p> <important> <p>If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in <a href=\"http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console\">Change a Build Project's Settings</a>.</p> </important>"
"documentation":"<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.</p> <important> <p>If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console\">Change a Build Project's Settings</a>.</p> </important>"
},
"DeleteProject":{
"name":"DeleteProject",
@ -603,11 +603,20 @@
"type":"list",
"member":{"shape":"BuildNotDeleted"}
},
"CacheMode":{
"type":"string",
"enum":[
"LOCAL_DOCKER_LAYER_CACHE",
"LOCAL_SOURCE_CACHE",
"LOCAL_CUSTOM_CACHE"
]
},
"CacheType":{
"type":"string",
"enum":[
"NO_CACHE",
"S3"
"S3",
"LOCAL"
]
},
"CloudWatchLogsConfig":{
@ -620,11 +629,11 @@
},
"groupName":{
"shape":"String",
"documentation":"<p> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a>. </p>"
"documentation":"<p> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a>. </p>"
},
"streamName":{
"shape":"String",
"documentation":"<p> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a>. </p>"
"documentation":"<p> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a>. </p>"
}
},
"documentation":"<p> Information about Amazon CloudWatch Logs for a build project. </p>"
@ -732,7 +741,11 @@
},
"branchFilter":{
"shape":"String",
"documentation":"<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p>"
"documentation":"<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p> It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>"
},
"filterGroups":{
"shape":"FilterGroups",
"documentation":"<p> An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p> For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>"
}
}
},
@ -745,6 +758,10 @@
}
}
},
"CredentialProviderType":{
"type":"string",
"enum":["SECRETS_MANAGER"]
},
"DeleteProjectInput":{
"type":"structure",
"required":["name"],
@ -892,10 +909,25 @@
"type":"list",
"member":{"shape":"EnvironmentVariable"}
},
"FilterGroup":{
"type":"list",
"member":{"shape":"WebhookFilter"}
},
"FilterGroups":{
"type":"list",
"member":{"shape":"FilterGroup"}
},
"GitCloneDepth":{
"type":"integer",
"min":0
},
"ImagePullCredentialsType":{
"type":"string",
"enum":[
"CODEBUILD",
"SERVICE_ROLE"
]
},
"ImageVersions":{
"type":"list",
"member":{"shape":"String"}
@ -1351,15 +1383,23 @@
"members":{
"type":{
"shape":"CacheType",
"documentation":"<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project does not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project reads and writes from and to S3.</p> </li> </ul>"
"documentation":"<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project does not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project reads and writes from and to S3.</p> </li> <li> <p> <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</p> </li> </ul>"
},
"location":{
"shape":"String",
"documentation":"<p>Information about the cache location: </p> <ul> <li> <p> <code>NO_CACHE</code>: This value is ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>"
"documentation":"<p>Information about the cache location: </p> <ul> <li> <p> <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>"
},
"modes":{
"shape":"ProjectCacheModes",
"documentation":"<p> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. </p> <ul> <li> <p> <code>LOCAL_SOURCE_CACHE</code> mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket) and you choose this option, then it is ignored. </p> </li> <li> <p> <code>LOCAL_DOCKER_LAYER_CACHE</code> mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance hit that would be caused by pulling large Docker images down from the network. </p> <note> <ul> <li> <p> You can only use a Docker layer cache in the Linux enviornment. </p> </li> <li> <p> The <code>privileged</code> flag must be set so that your project has the necessary Docker privileges. </p> </li> <li> <p> You should consider the security implications before using a Docker layer cache. </p> </li> </ul> </note> </li> </ul> <ul> <li> <p> <code>LOCAL_CUSTOM_CACHE</code> mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario does not match one that works well with one of the other three local cache modes. If you use a custom cache: </p> <ul> <li> <p> Only directories can be specified for caching. You cannot specify individual files. </p> </li> <li> <p> Symlinks are used to reference cached directories. </p> </li> <li> <p> Cached directories are linked to your build before it downloads its project sources. Cached items are overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Information about the cache for the build project.</p>"
},
"ProjectCacheModes":{
"type":"list",
"member":{"shape":"CacheMode"}
},
"ProjectDescription":{
"type":"string",
"max":255,
@ -1379,7 +1419,7 @@
},
"image":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the Docker image to use for this build project.</p>"
"documentation":"<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code>registry/repository:tag</code>. For example, to specify an image with the tag \"latest,\" use <code>registry/repository:latest</code>.</p> </li> <li> <p>For an image digest: <code>registry/repository@digest</code>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <code>registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul>"
},
"computeType":{
"shape":"ComputeType",
@ -1396,6 +1436,14 @@
"certificate":{
"shape":"String",
"documentation":"<p>The certificate to use with this build project.</p>"
},
"registryCredential":{
"shape":"RegistryCredential",
"documentation":"<p> The credentials for access to a private registry.</p>"
},
"imagePullCredentialsType":{
"shape":"ImagePullCredentialsType",
"documentation":"<p> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. </p> </li> </ul> <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. </p>"
}
},
"documentation":"<p>Information about the build environment of the build project.</p>"
@ -1493,6 +1541,24 @@
"type":"list",
"member":{"shape":"Project"}
},
"RegistryCredential":{
"type":"structure",
"required":[
"credential",
"credentialProvider"
],
"members":{
"credential":{
"shape":"NonEmptyString",
"documentation":"<p> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current region. </p> </note>"
},
"credentialProvider":{
"shape":"CredentialProviderType",
"documentation":"<p> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </p>"
}
},
"documentation":"<p> Information about credentials that provide access to a private Docker registry. When this is set: </p> <ul> <li> <p> <code>imagePullCredentialsType</code> must be set to <code>SERVICE_ROLE</code>. </p> </li> <li> <p> images cannot be curated or an Amazon ECR image.</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html\">Private Registry with AWS Secrets Manager Sample for AWS CodeBuild</a>. </p>"
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
@ -1703,6 +1769,14 @@
"logsConfigOverride":{
"shape":"LogsConfig",
"documentation":"<p> Log settings for this build that override the log settings defined in the build project. </p>"
},
"registryCredentialOverride":{
"shape":"RegistryCredential",
"documentation":"<p> The credentials for access to a private registry. </p>"
},
"imagePullCredentialsTypeOverride":{
"shape":"ImagePullCredentialsType",
"documentation":"<p> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.</p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. </p> </li> </ul> <p> When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. </p>"
}
}
},
@ -1866,11 +1940,15 @@
},
"branchFilter":{
"shape":"String",
"documentation":"<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p>"
"documentation":"<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p> It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>"
},
"rotateSecret":{
"shape":"Boolean",
"documentation":"<p> A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </p>"
},
"filterGroups":{
"shape":"FilterGroups",
"documentation":"<p> An array of arrays of <code>WebhookFilter</code> objects used to determine if a webhook event can trigger a build. A filter group must pcontain at least one <code>EVENT</code> <code>WebhookFilter</code>. </p>"
}
}
},
@ -1924,7 +2002,11 @@
},
"branchFilter":{
"shape":"String",
"documentation":"<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p>"
"documentation":"<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p> It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>"
},
"filterGroups":{
"shape":"FilterGroups",
"documentation":"<p> An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p> For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>"
},
"lastModifiedSecret":{
"shape":"Timestamp",
@ -1933,6 +2015,38 @@
},
"documentation":"<p>Information about a webhook that connects repository events to a build project in AWS CodeBuild.</p>"
},
"WebhookFilter":{
"type":"structure",
"required":[
"type",
"pattern"
],
"members":{
"type":{
"shape":"WebhookFilterType",
"documentation":"<p> The type of webhook filter. There are five webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, and <code>FILE_PATH</code>. </p> <dl> <dt> EVENT </dt> <dd> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of four event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, and <code>PULL_REQUEST_REOPENED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub Enterprise only. </p> </note> </dd> <dt> ACTOR_ACCOUNT_ID </dt> <dd> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </dd> <dt> HEAD_REF </dt> <dd> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. </p> </dd> <dt> BASE_REF </dt> <dd> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </dd> <dt> FILE_PATH </dt> <dd> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and GitHub Enterprise push events only. </p> </note> </dd> </dl>"
},
"pattern":{
"shape":"String",
"documentation":"<p> For a <code>WebHookFilter</code> that uses <code>EVENT</code> type, a comma-separated string that specifies one or more events. For example, the webhook filter <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> allows all push, pull request created, and pull request updated events to trigger a build. </p> <p> For a <code>WebHookFilter</code> that uses any of the other filter types, a regular expression pattern. For example, a <code>WebHookFilter</code> that uses <code>HEAD_REF</code> for its <code>type</code> and the pattern <code>^refs/heads/</code> triggers a build when the head reference is a branch with a reference name <code>refs/heads/branch-name</code>. </p>"
},
"excludeMatchedPattern":{
"shape":"WrapperBoolean",
"documentation":"<p> Used to indicate that the <code>pattern</code> determines which webhook events do not trigger a build. If true, then a webhook event that does not match the <code>pattern</code> triggers a build. If false, then a webhook event that matches the <code>pattern</code> triggers a build. </p>"
}
},
"documentation":"<p> A filter used to determine which webhooks trigger a build. </p>"
},
"WebhookFilterType":{
"type":"string",
"enum":[
"EVENT",
"BASE_REF",
"HEAD_REF",
"ACTOR_ACCOUNT_ID",
"FILE_PATH"
]
},
"WrapperBoolean":{"type":"boolean"},
"WrapperInt":{"type":"integer"},
"WrapperLong":{"type":"long"}

313
botocore/data/codecommit/2015-04-13/service-2.json
View file

File diff suppressed because one or more lines are too long

15
botocore/data/codedeploy/2014-10-06/paginators-1.json
View file

@ -29,6 +29,21 @@
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "deployments"
},
"ListDeploymentTargets": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "targetIds"
},
"ListGitHubAccountTokenNames": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "tokenNameList"
},
"ListOnPremisesInstances": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "instanceNames"
}
}
}

238
botocore/data/codedeploy/2014-10-06/service-2.json
View file

@ -101,7 +101,7 @@
{"shape":"BatchLimitExceededException"},
{"shape":"InvalidComputePlatformException"}
],
"documentation":"<note> <p> This method works, but is considered deprecated. Use <code>BatchGetDeploymentTargets</code> instead. </p> </note> <p> Returns an array of instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer <code>BatchGetDeploymentTargets</code> works with all compute platforms. </p>",
"documentation":"<note> <p> This method works, but is deprecated. Use <code>BatchGetDeploymentTargets</code> instead. </p> </note> <p> Returns an array of instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer <code>BatchGetDeploymentTargets</code> works with all compute platforms. </p>",
"deprecated":true,
"deprecatedMessage":"This operation is deprecated, use BatchGetDeploymentTargets instead."
},
@ -122,7 +122,7 @@
{"shape":"DeploymentTargetDoesNotExistException"},
{"shape":"DeploymentTargetListSizeExceededException"}
],
"documentation":"<p> Returns an array of targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated <code>BatchGetDeploymentInstances</code>. </p> <p> The type of targets returned depends on the deployment's compute platform: </p> <ul> <li> <p> <b>EC2/On-premises</b> - Information about EC2 instance targets. </p> </li> <li> <p> <b>AWS Lambda</b> - Information about Lambda functions targets. </p> </li> <li> <p> <b>Amazon ECS</b> - Information about ECS service targets. </p> </li> </ul>"
"documentation":"<p> Returns an array of targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated <code>BatchGetDeploymentInstances</code>. </p> <p> The type of targets returned depends on the deployment's compute platform: </p> <ul> <li> <p> <b>EC2/On-premises</b>: Information about EC2 instance targets. </p> </li> <li> <p> <b>AWS Lambda</b>: Information about Lambda functions targets. </p> </li> <li> <p> <b>Amazon ECS</b>: Information about Amazon ECS service targets. </p> </li> </ul>"
},
"BatchGetDeployments":{
"name":"BatchGetDeployments",
@ -285,7 +285,7 @@
{"shape":"InvalidTargetGroupPairException"},
{"shape":"ECSServiceMappingLimitExceededException"}
],
"documentation":"<p>Creates a deployment group to which application revisions will be deployed.</p>"
"documentation":"<p>Creates a deployment group to which application revisions are deployed.</p>"
},
"DeleteApplication":{
"name":"DeleteApplication",
@ -533,7 +533,7 @@
"errors":[
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the applications registered with the applicable IAM user or AWS account.</p>"
"documentation":"<p>Lists the applications registered with the IAM user or AWS account.</p>"
},
"ListDeploymentConfigs":{
"name":"ListDeploymentConfigs",
@ -546,7 +546,7 @@
"errors":[
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the deployment configurations with the applicable IAM user or AWS account.</p>"
"documentation":"<p>Lists the deployment configurations with the IAM user or AWS account.</p>"
},
"ListDeploymentGroups":{
"name":"ListDeploymentGroups",
@ -562,7 +562,7 @@
{"shape":"ApplicationDoesNotExistException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the deployment groups for an application registered with the applicable IAM user or AWS account.</p>"
"documentation":"<p>Lists the deployment groups for an application registered with the IAM user or AWS account.</p>"
},
"ListDeploymentInstances":{
"name":"ListDeploymentInstances",
@ -584,7 +584,7 @@
{"shape":"InvalidTargetFilterNameException"},
{"shape":"InvalidComputePlatformException"}
],
"documentation":"<note> <p> The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. <code>ListDeploymentInstances</code> throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda. </p> </note> <p> Lists the instance for a deployment associated with the applicable IAM user or AWS account. </p>",
"documentation":"<note> <p> The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. <code>ListDeploymentInstances</code> throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda. </p> </note> <p> Lists the instance for a deployment associated with the IAM user or AWS account. </p>",
"deprecated":true,
"deprecatedMessage":"This operation is deprecated, use ListDeploymentTargets instead."
},
@ -627,7 +627,7 @@
{"shape":"InvalidDeploymentStatusException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.</p>"
"documentation":"<p>Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.</p>"
},
"ListGitHubAccountTokenNames":{
"name":"ListGitHubAccountTokenNames",
@ -657,7 +657,7 @@
{"shape":"InvalidTagFilterException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.</p>"
"documentation":"<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.</p>"
},
"PutLifecycleEventHookExecutionStatus":{
"name":"PutLifecycleEventHookExecutionStatus",
@ -749,7 +749,7 @@
{"shape":"DeploymentNotStartedException"},
{"shape":"UnsupportedActionForDeploymentTypeException"}
],
"documentation":"<p>In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.</p>",
"documentation":"<p>In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.</p>",
"deprecated":true,
"deprecatedMessage":"This operation is deprecated, use ContinueDeployment with DeploymentWaitType instead."
},
@ -871,7 +871,7 @@
},
"ignorePollAlarmFailure":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.</p> <ul> <li> <p>true: The deployment will proceed even if alarm status information can't be retrieved from Amazon CloudWatch.</p> </li> <li> <p>false: The deployment will stop if alarm status information can't be retrieved from Amazon CloudWatch.</p> </li> </ul>"
"documentation":"<p>Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.</p> <ul> <li> <p>true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.</p> </li> <li> <p>false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.</p> </li> </ul>"
},
"alarms":{
"shape":"AlarmList",
@ -897,7 +897,7 @@
"members":{
"content":{
"shape":"RawStringContent",
"documentation":"<p> The YAML-formatted or JSON-formatted revision string. </p> <p> For an AWS Lambda deployment the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. </p> <p> For an Amazon ECS deployment the content includes the task name, information about the load balancer that serves traffic to the container, and more. </p> <p> For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as <code>BeforeInstall</code>, during a deployment. </p>"
"documentation":"<p> The YAML-formatted or JSON-formatted revision string. </p> <p> For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version. </p> <p> For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more. </p> <p> For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as <code>BeforeInstall</code>, during a deployment. </p>"
},
"sha256":{
"shape":"RawStringSha256",
@ -910,14 +910,14 @@
"type":"structure",
"members":{
},
"documentation":"<p>An application with the specified name already exists with the applicable IAM user or AWS account.</p>",
"documentation":"<p>An application with the specified name with the IAM user or AWS account already exists.</p>",
"exception":true
},
"ApplicationDoesNotExistException":{
"type":"structure",
"members":{
},
"documentation":"<p>The application does not exist with the applicable IAM user or AWS account.</p>",
"documentation":"<p>The application does not exist with the IAM user or AWS account.</p>",
"exception":true
},
"ApplicationId":{"type":"string"},
@ -938,7 +938,7 @@
},
"linkedToGitHub":{
"shape":"Boolean",
"documentation":"<p>True if the user has authenticated with GitHub for the specified application; otherwise, false.</p>"
"documentation":"<p>True if the user has authenticated with GitHub for the specified application. Otherwise, false.</p>"
},
"gitHubAccountName":{
"shape":"GitHubAccountTokenName",
@ -998,7 +998,7 @@
"documentation":"<p>The event type or types that trigger a rollback.</p>"
}
},
"documentation":"<p>Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment doesn't complete successfully.</p>"
"documentation":"<p>Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.</p>"
},
"AutoRollbackEvent":{
"type":"string",
@ -1063,7 +1063,7 @@
},
"errorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>Information about errors that may have occurred during the API call.</p>"
"documentation":"<p>Information about errors that might have occurred during the API call.</p>"
},
"revisions":{
"shape":"RevisionInfoList",
@ -1106,7 +1106,7 @@
},
"deploymentGroupNames":{
"shape":"DeploymentGroupsList",
"documentation":"<p>The deployment groups' names.</p>"
"documentation":"<p>The names of the deployment groups.</p>"
}
},
"documentation":"<p>Represents the input of a BatchGetDeploymentGroups operation.</p>"
@ -1120,7 +1120,7 @@
},
"errorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>Information about errors that may have occurred during the API call.</p>"
"documentation":"<p>Information about errors that might have occurred during the API call.</p>"
}
},
"documentation":"<p>Represents the output of a BatchGetDeploymentGroups operation.</p>"
@ -1138,7 +1138,7 @@
},
"instanceIds":{
"shape":"InstancesList",
"documentation":"<p>The unique IDs of instances of the deployment.</p>"
"documentation":"<p>The unique IDs of instances used in the deployment.</p>"
}
},
"documentation":"<p> Represents the input of a BatchGetDeploymentInstances operation. </p>"
@ -1152,7 +1152,7 @@
},
"errorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>Information about errors that may have occurred during the API call.</p>"
"documentation":"<p>Information about errors that might have occurred during the API call.</p>"
}
},
"documentation":"<p>Represents the output of a BatchGetDeploymentInstances operation.</p>"
@ -1166,7 +1166,7 @@
},
"targetIds":{
"shape":"TargetIdList",
"documentation":"<p> The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. </p> <ul> <li> <p> For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs and their target type is <code>instanceTarget</code>. </p> </li> <li> <p> For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions and their target type is <code>instanceTarget</code>. </p> </li> <li> <p> For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. Their target type is <code>ecsTarget</code>. </p> </li> </ul>"
"documentation":"<p> The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. </p> <ul> <li> <p> For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is <code>instanceTarget</code>. </p> </li> <li> <p> For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is <code>instanceTarget</code>. </p> </li> <li> <p> For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. Their target type is <code>ecsTarget</code>. </p> </li> </ul>"
}
}
},
@ -1175,7 +1175,7 @@
"members":{
"deploymentTargets":{
"shape":"DeploymentTargetList",
"documentation":"<p> A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform. </p> <ul> <li> <p> <b>EC2/On-premises</b> - Each target object is an EC2 or on-premises instance. </p> </li> <li> <p> <b>AWS Lambda</b> - The target object is a specific version of an AWS Lambda function. </p> </li> <li> <p> <b>Amazon ECS</b> - The target object is an Amazon ECS service. </p> </li> </ul>"
"documentation":"<p> A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform. </p> <ul> <li> <p> <b>EC2/On-premises</b>: Each target object is an EC2 or on-premises instance. </p> </li> <li> <p> <b>AWS Lambda</b>: The target object is a specific version of an AWS Lambda function. </p> </li> <li> <p> <b>Amazon ECS</b>: The target object is an Amazon ECS service. </p> </li> </ul>"
}
}
},
@ -1339,7 +1339,7 @@
},
"trafficRoutingConfig":{
"shape":"TrafficRoutingConfig",
"documentation":"<p>The configuration that specifies how the deployment traffic will be routed.</p>"
"documentation":"<p>The configuration that specifies how the deployment traffic is routed.</p>"
},
"computePlatform":{
"shape":"ComputePlatform",
@ -1368,7 +1368,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"deploymentGroupName":{
"shape":"DeploymentGroupName",
@ -1376,19 +1376,19 @@
},
"deploymentConfigName":{
"shape":"DeploymentConfigName",
"documentation":"<p>If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.</p> <p>CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.</p> <p>For more information about the predefined deployment configurations in AWS CodeDeploy, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html\">Working with Deployment Groups in AWS CodeDeploy</a> in the AWS CodeDeploy User Guide.</p>"
"documentation":"<p>If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.</p> <p>CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.</p> <p>For more information about the predefined deployment configurations in AWS CodeDeploy, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html\">Working with Deployment Groups in AWS CodeDeploy</a> in the AWS CodeDeploy User Guide.</p>"
},
"ec2TagFilters":{
"shape":"EC2TagFilterList",
"documentation":"<p>The Amazon EC2 tags on which to filter. The deployment group will include EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.</p>"
"documentation":"<p>The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.</p>"
},
"onPremisesInstanceTagFilters":{
"shape":"TagFilterList",
"documentation":"<p>The on-premises instance tags on which to filter. The deployment group will include on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.</p>"
"documentation":"<p>The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.</p>"
},
"autoScalingGroups":{
"shape":"AutoScalingGroupNameList",
"documentation":"<p>A list of associated Auto Scaling groups.</p>"
"documentation":"<p>A list of associated Amazon EC2 Auto Scaling groups.</p>"
},
"serviceRoleArn":{
"shape":"Role",
@ -1420,15 +1420,15 @@
},
"ec2TagSet":{
"shape":"EC2TagSet",
"documentation":"<p>Information about groups of tags applied to EC2 instances. The deployment group will include only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.</p>"
"documentation":"<p>Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.</p>"
},
"ecsServices":{
"shape":"ECSServiceList",
"documentation":"<p> The target ECS services in the deployment group. This only applies to deployment groups that use the Amazon ECS compute platform. A target ECS service is specified as an Amazon ECS cluster and service name pair using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. </p>"
"documentation":"<p> The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. </p>"
},
"onPremisesTagSet":{
"shape":"OnPremisesTagSet",
"documentation":"<p>Information about groups of tags applied to on-premises instances. The deployment group will include only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.</p>"
"documentation":"<p>Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.</p>"
}
},
"documentation":"<p>Represents the input of a CreateDeploymentGroup operation.</p>"
@ -1449,7 +1449,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"deploymentGroupName":{
"shape":"DeploymentGroupName",
@ -1461,7 +1461,7 @@
},
"deploymentConfigName":{
"shape":"DeploymentConfigName",
"documentation":"<p>The name of a deployment configuration associated with the applicable IAM user or AWS account.</p> <p>If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.</p>"
"documentation":"<p>The name of a deployment configuration associated with the IAM user or AWS account.</p> <p>If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.</p>"
},
"description":{
"shape":"Description",
@ -1469,11 +1469,11 @@
},
"ignoreApplicationStopFailures":{
"shape":"Boolean",
"documentation":"<p> If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event. </p> <p> If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed. </p>"
"documentation":"<p> If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance is considered to have failed at that point and continues on to the BeforeInstall deployment lifecycle event. </p> <p> If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance stops, and the deployment to that instance is considered to have failed. </p>"
},
"targetInstances":{
"shape":"TargetInstances",
"documentation":"<p> Information about the instances that will belong to the replacement environment in a blue/green deployment. </p>"
"documentation":"<p> Information about the instances that belong to the replacement environment in a blue/green deployment. </p>"
},
"autoRollbackConfiguration":{
"shape":"AutoRollbackConfiguration",
@ -1506,7 +1506,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
}
},
"documentation":"<p>Represents the input of a DeleteApplication operation.</p>"
@ -1517,7 +1517,7 @@
"members":{
"deploymentConfigName":{
"shape":"DeploymentConfigName",
"documentation":"<p>The name of a deployment configuration associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of a deployment configuration associated with the IAM user or AWS account.</p>"
}
},
"documentation":"<p>Represents the input of a DeleteDeploymentConfig operation.</p>"
@ -1531,11 +1531,11 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"deploymentGroupName":{
"shape":"DeploymentGroupName",
"documentation":"<p>The name of an existing deployment group for the specified application.</p>"
"documentation":"<p>The name of a deployment group for the specified application.</p>"
}
},
"documentation":"<p>Represents the input of a DeleteDeploymentGroup operation.</p>"
@ -1581,21 +1581,21 @@
"type":"structure",
"members":{
},
"documentation":"<p> A deployment to a target was attempted while another deployment was in process. </p>",
"documentation":"<p> A deployment to a target was attempted while another deployment was in progress. </p>",
"exception":true
},
"DeploymentConfigAlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.</p>",
"documentation":"<p>A deployment configuration with the specified name with the IAM user or AWS account already exists .</p>",
"exception":true
},
"DeploymentConfigDoesNotExistException":{
"type":"structure",
"members":{
},
"documentation":"<p>The deployment configuration does not exist with the applicable IAM user or AWS account.</p>",
"documentation":"<p>The deployment configuration does not exist with the IAM user or AWS account.</p>",
"exception":true
},
"DeploymentConfigId":{"type":"string"},
@ -1631,7 +1631,7 @@
},
"trafficRoutingConfig":{
"shape":"TrafficRoutingConfig",
"documentation":"<p>The configuration specifying how the deployment traffic will be routed. Only deployments with a Lambda compute platform can specify this.</p>"
"documentation":"<p>The configuration that specifies how the deployment traffic is routed. Only deployments with a Lambda compute platform can specify this.</p>"
}
},
"documentation":"<p>Information about a deployment configuration.</p>"
@ -1671,21 +1671,21 @@
"type":"structure",
"members":{
},
"documentation":"<p>The deployment does not exist with the applicable IAM user or AWS account.</p>",
"documentation":"<p>The deployment with the IAM user or AWS account does not exist.</p>",
"exception":true
},
"DeploymentGroupAlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>A deployment group with the specified name already exists with the applicable IAM user or AWS account.</p>",
"documentation":"<p>A deployment group with the specified name with the IAM user or AWS account already exists.</p>",
"exception":true
},
"DeploymentGroupDoesNotExistException":{
"type":"structure",
"members":{
},
"documentation":"<p>The named deployment group does not exist with the applicable IAM user or AWS account.</p>",
"documentation":"<p>The named deployment group with the IAM user or AWS account does not exist.</p>",
"exception":true
},
"DeploymentGroupId":{"type":"string"},
@ -1762,7 +1762,7 @@
},
"ec2TagSet":{
"shape":"EC2TagSet",
"documentation":"<p>Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.</p>"
"documentation":"<p>Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.</p>"
},
"onPremisesTagSet":{
"shape":"OnPremisesTagSet",
@ -1774,7 +1774,7 @@
},
"ecsServices":{
"shape":"ECSServiceList",
"documentation":"<p> The target ECS services in the deployment group. This only applies to deployment groups that use the Amazon ECS compute platform. A target ECS service is specified as an Amazon ECS cluster and service name pair using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. </p>"
"documentation":"<p> The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. </p>"
}
},
"documentation":"<p>Information about a deployment group.</p>"
@ -1851,15 +1851,15 @@
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the deployment was created.</p>"
"documentation":"<p>A timestamp that indicates when the deployment was created.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the deployment was deployed to the deployment group.</p> <p>In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end servers that participate in the deployment process.</p>"
"documentation":"<p>A timestamp that indicates when the deployment was deployed to the deployment group.</p> <p>In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.</p>"
},
"completeTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the deployment was complete.</p>"
"documentation":"<p>A timestamp that indicates when the deployment was complete.</p>"
},
"deploymentOverview":{
"shape":"DeploymentOverview",
@ -1871,11 +1871,11 @@
},
"creator":{
"shape":"DeploymentCreator",
"documentation":"<p>The means by which the deployment was created:</p> <ul> <li> <p>user: A user created the deployment.</p> </li> <li> <p>autoscaling: Auto Scaling created the deployment.</p> </li> <li> <p>codeDeployRollback: A rollback process created the deployment.</p> </li> </ul>"
"documentation":"<p>The means by which the deployment was created:</p> <ul> <li> <p>user: A user created the deployment.</p> </li> <li> <p>autoscaling: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p>codeDeployRollback: A rollback process created the deployment.</p> </li> </ul>"
},
"ignoreApplicationStopFailures":{
"shape":"Boolean",
"documentation":"<p>If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.</p> <p>If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.</p>"
"documentation":"<p>If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance is not considered to have failed at that point and continues on to the BeforeInstall deployment lifecycle event.</p> <p>If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance stops, and the deployment to that instance is considered to have failed.</p>"
},
"autoRollbackConfiguration":{
"shape":"AutoRollbackConfiguration",
@ -1899,7 +1899,7 @@
},
"instanceTerminationWaitTimeStarted":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified; otherwise, 'true' as soon as the termination wait period starts.</p>"
"documentation":"<p>Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.</p>"
},
"blueGreenDeploymentConfiguration":{
"shape":"BlueGreenDeploymentConfiguration",
@ -2002,7 +2002,7 @@
},
"waitTimeInMinutes":{
"shape":"Duration",
"documentation":"<p>The number of minutes to wait before the status of a blue/green deployment changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout</p>"
"documentation":"<p>The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout</p>"
}
},
"documentation":"<p>Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.</p>"
@ -2046,7 +2046,7 @@
"members":{
"deploymentTargetType":{
"shape":"DeploymentTargetType",
"documentation":"<p> The deployment type which is specific to the deployment's compute platform. </p>"
"documentation":"<p> The deployment type that is specific to the deployment's compute platform. </p>"
},
"instanceTarget":{
"shape":"InstanceTarget",
@ -2195,7 +2195,7 @@
"members":{
"ec2TagSetList":{
"shape":"EC2TagSetList",
"documentation":"<p>A list containing other lists of EC2 instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.</p>"
"documentation":"<p>A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.</p>"
}
},
"documentation":"<p>Information about groups of EC2 instance tags.</p>"
@ -2210,11 +2210,11 @@
"members":{
"serviceName":{
"shape":"ECSServiceName",
"documentation":"<p> The name of the target ECS service. </p>"
"documentation":"<p> The name of the target Amazon ECS service. </p>"
},
"clusterName":{
"shape":"ECSClusterName",
"documentation":"<p> The name of the cluster that the ECS service is associated with. </p>"
"documentation":"<p> The name of the cluster that the Amazon ECS service is associated with. </p>"
}
},
"documentation":"<p> Contains the service and cluster names used to identify an Amazon ECS deployment's target. </p>"
@ -2227,7 +2227,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> The Amazon ECS service is associated with more than one deployment groups. An ECS service can only be associated with one deployment group. </p>",
"documentation":"<p> The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group. </p>",
"exception":true
},
"ECSServiceName":{"type":"string"},
@ -2274,7 +2274,7 @@
},
"desiredCount":{
"shape":"ECSTaskSetCount",
"documentation":"<p> The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy asks Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. </p>"
"documentation":"<p> The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set. </p>"
},
"pendingCount":{
"shape":"ECSTaskSetCount",
@ -2286,7 +2286,7 @@
},
"status":{
"shape":"ECSTaskSetStatus",
"documentation":"<p> The status of the task set. There are three valid task set statuses: </p> <ul> <li> <p> <code>PRIMARY</code> - indicates the task set is serving production traffic. </p> </li> <li> <p> <code>ACTIVE</code> - indicates the task set is not serving production traffic. </p> </li> <li> <p> <code>DRAINING</code> - indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. </p> </li> </ul>"
"documentation":"<p> The status of the task set. There are three valid task set statuses: </p> <ul> <li> <p> <code>PRIMARY</code>: Indicates the task set is serving production traffic. </p> </li> <li> <p> <code>ACTIVE</code>: Indicates the task set is not serving production traffic. </p> </li> <li> <p> <code>DRAINING</code>: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group. </p> </li> </ul>"
},
"trafficWeight":{
"shape":"TrafficWeight",
@ -2301,7 +2301,7 @@
"documentation":"<p> A label that identifies whether the ECS task set is an original target (<code>BLUE</code>) or a replacement target (<code>GREEN</code>). </p>"
}
},
"documentation":"<p> A set of Amazon ECS tasks. A task set runs a specified number of instances of a task definition simultaneously inside an Amazon ECS service. Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic or not. </p>"
"documentation":"<p> Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An AWS CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set. </p>"
},
"ECSTaskSetCount":{"type":"long"},
"ECSTaskSetIdentifier":{"type":"string"},
@ -2315,7 +2315,7 @@
"members":{
"name":{
"shape":"ELBName",
"documentation":"<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
"documentation":"<p>For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.</p>"
}
},
"documentation":"<p>Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.</p>"
@ -2366,7 +2366,7 @@
"members":{
"code":{
"shape":"ErrorCode",
"documentation":"<p>For information about additional error codes, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html\">Error Codes for AWS CodeDeploy</a> in the <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a>.</p> <p>The error code:</p> <ul> <li> <p>APPLICATION_MISSING: The application was missing. This error code will most likely be raised if the application is deleted after the deployment is created but before it is started.</p> </li> <li> <p>DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code will most likely be raised if the deployment group is deleted after the deployment is created but before it is started.</p> </li> <li> <p>HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>IAM_ROLE_MISSING: The service role cannot be accessed.</p> </li> <li> <p>IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.</p> </li> <li> <p>INTERNAL_ERROR: There was an internal error.</p> </li> <li> <p>NO_EC2_SUBSCRIPTION: The calling account is not subscribed to the Amazon EC2 service.</p> </li> <li> <p>NO_INSTANCES: No instance were specified, or no instance can be found.</p> </li> <li> <p>OVER_MAX_INSTANCES: The maximum number of instance was exceeded.</p> </li> <li> <p>THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.</p> </li> <li> <p>TIMEOUT: The deployment has timed out.</p> </li> <li> <p>REVISION_MISSING: The revision ID was missing. This error code will most likely be raised if the revision is deleted after the deployment is created but before it is started.</p> </li> </ul>"
"documentation":"<p>For more information, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html\">Error Codes for AWS CodeDeploy</a> in the <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a>.</p> <p>The error code:</p> <ul> <li> <p>APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.</p> </li> <li> <p>HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.</p> </li> <li> <p>IAM_ROLE_MISSING: The service role cannot be accessed.</p> </li> <li> <p>IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.</p> </li> <li> <p>INTERNAL_ERROR: There was an internal error.</p> </li> <li> <p>NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.</p> </li> <li> <p>NO_INSTANCES: No instances were specified, or no instances can be found.</p> </li> <li> <p>OVER_MAX_INSTANCES: The maximum number of instances was exceeded.</p> </li> <li> <p>THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.</p> </li> <li> <p>TIMEOUT: The deployment has timed out.</p> </li> <li> <p>REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.</p> </li> </ul>"
},
"message":{
"shape":"ErrorMessage",
@ -2421,7 +2421,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
}
},
"documentation":"<p>Represents the input of a GetApplication operation.</p>"
@ -2478,7 +2478,7 @@
"members":{
"deploymentConfigName":{
"shape":"DeploymentConfigName",
"documentation":"<p>The name of a deployment configuration associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of a deployment configuration associated with the IAM user or AWS account.</p>"
}
},
"documentation":"<p>Represents the input of a GetDeploymentConfig operation.</p>"
@ -2502,11 +2502,11 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"deploymentGroupName":{
"shape":"DeploymentGroupName",
"documentation":"<p>The name of an existing deployment group for the specified application.</p>"
"documentation":"<p>The name of a deployment group for the specified application.</p>"
}
},
"documentation":"<p>Represents the input of a GetDeploymentGroup operation.</p>"
@ -2527,7 +2527,7 @@
"members":{
"deploymentId":{
"shape":"DeploymentId",
"documentation":"<p> The unique ID of a deployment associated with the applicable IAM user or AWS account. </p>"
"documentation":"<p> The unique ID of a deployment associated with the IAM user or AWS account. </p>"
}
},
"documentation":"<p>Represents the input of a GetDeployment operation.</p>"
@ -2588,7 +2588,7 @@
"members":{
"deploymentTarget":{
"shape":"DeploymentTarget",
"documentation":"<p> A deployment target that contains information about a deployment such as its status, lifecyle events, and when it was updated last. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (<code>instanceTarget</code>, <code>lambdaTarget</code>, or <code>ecsTarget</code>). </p>"
"documentation":"<p> A deployment target that contains information about a deployment such as its status, lifecyle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (<code>instanceTarget</code>, <code>lambdaTarget</code>, or <code>ecsTarget</code>). </p>"
}
}
},
@ -2827,7 +2827,7 @@
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the instance information was last updated.</p>"
"documentation":"<p>A timestamp that indicaties when the instance information was last updated.</p>"
},
"lifecycleEvents":{
"shape":"LifecycleEventList",
@ -2899,7 +2899,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The format of the alarm configuration is invalid. Possible causes include:</p> <ul> <li> <p>The alarm list is null.</p> </li> <li> <p>The alarm object is null.</p> </li> <li> <p>The alarm name is empty or null or exceeds the 255 character limit.</p> </li> <li> <p>Two alarms with the same name have been specified.</p> </li> <li> <p>The alarm configuration is enabled but the alarm list is empty.</p> </li> </ul>",
"documentation":"<p>The format of the alarm configuration is invalid. Possible causes include:</p> <ul> <li> <p>The alarm list is null.</p> </li> <li> <p>The alarm object is null.</p> </li> <li> <p>The alarm name is empty or null or exceeds the limit of 255 characters.</p> </li> <li> <p>Two alarms with the same name have been specified.</p> </li> <li> <p>The alarm configuration is enabled, but the alarm list is empty.</p> </li> </ul>",
"exception":true
},
"InvalidApplicationNameException":{
@ -2913,7 +2913,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled but an invalid triggering event type or no event types were listed.</p>",
"documentation":"<p>The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.</p>",
"exception":true
},
"InvalidAutoScalingGroupException":{
@ -2990,14 +2990,14 @@
"type":"structure",
"members":{
},
"documentation":"<p>An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\" and \"BLUE_GREEN\". Valid deployment options include \"WITH_TRAFFIC_CONTROL\" and \"WITHOUT_TRAFFIC_CONTROL\".</p>",
"documentation":"<p>An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\" and \"BLUE_GREEN.\" Valid deployment options include \"WITH_TRAFFIC_CONTROL\" and \"WITHOUT_TRAFFIC_CONTROL.\"</p>",
"exception":true
},
"InvalidDeploymentTargetIdException":{
"type":"structure",
"members":{
},
"documentation":"<p> The target ID provide was not valid. </p>",
"documentation":"<p> The target ID provided was not valid. </p>",
"exception":true
},
"InvalidDeploymentWaitTypeException":{
@ -3032,7 +3032,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location but weren't part of the previous successful deployment. Valid values include \"DISALLOW\", \"OVERWRITE\", and \"RETAIN\".</p>",
"documentation":"<p>An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include \"DISALLOW,\" \"OVERWRITE,\" and \"RETAIN.\"</p>",
"exception":true
},
"InvalidGitHubAccountTokenException":{
@ -3074,7 +3074,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified input was specified in an invalid format.</p>",
"documentation":"<p>The input was specified in an invalid format.</p>",
"exception":true
},
"InvalidInstanceIdException":{
@ -3088,7 +3088,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified on-premises instance name was specified in an invalid format.</p>",
"documentation":"<p>The on-premises instance name was specified in an invalid format.</p>",
"exception":true
},
"InvalidInstanceStatusException":{
@ -3179,7 +3179,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.</p>",
"documentation":"<p>The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.</p>",
"exception":true
},
"InvalidSortByException":{
@ -3200,14 +3200,14 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified tag was specified in an invalid format.</p>",
"documentation":"<p>The tag was specified in an invalid format.</p>",
"exception":true
},
"InvalidTagFilterException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified tag filter was specified in an invalid format.</p>",
"documentation":"<p>The tag filter was specified in an invalid format.</p>",
"exception":true
},
"InvalidTargetException":{
@ -3310,11 +3310,11 @@
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the most recent deployment to the deployment group completed.</p>"
"documentation":"<p>A timestamp that indicates when the most recent deployment to the deployment group was complete.</p>"
},
"createTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the most recent deployment to the deployment group started.</p>"
"documentation":"<p>A timestamp that indicates when the most recent deployment to the deployment group started.</p>"
}
},
"documentation":"<p>Information about the most recent attempted or successful deployment to a deployment group.</p>"
@ -3343,11 +3343,11 @@
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the deployment lifecycle event started.</p>"
"documentation":"<p>A timestamp that indicates when the deployment lifecycle event started.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp indicating when the deployment lifecycle event ended.</p>"
"documentation":"<p>A timestamp that indicates when the deployment lifecycle event ended.</p>"
},
"status":{
"shape":"LifecycleEventStatus",
@ -3394,15 +3394,15 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p> The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account. </p>"
"documentation":"<p> The name of an AWS CodeDeploy application associated with the IAM user or AWS account. </p>"
},
"sortBy":{
"shape":"ApplicationRevisionSortBy",
"documentation":"<p>The column name to use to sort the list results:</p> <ul> <li> <p>registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.</p> </li> <li> <p>firstUsedTime: Sort by the time the revisions were first used in a deployment.</p> </li> <li> <p>lastUsedTime: Sort by the time the revisions were last used in a deployment.</p> </li> </ul> <p> If not specified or set to null, the results will be returned in an arbitrary order. </p>"
"documentation":"<p>The column name to use to sort the list results:</p> <ul> <li> <p>registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.</p> </li> <li> <p>firstUsedTime: Sort by the time the revisions were first used in a deployment.</p> </li> <li> <p>lastUsedTime: Sort by the time the revisions were last used in a deployment.</p> </li> </ul> <p> If not specified or set to null, the results are returned in an arbitrary order. </p>"
},
"sortOrder":{
"shape":"SortOrder",
"documentation":"<p> The order in which to sort the list results: </p> <ul> <li> <p>ascending: ascending order.</p> </li> <li> <p>descending: descending order.</p> </li> </ul> <p>If not specified, the results will be sorted in ascending order.</p> <p>If set to null, the results will be sorted in an arbitrary order.</p>"
"documentation":"<p> The order in which to sort the list results: </p> <ul> <li> <p>ascending: ascending order.</p> </li> <li> <p>descending: descending order.</p> </li> </ul> <p>If not specified, the results are sorted in ascending order.</p> <p>If set to null, the results are sorted in an arbitrary order.</p>"
},
"s3Bucket":{
"shape":"S3Bucket",
@ -3432,7 +3432,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>If a large amount of information is returned, an identifier will also be returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.</p>"
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.</p>"
}
},
"documentation":"<p>Represents the output of a ListApplicationRevisions operation.</p>"
@ -3456,7 +3456,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications, will also be returned. in the list.</p>"
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.</p>"
}
},
"documentation":"<p>Represents the output of a ListApplications operation.</p>"
@ -3491,7 +3491,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"nextToken":{
"shape":"NextToken",
@ -3509,7 +3509,7 @@
},
"deploymentGroups":{
"shape":"DeploymentGroupsList",
"documentation":"<p>A list of corresponding deployment group names.</p>"
"documentation":"<p>A list of deployment group names.</p>"
},
"nextToken":{
"shape":"NextToken",
@ -3532,7 +3532,7 @@
},
"instanceStatusFilter":{
"shape":"InstanceStatusList",
"documentation":"<p>A subset of instances to list by status:</p> <ul> <li> <p>Pending: Include those instance with pending deployments.</p> </li> <li> <p>InProgress: Include those instance where deployments are still in progress.</p> </li> <li> <p>Succeeded: Include those instances with successful deployments.</p> </li> <li> <p>Failed: Include those instance with failed deployments.</p> </li> <li> <p>Skipped: Include those instance with skipped deployments.</p> </li> <li> <p>Unknown: Include those instance with deployments in an unknown state.</p> </li> </ul>"
"documentation":"<p>A subset of instances to list by status:</p> <ul> <li> <p>Pending: Include those instances with pending deployments.</p> </li> <li> <p>InProgress: Include those instances where deployments are still in progress.</p> </li> <li> <p>Succeeded: Include those instances with successful deployments.</p> </li> <li> <p>Failed: Include those instances with failed deployments.</p> </li> <li> <p>Skipped: Include those instances with skipped deployments.</p> </li> <li> <p>Unknown: Include those instances with deployments in an unknown state.</p> </li> </ul>"
},
"instanceTypeFilter":{
"shape":"InstanceTypeList",
@ -3581,7 +3581,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p> If a large amount of information is returned, a token identifier will also be returned. It can be used in a subsequent <code>ListDeploymentTargets</code> call to return the next set of deployment targets in the list. </p>"
"documentation":"<p> If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent <code>ListDeploymentTargets</code> call to return the next set of deployment targets in the list. </p>"
}
}
},
@ -3590,11 +3590,11 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"deploymentGroupName":{
"shape":"DeploymentGroupName",
"documentation":"<p>The name of an existing deployment group for the specified application.</p>"
"documentation":"<p>The name of a deployment group for the specified application.</p>"
},
"includeOnlyStatuses":{
"shape":"DeploymentStatusList",
@ -3658,7 +3658,7 @@
},
"tagFilters":{
"shape":"TagFilterList",
"documentation":"<p>The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.</p>"
"documentation":"<p>The on-premises instance tags that are used to restrict the on-premises instance names returned.</p>"
},
"nextToken":{
"shape":"NextToken",
@ -3679,7 +3679,7 @@
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.</p>"
}
},
"documentation":"<p>Represents the output of list on-premises instances operation.</p>"
"documentation":"<p>Represents the output of the list on-premises instances operation.</p>"
},
"ListStateFilterAction":{
"type":"string",
@ -3699,11 +3699,11 @@
"members":{
"elbInfoList":{
"shape":"ELBInfoList",
"documentation":"<p>An array containing information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p> <note> <p> Adding more than one load balancer to the array is not supported. </p> </note>"
"documentation":"<p>An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p> <note> <p> Adding more than one load balancer to the array is not supported. </p> </note>"
},
"targetGroupInfoList":{
"shape":"TargetGroupInfoList",
"documentation":"<p>An array containing information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.</p> <note> <p> Adding more than one target group to the array is not supported. </p> </note>"
"documentation":"<p>An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.</p> <note> <p> Adding more than one target group to the array is not supported. </p> </note>"
},
"targetGroupPairInfoList":{
"shape":"TargetGroupPairInfoList",
@ -3723,7 +3723,7 @@
},
"type":{
"shape":"MinimumHealthyHostsType",
"documentation":"<p>The minimum healthy instance type:</p> <ul> <li> <p>HOST_COUNT: The minimum number of healthy instance as an absolute value.</p> </li> <li> <p>FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.</p> </li> </ul> <p>In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.</p> <note> <p>In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.</p> </note> <p>For more information, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html\">AWS CodeDeploy Instance Health</a> in the <i>AWS CodeDeploy User Guide</i>.</p>"
"documentation":"<p>The minimum healthy instance type:</p> <ul> <li> <p>HOST_COUNT: The minimum number of healthy instance as an absolute value.</p> </li> <li> <p>FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.</p> </li> </ul> <p>In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails.</p> <note> <p>In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.</p> </note> <p>For more information, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html\">AWS CodeDeploy Instance Health</a> in the <i>AWS CodeDeploy User Guide</i>.</p>"
}
},
"documentation":"<p>Information about minimum healthy instance.</p>"
@ -3750,7 +3750,7 @@
"members":{
"onPremisesTagSetList":{
"shape":"OnPremisesTagSetList",
"documentation":"<p>A list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.</p>"
"documentation":"<p>A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.</p>"
}
},
"documentation":"<p>Information about groups of on-premises instance tags.</p>"
@ -3820,7 +3820,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
"documentation":"<p>The name of an AWS CodeDeploy application associated with the IAM user or AWS account.</p>"
},
"description":{
"shape":"Description",
@ -3889,7 +3889,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The named revision does not exist with the applicable IAM user or AWS account.</p>",
"documentation":"<p>The named revision does not exist with the IAM user or AWS account.</p>",
"exception":true
},
"RevisionInfo":{
@ -3915,7 +3915,7 @@
"members":{
"revisionType":{
"shape":"RevisionLocationType",
"documentation":"<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only)</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only)</p> </li> </ul>"
"documentation":"<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).</p> </li> </ul>"
},
"s3Location":{
"shape":"S3Location",
@ -3977,7 +3977,7 @@
},
"rollbackMessage":{
"shape":"Description",
"documentation":"<p>Information describing the status of a deployment rollback; for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded. </p>"
"documentation":"<p>Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded). </p>"
}
},
"documentation":"<p>Information about a deployment rollback.</p>"
@ -4001,11 +4001,11 @@
},
"version":{
"shape":"VersionId",
"documentation":"<p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system will use the most recent version by default.</p>"
"documentation":"<p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system uses the most recent version by default.</p>"
},
"eTag":{
"shape":"ETag",
"documentation":"<p>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.</p>"
"documentation":"<p>The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the ETag is not specified as an input parameter, ETag validation of the object is skipped.</p>"
}
},
"documentation":"<p>Information about the location of application artifacts stored in Amazon S3.</p>"
@ -4150,7 +4150,7 @@
"members":{
"name":{
"shape":"TargetGroupName",
"documentation":"<p>For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. </p>"
"documentation":"<p>For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete. </p>"
}
},
"documentation":"<p>Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.</p>"
@ -4165,7 +4165,7 @@
"members":{
"targetGroups":{
"shape":"TargetGroupInfoList",
"documentation":"<p> One pair of target groups. One is associated with the original task set. The second target is associated with the task set that serves traffic after the deployment completes. </p>"
"documentation":"<p> One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete. </p>"
},
"prodTrafficRoute":{
"shape":"TrafficRoute",
@ -4173,10 +4173,10 @@
},
"testTrafficRoute":{
"shape":"TrafficRoute",
"documentation":"<p> An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can happen while test traffic is served during a deployment. </p>"
"documentation":"<p> An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment. </p>"
}
},
"documentation":"<p> Information about two target groups and how traffic routes during an Amazon ECS deployment. An optional test traffic route can be specified. </p>"
"documentation":"<p> Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified. </p>"
},
"TargetGroupPairInfoList":{
"type":"list",
@ -4392,7 +4392,7 @@
"members":{
"applicationName":{
"shape":"ApplicationName",
"documentation":"<p>The application name corresponding to the deployment group to update.</p>"
"documentation":"<p>The application name that corresponds to the deployment group to update.</p>"
},
"currentDeploymentGroupName":{
"shape":"DeploymentGroupName",
@ -4448,15 +4448,15 @@
},
"ec2TagSet":{
"shape":"EC2TagSet",
"documentation":"<p>Information about groups of tags applied to on-premises instances. The deployment group will include only EC2 instances identified by all the tag groups.</p>"
"documentation":"<p>Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.</p>"
},
"ecsServices":{
"shape":"ECSServiceList",
"documentation":"<p> The target ECS services in the deployment group. This only applies to deployment groups that use the Amazon ECS compute platform. A target ECS service is specified as an Amazon ECS cluster and service name pair using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. </p>"
"documentation":"<p> The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <code>&lt;clustername&gt;:&lt;servicename&gt;</code>. </p>"
},
"onPremisesTagSet":{
"shape":"OnPremisesTagSet",
"documentation":"<p>Information about an on-premises instance tag set. The deployment group will include only on-premises instances identified by all the tag groups.</p>"
"documentation":"<p>Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.</p>"
}
},
"documentation":"<p>Represents the input of an UpdateDeploymentGroup operation.</p>"
@ -4475,5 +4475,5 @@
"VersionId":{"type":"string"},
"WaitTimeInMins":{"type":"integer"}
},
"documentation":"<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both. </p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>"
"documentation":"<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless AWS Lambda functions, or applications in an Amazon ECS service.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.</p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>"
}

25
botocore/data/codepipeline/2015-07-09/paginators-1.json
View file

@ -1,3 +1,26 @@
{
"pagination": {}
"pagination": {
"ListActionTypes": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "actionTypes"
},
"ListPipelineExecutions": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "pipelineExecutionSummaries"
},
"ListPipelines": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "pipelines"
},
"ListWebhooks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "webhooks"
}
}
}

27
botocore/data/codestar/2017-04-19/paginators-1.json
View file

@ -1,3 +1,28 @@
{
"pagination": {}
"pagination": {
"ListProjects": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "projects"
},
"ListResources": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "resources"
},
"ListTeamMembers": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "teamMembers"
},
"ListUserProfiles": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "userProfiles"
}
}
}

9
botocore/data/cognito-identity/2014-06-30/paginators-1.json
View file

@ -1,3 +1,10 @@
{
"pagination": {}
"pagination": {
"ListIdentityPools": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "IdentityPools"
}
}
}

51
botocore/data/cognito-idp/2016-04-18/paginators-1.json
View file

@ -1,3 +1,52 @@
{
"pagination": {}
"pagination": {
"AdminListGroupsForUser": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Groups"
},
"AdminListUserAuthEvents": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "AuthEvents"
},
"ListGroups": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Groups"
},
"ListIdentityProviders": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Providers"
},
"ListResourceServers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ResourceServers"
},
"ListUserPoolClients": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "UserPoolClients"
},
"ListUserPools": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "UserPools"
},
"ListUsersInGroup": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Users"
}
}
}

42
botocore/data/comprehend/2017-11-27/paginators-1.json
View file

@ -5,6 +5,48 @@
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListDocumentClassificationJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DocumentClassificationJobPropertiesList"
},
"ListDocumentClassifiers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DocumentClassifierPropertiesList"
},
"ListDominantLanguageDetectionJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DominantLanguageDetectionJobPropertiesList"
},
"ListEntitiesDetectionJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "EntitiesDetectionJobPropertiesList"
},
"ListEntityRecognizers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "EntityRecognizerPropertiesList"
},
"ListKeyPhrasesDetectionJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "KeyPhrasesDetectionJobPropertiesList"
},
"ListSentimentDetectionJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SentimentDetectionJobPropertiesList"
}
}
}

53
botocore/data/config/2014-11-12/paginators-1.json
View file

@ -35,6 +35,59 @@
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "resourceIdentifiers"
},
"DescribeAggregateComplianceByConfigRules": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "AggregateComplianceByConfigRules"
},
"DescribeAggregationAuthorizations": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "AggregationAuthorizations"
},
"DescribeConfigRuleEvaluationStatus": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "ConfigRulesEvaluationStatus"
},
"DescribeConfigurationAggregatorSourcesStatus": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "AggregatedSourceStatusList"
},
"DescribeConfigurationAggregators": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "ConfigurationAggregators"
},
"DescribePendingAggregationRequests": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "PendingAggregationRequests"
},
"DescribeRetentionConfigurations": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "RetentionConfigurations"
},
"GetAggregateComplianceDetailsByConfigRule": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "AggregateEvaluationResults"
},
"ListAggregateDiscoveredResources": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "ResourceIdentifiers"
}
}
}

33
botocore/data/connect/2017-08-08/paginators-1.json
View file

@ -1,3 +1,34 @@
{
"pagination": {}
"pagination": {
"GetMetricData": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "MetricResults"
},
"ListRoutingProfiles": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "RoutingProfileSummaryList"
},
"ListSecurityProfiles": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SecurityProfileSummaryList"
},
"ListUserHierarchyGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "UserHierarchyGroupSummaryList"
},
"ListUsers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "UserSummaryList"
}
}
}

116
botocore/data/cur/2017-01-06/service-2.json
View file

@ -25,7 +25,7 @@
{"shape":"InternalErrorException"},
{"shape":"ValidationException"}
],
"documentation":"Delete a specified report definition"
"documentation":"<p>Deletes the specified report.</p>"
},
"DescribeReportDefinitions":{
"name":"DescribeReportDefinitions",
@ -38,7 +38,7 @@
"errors":[
{"shape":"InternalErrorException"}
],
"documentation":"Describe a list of report definitions owned by the account"
"documentation":"<p>Lists the AWS Cost and Usage reports available to this account.</p>"
},
"PutReportDefinition":{
"name":"PutReportDefinition",
@ -54,13 +54,13 @@
{"shape":"InternalErrorException"},
{"shape":"ValidationException"}
],
"documentation":"Create a new report definition"
"documentation":"<p>Creates a new report using the description that you provide.</p>"
}
},
"shapes":{
"AWSRegion":{
"type":"string",
"documentation":"Region of customer S3 bucket.",
"documentation":"<p>The region of the S3 bucket that AWS delivers the report into.</p>",
"enum":[
"us-east-1",
"us-west-1",
@ -69,28 +69,32 @@
"eu-west-1",
"ap-southeast-1",
"ap-southeast-2",
"ap-northeast-1"
"ap-northeast-1",
"eu-north-1",
"ap-northeast-3"
]
},
"AdditionalArtifact":{
"type":"string",
"documentation":"Enable support for Redshift and/or QuickSight.",
"documentation":"<p>The types of manifest that you want AWS to create for this report.</p>",
"enum":[
"REDSHIFT",
"QUICKSIGHT"
"QUICKSIGHT",
"ATHENA"
]
},
"AdditionalArtifactList":{
"type":"list",
"member":{"shape":"AdditionalArtifact"},
"documentation":"A list of additional artifacts."
"documentation":"<p>A list of additional artifacts.</p>"
},
"CompressionFormat":{
"type":"string",
"documentation":"Preferred compression format for report.",
"documentation":"<p>The compression format that AWS uses for the report.</p>",
"enum":[
"ZIP",
"GZIP"
"GZIP",
"Parquet"
]
},
"DeleteReportDefinitionRequest":{
@ -98,18 +102,18 @@
"members":{
"ReportName":{"shape":"ReportName"}
},
"documentation":"Request of DeleteReportDefinition"
"documentation":"<p>Deletes the specified report.</p>"
},
"DeleteReportDefinitionResponse":{
"type":"structure",
"members":{
"ResponseMessage":{"shape":"DeleteResponseMessage"}
},
"documentation":"Response of DeleteReportDefinition"
"documentation":"<p>If the action is successful, the service sends back an HTTP 200 response.</p>"
},
"DeleteResponseMessage":{
"type":"string",
"documentation":"A message indicates if the deletion is successful."
"documentation":"<p>Whether the deletion was successful or not.</p>"
},
"DescribeReportDefinitionsRequest":{
"type":"structure",
@ -117,44 +121,47 @@
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Request of DescribeReportDefinitions"
"documentation":"<p>Requests a list of AWS Cost and Usage reports owned by the account.</p>"
},
"DescribeReportDefinitionsResponse":{
"type":"structure",
"members":{
"ReportDefinitions":{"shape":"ReportDefinitionList"},
"ReportDefinitions":{
"shape":"ReportDefinitionList",
"documentation":"<p>A list of AWS Cost and Usage reports owned by the account.</p>"
},
"NextToken":{"shape":"GenericString"}
},
"documentation":"Response of DescribeReportDefinitions"
"documentation":"<p>If the action is successful, the service sends back an HTTP 200 response.</p>"
},
"DuplicateReportNameException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"This exception is thrown when putting a report preference with a name that already exists.",
"documentation":"<p>A report with the specified name already exists in the account. Specify a different report name.</p>",
"exception":true
},
"ErrorMessage":{
"type":"string",
"documentation":"A message to show the detail of the exception."
"documentation":"<p>A message to show the detail of the exception.</p>"
},
"GenericString":{
"type":"string",
"documentation":"A generic string."
"documentation":"<p>A generic string.</p>"
},
"InternalErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"This exception is thrown on a known dependency failure.",
"documentation":"<p>An error on the server occurred during the processing of your request. Try again later.</p>",
"exception":true,
"fault":true
},
"MaxResults":{
"type":"integer",
"documentation":"The max number of results returned by the operation.",
"documentation":"<p>The maximum number of results that AWS returns for the operation.</p>",
"box":true,
"max":5,
"min":5
@ -163,15 +170,22 @@
"type":"structure",
"required":["ReportDefinition"],
"members":{
"ReportDefinition":{"shape":"ReportDefinition"}
"ReportDefinition":{
"shape":"ReportDefinition",
"documentation":"<p>Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information. </p>"
}
},
"documentation":"Request of PutReportDefinition"
"documentation":"<p>Creates a Cost and Usage Report.</p>"
},
"PutReportDefinitionResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of PutReportDefinition"
"documentation":"<p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>"
},
"RefreshClosedReports":{
"type":"boolean",
"box":true
},
"ReportDefinition":{
"type":"structure",
@ -190,62 +204,86 @@
"TimeUnit":{"shape":"TimeUnit"},
"Format":{"shape":"ReportFormat"},
"Compression":{"shape":"CompressionFormat"},
"AdditionalSchemaElements":{"shape":"SchemaElementList"},
"AdditionalSchemaElements":{
"shape":"SchemaElementList",
"documentation":"<p>A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs. </p>"
},
"S3Bucket":{"shape":"S3Bucket"},
"S3Prefix":{"shape":"S3Prefix"},
"S3Region":{"shape":"AWSRegion"},
"AdditionalArtifacts":{"shape":"AdditionalArtifactList"}
"AdditionalArtifacts":{
"shape":"AdditionalArtifactList",
"documentation":"<p>A list of manifests that you want Amazon Web Services to create for this report.</p>"
},
"RefreshClosedReports":{
"shape":"RefreshClosedReports",
"documentation":"<p>Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.</p>"
},
"ReportVersioning":{
"shape":"ReportVersioning",
"documentation":"<p>Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.</p>"
}
},
"documentation":"The definition of AWS Cost and Usage Report. Customer can specify the report name, time unit, report format, compression format, S3 bucket and additional artifacts and schema elements in the definition."
"documentation":"<p>The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition. </p>"
},
"ReportDefinitionList":{
"type":"list",
"member":{"shape":"ReportDefinition"},
"documentation":"A list of report definitions."
"documentation":"<p>A list of report definitions.</p>"
},
"ReportFormat":{
"type":"string",
"documentation":"Preferred format for report.",
"enum":["textORcsv"]
"documentation":"<p>The format that AWS saves the report in.</p>",
"enum":[
"textORcsv",
"Parquet"
]
},
"ReportLimitReachedException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"This exception is thrown when the number of report preference reaches max limit. The max number is 5.",
"documentation":"<p>This account already has five reports defined. To define a new report, you must delete an existing report.</p>",
"exception":true
},
"ReportName":{
"type":"string",
"documentation":"Preferred name for a report, it has to be unique. Must starts with a number/letter, case sensitive. Limited to 256 characters.",
"documentation":"<p>The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces. </p>",
"max":256,
"pattern":"[0-9A-Za-z!\\-_.*\\'()]+"
},
"ReportVersioning":{
"type":"string",
"enum":[
"CREATE_NEW_REPORT",
"OVERWRITE_REPORT"
]
},
"S3Bucket":{
"type":"string",
"documentation":"Name of customer S3 bucket.",
"documentation":"<p>The S3 bucket where AWS delivers the report.</p>",
"max":256
},
"S3Prefix":{
"type":"string",
"documentation":"Preferred report path prefix. Limited to 256 characters.",
"documentation":"<p>The prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.</p>",
"max":256,
"pattern":"[0-9A-Za-z!\\-_.*\\'()/]*"
},
"SchemaElement":{
"type":"string",
"documentation":"Preference of including Resource IDs. You can include additional details about individual resource IDs in your report.",
"documentation":"<p>Whether or not AWS includes resource IDs in the report. </p>",
"enum":["RESOURCES"]
},
"SchemaElementList":{
"type":"list",
"member":{"shape":"SchemaElement"},
"documentation":"A list of schema elements."
"documentation":"<p>A list of strings that indicate the content that is included in the report, such as service or usage type.</p>"
},
"TimeUnit":{
"type":"string",
"documentation":"The frequency on which report data are measured and displayed.",
"documentation":"<p>The length of time covered by the report. </p>",
"enum":[
"HOURLY",
"DAILY"
@ -256,9 +294,9 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.",
"documentation":"<p>The input fails to satisfy the constraints specified by an AWS service.</p>",
"exception":true
}
},
"documentation":"All public APIs for AWS Cost and Usage Report service"
"documentation":"<p>The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions.</p> <p>AWS Cost and Usage reports track the monthly AWS costs and usage associated with your AWS account. The report contains line items for each unique combination of AWS product, usage type, and operation that your AWS account uses. You can configure the AWS Cost and Usage report to show only the data that you want, using the AWS Cost and Usage API.</p> <p>Service Endpoint</p> <p>The AWS Cost and Usage Report API provides the following endpoint:</p> <ul> <li> <p>cur.us-east-1.amazonaws.com</p> </li> </ul>"
}

33
botocore/data/datasync/2018-11-09/paginators-1.json
View file

@ -1,3 +1,34 @@
{
"pagination": {}
"pagination": {
"ListAgents": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Agents"
},
"ListLocations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Locations"
},
"ListTagsForResource": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Tags"
},
"ListTaskExecutions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TaskExecutions"
},
"ListTasks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Tasks"
}
}
}

44
botocore/data/dax/2017-04-19/paginators-1.json
View file

@ -1,3 +1,45 @@
{
"pagination": {}
"pagination": {
"DescribeClusters": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Clusters"
},
"DescribeDefaultParameters": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Parameters"
},
"DescribeEvents": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Events"
},
"DescribeParameterGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ParameterGroups"
},
"DescribeParameters": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Parameters"
},
"DescribeSubnetGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SubnetGroups"
},
"ListTags": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Tags"
}
}
}

33
botocore/data/devicefarm/2015-06-23/paginators-1.json
View file

@ -72,6 +72,39 @@
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "offerings"
},
"ListDeviceInstances": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "deviceInstances"
},
"ListInstanceProfiles": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "instanceProfiles"
},
"ListNetworkProfiles": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "networkProfiles"
},
"ListOfferingPromotions": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "offeringPromotions"
},
"ListRemoteAccessSessions": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "remoteAccessSessions"
},
"ListVPCEConfigurations": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "vpceConfigurations"
}
}
}

102
botocore/data/devicefarm/2015-06-23/service-2.json
View file

@ -1122,7 +1122,7 @@
},
"type":{
"shape":"ArtifactType",
"documentation":"<p>The artifact's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>UNKNOWN: An unknown type.</p> </li> <li> <p>SCREENSHOT: The screenshot type.</p> </li> <li> <p>DEVICE_LOG: The device log type.</p> </li> <li> <p>MESSAGE_LOG: The message log type.</p> </li> <li> <p>RESULT_LOG: The result log type.</p> </li> <li> <p>SERVICE_LOG: The service log type.</p> </li> <li> <p>WEBKIT_LOG: The web kit log type.</p> </li> <li> <p>INSTRUMENTATION_OUTPUT: The instrumentation type.</p> </li> <li> <p>EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.</p> </li> <li> <p>CALABASH_JSON_OUTPUT: The Calabash JSON output type.</p> </li> <li> <p>CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.</p> </li> <li> <p>CALABASH_STANDARD_OUTPUT: The Calabash standard output type.</p> </li> <li> <p>CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.</p> </li> <li> <p>AUTOMATION_OUTPUT: The automation output type.</p> </li> <li> <p>APPIUM_SERVER_OUTPUT: The Appium server output type.</p> </li> <li> <p>APPIUM_JAVA_OUTPUT: The Appium Java output type.</p> </li> <li> <p>APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.</p> </li> <li> <p>APPIUM_PYTHON_OUTPUT: The Appium Python output type.</p> </li> <li> <p>APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.</p> </li> <li> <p>EXPLORER_EVENT_LOG: The Explorer event log output type.</p> </li> <li> <p>EXPLORER_SUMMARY_LOG: The Explorer summary log output type.</p> </li> <li> <p>APPLICATION_CRASH_REPORT: The application crash report output type.</p> </li> <li> <p>XCTEST_LOG: The XCode test output type.</p> </li> </ul>"
"documentation":"<p>The artifact's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>UNKNOWN: An unknown type.</p> </li> <li> <p>SCREENSHOT: The screenshot type.</p> </li> <li> <p>DEVICE_LOG: The device log type.</p> </li> <li> <p>MESSAGE_LOG: The message log type.</p> </li> <li> <p>VIDEO_LOG: The video log type.</p> </li> <li> <p>RESULT_LOG: The result log type.</p> </li> <li> <p>SERVICE_LOG: The service log type.</p> </li> <li> <p>WEBKIT_LOG: The web kit log type.</p> </li> <li> <p>INSTRUMENTATION_OUTPUT: The instrumentation type.</p> </li> <li> <p>EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.</p> </li> <li> <p>CALABASH_JSON_OUTPUT: The Calabash JSON output type.</p> </li> <li> <p>CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.</p> </li> <li> <p>CALABASH_STANDARD_OUTPUT: The Calabash standard output type.</p> </li> <li> <p>CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.</p> </li> <li> <p>AUTOMATION_OUTPUT: The automation output type.</p> </li> <li> <p>APPIUM_SERVER_OUTPUT: The Appium server output type.</p> </li> <li> <p>APPIUM_JAVA_OUTPUT: The Appium Java output type.</p> </li> <li> <p>APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.</p> </li> <li> <p>APPIUM_PYTHON_OUTPUT: The Appium Python output type.</p> </li> <li> <p>APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.</p> </li> <li> <p>EXPLORER_EVENT_LOG: The Explorer event log output type.</p> </li> <li> <p>EXPLORER_SUMMARY_LOG: The Explorer summary log output type.</p> </li> <li> <p>APPLICATION_CRASH_REPORT: The application crash report output type.</p> </li> <li> <p>XCTEST_LOG: The XCode test output type.</p> </li> <li> <p>VIDEO: The Video output type.</p> </li> <li> <p>CUSTOMER_ARTIFACT:The Customer Artifact output type.</p> </li> <li> <p>CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.</p> </li> <li> <p>TESTSPEC_OUTPUT: The Test Spec Output type.</p> </li> </ul>"
},
"extension":{
"shape":"String",
@ -1273,6 +1273,10 @@
"rules":{
"shape":"Rules",
"documentation":"<p>The device pool's rules.</p>"
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
}
},
"documentation":"<p>Represents a request to the create device pool operation.</p>"
@ -1513,7 +1517,7 @@
},
"type":{
"shape":"UploadType",
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web application upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul> <p> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web application upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul> <p> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
},
"contentType":{
"shape":"ContentType",
@ -1805,7 +1809,7 @@
},
"availability":{
"shape":"DeviceAvailability",
"documentation":"<p>Reflects how likely a device will be available for a test run.</p>"
"documentation":"<p>Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.</p>"
}
},
"documentation":"<p>Represents a device type that an app is tested against.</p>"
@ -1822,7 +1826,10 @@
"APPIUM_VERSION",
"INSTANCE_ARN",
"INSTANCE_LABELS",
"FLEET_TYPE"
"FLEET_TYPE",
"OS_VERSION",
"MODEL",
"AVAILABILITY"
]
},
"DeviceAvailability":{
@ -1839,18 +1846,18 @@
"members":{
"attribute":{
"shape":"DeviceFilterAttribute",
"documentation":"<p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul>"
"documentation":"<p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version. For example, \"10.3.2\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model. For example, \"iPad 5th Gen\".</p> <p> <i>Supported operators</i>: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer. For example, \"Apple\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p>Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p> <i>Supported operators</i>: <code>CONTAINS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> </dl>"
},
"operator":{
"shape":"DeviceFilterOperator",
"documentation":"<p>The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul>"
"shape":"RuleOperator",
"documentation":"<p>Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.</p>"
},
"values":{
"shape":"DeviceFilterValues",
"documentation":"<p>An array of one or more filter values used in a device filter.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".</p> </li> <li> <p>The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".</p> </li> <li> <p>The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul>"
"documentation":"<p>An array of one or more filter values used in a device filter.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".</p> </li> <li> <p>The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".</p> </li> <li> <p>The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul>"
}
},
"documentation":"<p>Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the \"deviceSelectionConfiguration\" parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p> <p>It is also passed in as the \"filters\" parameter to ListDevices. For an example of the JSON request syntax, see <a>ListDevices</a>.</p>"
"documentation":"<p>Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the <code>deviceSelectionConfiguration</code> parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p> <p>It is also passed in as the <code>filters</code> parameter to ListDevices. For an example of the JSON request syntax, see <a>ListDevices</a>.</p>"
},
"DeviceFilterAttribute":{
"type":"string",
@ -1869,19 +1876,6 @@
"FLEET_TYPE"
]
},
"DeviceFilterOperator":{
"type":"string",
"enum":[
"EQUALS",
"LESS_THAN",
"LESS_THAN_OR_EQUALS",
"GREATER_THAN",
"GREATER_THAN_OR_EQUALS",
"IN",
"NOT_IN",
"CONTAINS"
]
},
"DeviceFilterValues":{
"type":"list",
"member":{"shape":"String"}
@ -1982,6 +1976,10 @@
"rules":{
"shape":"Rules",
"documentation":"<p>Information about the device pool's rules.</p>"
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
}
},
"documentation":"<p>Represents a collection of device types.</p>"
@ -2028,14 +2026,14 @@
"members":{
"filters":{
"shape":"DeviceFilters",
"documentation":"<p>Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> <li> <p>Operator: The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p>Values: An array of one or more filter values.</p> <ul> <li> <p>The IN and NOT operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> <li> <p>In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.</p> </li> </ul> </li> </ul>"
"documentation":"<p>Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p> <b>Attribute</b> </p> <p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> <li> <p> <b>Operator</b> </p> <p>The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p> <b>Values</b> </p> <p>An array of one or more filter values.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".</p> </li> <li> <p>The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".</p> </li> <li> <p>The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> </ul>"
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The maximum number of devices to be included in a test run.</p>"
}
},
"documentation":"<p>Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in <a>ScheduleRun</a>.</p>"
"documentation":"<p>Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the <code>deviceSelectionConfiguration</code> request parameter in <a>ScheduleRun</a>.</p>"
},
"DeviceSelectionResult":{
"type":"structure",
@ -2173,7 +2171,7 @@
},
"testType":{
"shape":"TestType",
"documentation":"<p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
},
"test":{
"shape":"ScheduleRunTest",
@ -2618,7 +2616,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The job's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The job's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -2795,7 +2793,7 @@
},
"filters":{
"shape":"DeviceFilters",
"documentation":"<p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p>Attribute: The aspect of a device such as platform or model used as the selction criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> <li> <p>Operator: The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p>Values: An array of one or more filter values.</p> <ul> <li> <p>The IN and NOT operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> <li> <p>In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.</p> </li> </ul> </li> </ul>"
"documentation":"<p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p>Attribute: The aspect of a device such as platform or model used as the selction criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> <li> <p>Operator: The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p>Values: An array of one or more filter values.</p> <ul> <li> <p>The IN and NOT_IN operators take a values array that has one or more elements.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> <li> <p>In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.</p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Represents the result of a list devices request.</p>"
@ -3182,7 +3180,7 @@
},
"type":{
"shape":"UploadType",
"documentation":"<p>The type of upload.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul>"
"documentation":"<p>The type of upload.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.</p> </li> <li> <p> APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3730,7 +3728,7 @@
},
"billingMethod":{
"shape":"BillingMethod",
"documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"http://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>"
"documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>"
},
"deviceMinutes":{
"shape":"DeviceMinutes",
@ -3802,25 +3800,27 @@
"members":{
"attribute":{
"shape":"DeviceAttribute",
"documentation":"<p>The rule's attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of a device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul>"
"documentation":"<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>APPIUM_VERSION</dt> <dd> <p>The Appium version for the test.</p> <p> <i>Supported operators</i>: <code>CONTAINS</code> </p> </dd> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p> <i>Supported operators</i>: <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p> <i>Supported operators</i>: <code>CONTAINS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer. For example, \"Apple\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model, such as \"Apple iPad Air 2\" or \"Google Pixel\".</p> <p> <i>Supported operators</i>: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version. For example, \"10.3.2\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p>Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> </dl>"
},
"operator":{
"shape":"RuleOperator",
"documentation":"<p>The rule's operator.</p> <ul> <li> <p>EQUALS: The equals operator.</p> </li> <li> <p>GREATER_THAN: The greater-than operator.</p> </li> <li> <p>IN: The in operator.</p> </li> <li> <p>LESS_THAN: The less-than operator.</p> </li> <li> <p>NOT_IN: The not-in operator.</p> </li> <li> <p>CONTAINS: The contains operator.</p> </li> </ul>"
"documentation":"<p>Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The rule's value.</p> <p>The value must be passed in as a string using escaped quotes.</p> <p>For example:</p> <p>\"value\": \"\\\"ANDROID\\\"\"</p>"
"documentation":"<p>The rule's value.</p>"
}
},
"documentation":"<p>Represents a condition for a device pool. It is passed in as the <code>rules</code> parameter to <a>CreateDevicePool</a> and <a>UpdateDevicePool</a>.</p>"
"documentation":"<p>Represents a condition for a device pool.</p>"
},
"RuleOperator":{
"type":"string",
"enum":[
"EQUALS",
"LESS_THAN",
"LESS_THAN_OR_EQUALS",
"GREATER_THAN",
"GREATER_THAN_OR_EQUALS",
"IN",
"NOT_IN",
"CONTAINS"
@ -3843,7 +3843,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
},
"platform":{
"shape":"DevicePlatform",
@ -4067,11 +4067,11 @@
},
"devicePoolArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the device pool for the run to be scheduled.</p> <p>Either <b> <code>devicePoolArn</code> </b> or <b> <code>deviceSelectionConfiguration</code> </b> are required in a request.</p>"
"documentation":"<p>The ARN of the device pool for the run to be scheduled.</p>"
},
"deviceSelectionConfiguration":{
"shape":"DeviceSelectionConfiguration",
"documentation":"<p>The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.</p> <p>Either <b> <code>devicePoolArn</code> </b> or <b> <code>deviceSelectionConfiguration</code> </b> are required in a request.</p>"
"documentation":"<p>The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.</p> <p>Either <b> <code>devicePoolArn</code> </b> or <b> <code>deviceSelectionConfiguration</code> </b> is required in a request.</p>"
},
"name":{
"shape":"Name",
@ -4108,7 +4108,7 @@
"members":{
"type":{
"shape":"TestType",
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
},
"testPackageArn":{
"shape":"AmazonResourceName",
@ -4124,7 +4124,7 @@
},
"parameters":{
"shape":"TestParameters",
"documentation":"<p>The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.</p> <p>For all tests:</p> <ul> <li> <p>app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to \"false\" to disable it.</p> </li> </ul> <p>For Calabash tests:</p> <ul> <li> <p>profile: A cucumber profile, for example, \"my_profile_name\".</p> </li> <li> <p>tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".</p> </li> </ul> <p>For Appium tests (all types):</p> <ul> <li> <p>appium_version: The Appium version. Currently supported values are \"1.7.2\", \"1.7.1\", \"1.6.5\", \"latest\", and \"default\".</p> <ul> <li> <p>“latest” will run the latest Appium version supported by Device Farm (1.7.2).</p> </li> <li> <p>For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.</p> </li> <li> <p>This behavior is subject to change.</p> </li> </ul> </li> </ul> <p>For Fuzz tests (Android only):</p> <ul> <li> <p>event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.</p> </li> <li> <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.</p> </li> <li> <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p> </li> </ul> <p>For Explorer tests:</p> <ul> <li> <p>username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.</p> </li> <li> <p>password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.</p> </li> </ul> <p>For Instrumentation:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul> <p>For XCTest and XCTestUI:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test class: \"LoginTests\"</p> </li> <li> <p>Running a multiple test classes: \"LoginTests,SmokeTests\"</p> </li> <li> <p>Running a single test: \"LoginTests/testValid\"</p> </li> <li> <p>Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"</p> </li> </ul> </li> </ul> <p>For UIAutomator:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul>"
"documentation":"<p>The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.</p> <p>For all tests:</p> <ul> <li> <p>app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to \"false\" to disable it.</p> </li> </ul> <p>For Calabash tests:</p> <ul> <li> <p>profile: A cucumber profile, for example, \"my_profile_name\".</p> </li> <li> <p>tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".</p> </li> </ul> <p>For Appium tests (all types):</p> <ul> <li> <p>appium_version: The Appium version. Currently supported values are \"1.6.5\" (and higher), \"latest\", and \"default\".</p> <ul> <li> <p>“latest” will run the latest Appium version supported by Device Farm (1.9.1).</p> </li> <li> <p>For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.</p> </li> <li> <p>This behavior is subject to change.</p> </li> </ul> </li> </ul> <p>For Fuzz tests (Android only):</p> <ul> <li> <p>event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.</p> </li> <li> <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.</p> </li> <li> <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p> </li> </ul> <p>For Explorer tests:</p> <ul> <li> <p>username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.</p> </li> <li> <p>password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.</p> </li> </ul> <p>For Instrumentation:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul> <p>For XCTest and XCTestUI:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test class: \"LoginTests\"</p> </li> <li> <p>Running a multiple test classes: \"LoginTests,SmokeTests\"</p> </li> <li> <p>Running a single test: \"LoginTests/testValid\"</p> </li> <li> <p>Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"</p> </li> </ul> </li> </ul> <p>For UIAutomator:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Represents test settings. This data structure is passed in as the \"test\" parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p>"
@ -4226,7 +4226,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The suite's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The suite's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -4280,7 +4280,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -4331,9 +4331,13 @@
"APPIUM_JAVA_JUNIT",
"APPIUM_JAVA_TESTNG",
"APPIUM_PYTHON",
"APPIUM_NODE",
"APPIUM_RUBY",
"APPIUM_WEB_JAVA_JUNIT",
"APPIUM_WEB_JAVA_TESTNG",
"APPIUM_WEB_PYTHON",
"APPIUM_WEB_NODE",
"APPIUM_WEB_RUBY",
"CALABASH",
"INSTRUMENTATION",
"UIAUTOMATION",
@ -4440,6 +4444,14 @@
"rules":{
"shape":"Rules",
"documentation":"<p>Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.</p>"
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p> <p>If you use this parameter in your request, you cannot use the <code>clearMaxDevices</code> parameter in the same request.</p>"
},
"clearMaxDevices":{
"shape":"Boolean",
"documentation":"<p>Sets whether the <code>maxDevices</code> parameter applies to your device pool. If you set this parameter to <code>true</code>, the <code>maxDevices</code> parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the <code>rules</code> parameter.</p> <p>If you use this parameter in your request, you cannot use the <code>maxDevices</code> parameter in the same request.</p>"
}
},
"documentation":"<p>Represents a request to the update device pool operation.</p>"
@ -4668,7 +4680,7 @@
},
"type":{
"shape":"UploadType",
"documentation":"<p>The upload's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul>"
"documentation":"<p>The upload's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul>"
},
"status":{
"shape":"UploadStatus",
@ -4723,9 +4735,13 @@
"APPIUM_JAVA_JUNIT_TEST_PACKAGE",
"APPIUM_JAVA_TESTNG_TEST_PACKAGE",
"APPIUM_PYTHON_TEST_PACKAGE",
"APPIUM_NODE_TEST_PACKAGE",
"APPIUM_RUBY_TEST_PACKAGE",
"APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE",
"APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE",
"APPIUM_WEB_PYTHON_TEST_PACKAGE",
"APPIUM_WEB_NODE_TEST_PACKAGE",
"APPIUM_WEB_RUBY_TEST_PACKAGE",
"CALABASH_TEST_PACKAGE",
"INSTRUMENTATION_TEST_PACKAGE",
"UIAUTOMATION_TEST_PACKAGE",
@ -4735,9 +4751,13 @@
"APPIUM_JAVA_JUNIT_TEST_SPEC",
"APPIUM_JAVA_TESTNG_TEST_SPEC",
"APPIUM_PYTHON_TEST_SPEC",
"APPIUM_NODE_TEST_SPEC",
"APPIUM_RUBY_TEST_SPEC",
"APPIUM_WEB_JAVA_JUNIT_TEST_SPEC",
"APPIUM_WEB_JAVA_TESTNG_TEST_SPEC",
"APPIUM_WEB_PYTHON_TEST_SPEC",
"APPIUM_WEB_NODE_TEST_SPEC",
"APPIUM_WEB_RUBY_TEST_SPEC",
"INSTRUMENTATION_TEST_SPEC",
"XCTEST_UI_TEST_SPEC"
]

21
botocore/data/directconnect/2012-10-25/paginators-1.json
View file

@ -1,3 +1,22 @@
{
"pagination": {}
"pagination": {
"DescribeDirectConnectGatewayAssociations": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "directConnectGatewayAssociations"
},
"DescribeDirectConnectGatewayAttachments": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "directConnectGatewayAttachments"
},
"DescribeDirectConnectGateways": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "directConnectGateways"
}
}
}

41
botocore/data/directconnect/2012-10-25/service-2.json
View file

@ -375,7 +375,7 @@
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Deprecated. Use <a>DescribeLoa</a> instead.</p> <p>Gets the LOA-CFA for a connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the <i>AWS Direct Connect User Guide</i>.</p>",
"documentation":"<p>Deprecated. Use <a>DescribeLoa</a> instead.</p> <p>Gets the LOA-CFA for a connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the <i>AWS Direct Connect User Guide</i>.</p>",
"deprecated":true
},
"DescribeConnections":{
@ -475,7 +475,7 @@
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Deprecated. Use <a>DescribeLoa</a> instead.</p> <p>Gets the LOA-CFA for the specified interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the <i>AWS Direct Connect User Guide</i>.</p>",
"documentation":"<p>Deprecated. Use <a>DescribeLoa</a> instead.</p> <p>Gets the LOA-CFA for the specified interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the <i>AWS Direct Connect User Guide</i>.</p>",
"deprecated":true
},
"DescribeInterconnects":{
@ -518,7 +518,7 @@
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the <i>AWS Direct Connect User Guide</i>.</p>"
"documentation":"<p>Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the <i>AWS Direct Connect User Guide</i>.</p>"
},
"DescribeLocations":{
"name":"DescribeLocations",
@ -855,7 +855,7 @@
},
"bgpStatus":{
"shape":"BGPStatus",
"documentation":"<p>The status of the BGP peer. The following are the possible values:</p> <ul> <li> <p> <code>up</code>: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.</p> </li> <li> <p> <code>down</code>: The BGP peer is down.</p> </li> <li> <p> <code>unknown</code>: The BGP peer status is unknown.</p> </li> </ul>"
"documentation":"<p>The status of the BGP peer. The following are the possible values:</p> <ul> <li> <p> <code>up</code>: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.</p> </li> <li> <p> <code>down</code>: The BGP peer is down.</p> </li> <li> <p> <code>unknown</code>: The BGP peer status is not available.</p> </li> </ul>"
},
"awsDeviceV2":{
"shape":"AwsDeviceV2",
@ -883,7 +883,8 @@
"type":"string",
"enum":[
"up",
"down"
"down",
"unknown"
]
},
"Bandwidth":{"type":"string"},
@ -904,7 +905,7 @@
"members":{
"connectionState":{
"shape":"ConnectionState",
"documentation":"<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</p> </li> <li> <p> <code>requested</code>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> </ul>"
"documentation":"<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</p> </li> <li> <p> <code>requested</code>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> <li> <p> <code>unknown</code>: The state of the connection is not available.</p> </li> </ul>"
}
}
},
@ -931,7 +932,7 @@
"members":{
"virtualInterfaceState":{
"shape":"VirtualInterfaceState",
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> </ul>"
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> <li> <p> <code>unknown</code>: The state of the virtual interface is not available.</p> </li> </ul>"
}
}
},
@ -950,7 +951,7 @@
"members":{
"virtualInterfaceState":{
"shape":"VirtualInterfaceState",
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> </ul>"
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> <li> <p> <code>unknown</code>: The state of the virtual interface is not available.</p> </li> </ul>"
}
}
},
@ -971,7 +972,7 @@
},
"connectionState":{
"shape":"ConnectionState",
"documentation":"<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</p> </li> <li> <p> <code>requested</code>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> </ul>"
"documentation":"<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</p> </li> <li> <p> <code>requested</code>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> <li> <p> <code>unknown</code>: The state of the connection is not available.</p> </li> </ul>"
},
"region":{
"shape":"Region",
@ -1036,7 +1037,8 @@
"down",
"deleting",
"deleted",
"rejected"
"rejected",
"unknown"
]
},
"Connections":{
@ -1338,7 +1340,7 @@
"members":{
"interconnectState":{
"shape":"InterconnectState",
"documentation":"<p>The state of the interconnect. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The interconnect is approved, and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The interconnect is being deleted.</p> </li> <li> <p> <code>deleted</code>: The interconnect is deleted.</p> </li> </ul>"
"documentation":"<p>The state of the interconnect. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The interconnect is approved, and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The interconnect is being deleted.</p> </li> <li> <p> <code>deleted</code>: The interconnect is deleted.</p> </li> <li> <p> <code>unknown</code>: The state of the interconnect is not available.</p> </li> </ul>"
}
}
},
@ -1367,7 +1369,7 @@
"members":{
"virtualInterfaceState":{
"shape":"VirtualInterfaceState",
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> </ul>"
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> <li> <p> <code>unknown</code>: The state of the virtual interface is not available.</p> </li> </ul>"
}
}
},
@ -1813,7 +1815,7 @@
},
"interconnectState":{
"shape":"InterconnectState",
"documentation":"<p>The state of the interconnect. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The interconnect is approved, and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The interconnect is being deleted.</p> </li> <li> <p> <code>deleted</code>: The interconnect is deleted.</p> </li> </ul>"
"documentation":"<p>The state of the interconnect. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The interconnect is approved, and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The interconnect is being deleted.</p> </li> <li> <p> <code>deleted</code>: The interconnect is deleted.</p> </li> <li> <p> <code>unknown</code>: The state of the interconnect is not available.</p> </li> </ul>"
},
"region":{
"shape":"Region",
@ -1868,7 +1870,8 @@
"available",
"down",
"deleting",
"deleted"
"deleted",
"unknown"
]
},
"Interconnects":{
@ -1906,7 +1909,7 @@
},
"lagState":{
"shape":"LagState",
"documentation":"<p>The state of the LAG. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.</p> </li> <li> <p> <code>pending</code>: The LAG has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is established and the LAG is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The LAG is being deleted.</p> </li> <li> <p> <code>deleted</code>: The LAG is deleted.</p> </li> </ul>"
"documentation":"<p>The state of the LAG. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.</p> </li> <li> <p> <code>pending</code>: The LAG has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is established and the LAG is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The LAG is being deleted.</p> </li> <li> <p> <code>deleted</code>: The LAG is deleted.</p> </li> <li> <p> <code>unknown</code>: The state of the LAG is not available.</p> </li> </ul>"
},
"location":{
"shape":"LocationCode",
@ -1961,7 +1964,8 @@
"available",
"down",
"deleting",
"deleted"
"deleted",
"unknown"
]
},
"Lags":{
@ -2489,7 +2493,7 @@
},
"virtualInterfaceState":{
"shape":"VirtualInterfaceState",
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> </ul>"
"documentation":"<p>The state of the virtual interface. The following are the possible values:</p> <ul> <li> <p> <code>confirming</code>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <code>verifying</code>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <code>pending</code>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <code>available</code>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <code>down</code>: A virtual interface that is BGP down.</p> </li> <li> <p> <code>deleting</code>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <code>deleted</code>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <code>rejected</code>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the <code>Confirming</code> state is deleted by the virtual interface owner, the virtual interface enters the <code>Rejected</code> state.</p> </li> <li> <p> <code>unknown</code>: The state of the virtual interface is not available.</p> </li> </ul>"
},
"customerRouterConfig":{
"shape":"RouterConfig",
@ -2547,7 +2551,8 @@
"down",
"deleting",
"deleted",
"rejected"
"rejected",
"unknown"
]
},
"VirtualInterfaceType":{"type":"string"},

39
botocore/data/discovery/2015-11-01/paginators-1.json
View file

@ -1,3 +1,40 @@
{
"pagination": {}
"pagination": {
"DescribeAgents": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "agentsInfo"
},
"DescribeContinuousExports": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "descriptions"
},
"DescribeExportConfigurations": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "exportsInfo"
},
"DescribeExportTasks": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "exportsInfo"
},
"DescribeTags": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "tags"
},
"ListConfigurations": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "configurations"
}
}
}

308
botocore/data/discovery/2015-11-01/service-2.json
View file

@ -28,6 +28,21 @@
],
"documentation":"<p>Associates one or more configuration items with an application.</p>"
},
"BatchDeleteImportData":{
"name":"BatchDeleteImportData",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDeleteImportDataRequest"},
"output":{"shape":"BatchDeleteImportDataResponse"},
"errors":[
{"shape":"AuthorizationErrorException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ServerInternalErrorException"}
],
"documentation":"<p>Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications. </p> <p>AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.</p>"
},
"CreateApplication":{
"name":"CreateApplication",
"http":{
@ -124,7 +139,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"ServerInternalErrorException"}
],
"documentation":"<p>Retrieves attributes for a list of configuration item IDs.</p> <note> <p>All of the supplied IDs must be for the same asset type from one of the follwoing:</p> <ul> <li> <p>server</p> </li> <li> <p>application</p> </li> <li> <p>process</p> </li> <li> <p>connection</p> </li> </ul> <p>Output fields are specific to the asset type specified. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.</p> <p>For a complete list of outputs for each asset type, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#DescribeConfigurations\">Using the DescribeConfigurations Action</a>.</p> </note>"
"documentation":"<p>Retrieves attributes for a list of configuration item IDs.</p> <note> <p>All of the supplied IDs must be for the same asset type from one of the following:</p> <ul> <li> <p>server</p> </li> <li> <p>application</p> </li> <li> <p>process</p> </li> <li> <p>connection</p> </li> </ul> <p>Output fields are specific to the asset type specified. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.</p> <p>For a complete list of outputs for each asset type, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#DescribeConfigurations\">Using the DescribeConfigurations Action</a>.</p> </note>"
},
"DescribeContinuousExports":{
"name":"DescribeContinuousExports",
@ -159,7 +174,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"ServerInternalErrorException"}
],
"documentation":"<p> <code>DescribeExportConfigurations</code> is deprecated.</p> <p>Use instead <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html\"> <code>DescribeExportTasks</code> </a>.</p>",
"documentation":"<p> <code>DescribeExportConfigurations</code> is deprecated. Use <a href=\"https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html\">DescribeImportTasks</a>, instead.</p>",
"deprecated":true
},
"DescribeExportTasks":{
@ -178,6 +193,21 @@
],
"documentation":"<p>Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.</p>"
},
"DescribeImportTasks":{
"name":"DescribeImportTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeImportTasksRequest"},
"output":{"shape":"DescribeImportTasksResponse"},
"errors":[
{"shape":"AuthorizationErrorException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ServerInternalErrorException"}
],
"documentation":"<p>Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
@ -329,6 +359,22 @@
],
"documentation":"<p> Begins the export of discovered data to an S3 bucket.</p> <p> If you specify <code>agentIds</code> in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using <code>startTime</code> and <code>endTime</code>. Export of detailed agent data is limited to five concurrently running exports. </p> <p> If you do not include an <code>agentIds</code> filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. </p>"
},
"StartImportTask":{
"name":"StartImportTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartImportTaskRequest"},
"output":{"shape":"StartImportTaskResponse"},
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"AuthorizationErrorException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ServerInternalErrorException"}
],
"documentation":"<p>Starts an import task, which allows you to import details of your on-premises environment directly into AWS without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.</p> <p>To start an import request, do this:</p> <ol> <li> <p>Download the specially formatted comma separated value (CSV) import template, which you can find here: <a href=\"https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv\">https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv</a>.</p> </li> <li> <p>Fill out the template with your server and application data.</p> </li> <li> <p>Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.</p> </li> <li> <p>Use the console or the <code>StartImportTask</code> command with the AWS CLI or one of the AWS SDKs to import the records from your file.</p> </li> </ol> <p>For more information, including step-by-step procedures, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html\">Migration Hub Import</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> <note> <p>There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html\">AWS Application Discovery Service Limits</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> </note>"
},
"StopContinuousExport":{
"name":"StopContinuousExport",
"http":{
@ -523,11 +569,65 @@
"documentation":"<p>The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.</p>",
"exception":true
},
"BatchDeleteImportDataError":{
"type":"structure",
"members":{
"importTaskId":{
"shape":"ImportTaskIdentifier",
"documentation":"<p>The unique import ID associated with the error that occurred.</p>"
},
"errorCode":{
"shape":"BatchDeleteImportDataErrorCode",
"documentation":"<p>The type of error that occurred for a specific import task.</p>"
},
"errorDescription":{
"shape":"BatchDeleteImportDataErrorDescription",
"documentation":"<p>The description of the error that occurred for a specific import task.</p>"
}
},
"documentation":"<p>Error messages returned for each import task that you deleted as a response for this command.</p>"
},
"BatchDeleteImportDataErrorCode":{
"type":"string",
"enum":[
"NOT_FOUND",
"INTERNAL_SERVER_ERROR"
]
},
"BatchDeleteImportDataErrorDescription":{"type":"string"},
"BatchDeleteImportDataErrorList":{
"type":"list",
"member":{"shape":"BatchDeleteImportDataError"}
},
"BatchDeleteImportDataRequest":{
"type":"structure",
"required":["importTaskIds"],
"members":{
"importTaskIds":{
"shape":"ToDeleteIdentifierList",
"documentation":"<p>The IDs for the import tasks that you want to delete.</p>"
}
}
},
"BatchDeleteImportDataResponse":{
"type":"structure",
"members":{
"errors":{
"shape":"BatchDeleteImportDataErrorList",
"documentation":"<p>Error messages returned for each import task that you deleted as a response for this command.</p>"
}
}
},
"Boolean":{"type":"boolean"},
"BoxedInteger":{
"type":"integer",
"box":true
},
"ClientRequestToken":{
"type":"string",
"max":100,
"min":1
},
"Condition":{"type":"string"},
"Configuration":{
"type":"map",
@ -605,7 +705,7 @@
},
"statusDetail":{
"shape":"StringMax255",
"documentation":"<p>Contains information about any errors that may have occurred.</p>"
"documentation":"<p>Contains information about any errors that have occurred. This data type can have the following values:</p> <ul> <li> <p>ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your AWS administrator for help. For more information, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html\">Setting Up AWS Application Discovery Service</a> in the Application Discovery Service User Guide.</p> </li> <li> <p>DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see <a href=\"http://docs.aws.amazon.com/streams/latest/dev/service-sizes-and-limits.html\">Kinesis Data Streams Limits</a> in the Amazon Kinesis Data Streams Developer Guide.</p> </li> <li> <p>FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html#setting-up-user-policy\">Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies</a> in the Application Discovery Service User Guide.</p> </li> <li> <p>FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams.</p> </li> <li> <p>INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact AWS Support.</p> </li> <li> <p>S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of Amazon S3 buckets or request a limit increase and try again. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html\">Bucket Restrictions and Limitations</a> in the Amazon Simple Storage Service Developer Guide.</p> </li> <li> <p>S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: <a href=\"https://aws.amazon.com/s3\">https://aws.amazon.com/s3</a>.</p> </li> </ul>"
},
"s3Bucket":{
"shape":"S3Bucket",
@ -986,6 +1086,46 @@
}
}
},
"DescribeImportTasksFilterList":{
"type":"list",
"member":{"shape":"ImportTaskFilter"}
},
"DescribeImportTasksMaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"DescribeImportTasksRequest":{
"type":"structure",
"members":{
"filters":{
"shape":"DescribeImportTasksFilterList",
"documentation":"<p>An array of name-value pairs that you provide to filter the results for the <code>DescribeImportTask</code> request to a specific subset of results. Currently, wildcard values aren't supported for filters.</p>"
},
"maxResults":{
"shape":"DescribeImportTasksMaxResults",
"documentation":"<p>The maximum number of results that you want this request to return, up to 100.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to request a specific page of results.</p>"
}
}
},
"DescribeImportTasksResponse":{
"type":"structure",
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to request the next page of results.</p>"
},
"tasks":{
"shape":"ImportTaskList",
"documentation":"<p>A returned array of import tasks that match any applied filters, up to the specified number of maximum results.</p>"
}
}
},
"DescribeTagsRequest":{
"type":"structure",
"members":{
@ -1214,6 +1354,126 @@
}
}
},
"ImportStatus":{
"type":"string",
"enum":[
"IMPORT_IN_PROGRESS",
"IMPORT_COMPLETE",
"IMPORT_FAILED",
"IMPORT_FAILED_SERVER_LIMIT_EXCEEDED",
"IMPORT_FAILED_RECORD_LIMIT_EXCEEDED",
"DELETE_IN_PROGRESS",
"DELETE_COMPLETE",
"DELETE_FAILED",
"DELETE_FAILED_LIMIT_EXCEEDED"
]
},
"ImportTask":{
"type":"structure",
"members":{
"importTaskId":{
"shape":"ImportTaskIdentifier",
"documentation":"<p>The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an AWS account.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.</p>"
},
"name":{
"shape":"ImportTaskName",
"documentation":"<p>A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.</p>"
},
"importUrl":{
"shape":"ImportURL",
"documentation":"<p>The URL for your import file that you've uploaded to Amazon S3.</p>"
},
"status":{
"shape":"ImportStatus",
"documentation":"<p>The status of the import task. An import can have the status of <code>IMPORT_COMPLETE</code> and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the <code>errorsAndFailedEntriesZip</code> field, or in the Migration Hub management console.</p>"
},
"importRequestTime":{
"shape":"TimeStamp",
"documentation":"<p>The time that the import task request was made, presented in the Unix time stamp format.</p>"
},
"importCompletionTime":{
"shape":"TimeStamp",
"documentation":"<p>The time that the import task request finished, presented in the Unix time stamp format.</p>"
},
"importDeletedTime":{
"shape":"TimeStamp",
"documentation":"<p>The time that the import task request was deleted, presented in the Unix time stamp format.</p>"
},
"serverImportSuccess":{
"shape":"Integer",
"documentation":"<p>The total number of server records in the import file that were successfully imported.</p>"
},
"serverImportFailure":{
"shape":"Integer",
"documentation":"<p>The total number of server records in the import file that failed to be imported.</p>"
},
"applicationImportSuccess":{
"shape":"Integer",
"documentation":"<p>The total number of application records in the import file that were successfully imported.</p>"
},
"applicationImportFailure":{
"shape":"Integer",
"documentation":"<p>The total number of application records in the import file that failed to be imported.</p>"
},
"errorsAndFailedEntriesZip":{
"shape":"S3PresignedUrl",
"documentation":"<p>A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.</p> <p>This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.</p> <p>If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.</p>"
}
},
"documentation":"<p>An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.</p>"
},
"ImportTaskFilter":{
"type":"structure",
"members":{
"name":{
"shape":"ImportTaskFilterName",
"documentation":"<p>The name, status, or import task ID for a specific import task.</p>"
},
"values":{
"shape":"ImportTaskFilterValueList",
"documentation":"<p>An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries.</p>"
}
},
"documentation":"<p>A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.</p> <note> <p>When filtering by import status, all other filter values are ignored.</p> </note>"
},
"ImportTaskFilterName":{
"type":"string",
"enum":[
"IMPORT_TASK_ID",
"STATUS",
"NAME"
]
},
"ImportTaskFilterValue":{
"type":"string",
"max":100,
"min":1
},
"ImportTaskFilterValueList":{
"type":"list",
"member":{"shape":"ImportTaskFilterValue"},
"max":100,
"min":1
},
"ImportTaskIdentifier":{"type":"string"},
"ImportTaskList":{
"type":"list",
"member":{"shape":"ImportTask"}
},
"ImportTaskName":{
"type":"string",
"max":100,
"min":1
},
"ImportURL":{
"type":"string",
"max":4000,
"min":1
},
"Integer":{"type":"integer"},
"InvalidParameterException":{
"type":"structure",
@ -1384,7 +1644,7 @@
"members":{
"message":{"shape":"Message"}
},
"documentation":"<p/>",
"documentation":"<p>This issue occurs when the same <code>clientRequestToken</code> is used with the <code>StartImportTask</code> action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different <code>clientRequestToken</code>, and try again.</p>",
"exception":true
},
"ResourceNotFoundException":{
@ -1396,6 +1656,7 @@
"exception":true
},
"S3Bucket":{"type":"string"},
"S3PresignedUrl":{"type":"string"},
"SchemaStorageConfig":{
"type":"map",
"key":{"shape":"DatabaseName"},
@ -1489,6 +1750,37 @@
}
}
},
"StartImportTaskRequest":{
"type":"structure",
"required":[
"name",
"importUrl"
],
"members":{
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.</p> <p>Sending more than one <code>StartImportTask</code> request with the same client request token will return information about the original import task with that client request token.</p>",
"idempotencyToken":true
},
"name":{
"shape":"ImportTaskName",
"documentation":"<p>A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.</p>"
},
"importUrl":{
"shape":"ImportURL",
"documentation":"<p>The URL for your import file that you've uploaded to Amazon S3.</p> <note> <p>If you're using the AWS CLI, this URL is structured as follows: <code>s3://BucketName/ImportFileName.CSV</code> </p> </note>"
}
}
},
"StartImportTaskResponse":{
"type":"structure",
"members":{
"task":{
"shape":"ImportTask",
"documentation":"<p>An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more. </p>"
}
}
},
"StopContinuousExportRequest":{
"type":"structure",
"required":["exportId"],
@ -1584,6 +1876,12 @@
},
"TagValue":{"type":"string"},
"TimeStamp":{"type":"timestamp"},
"ToDeleteIdentifierList":{
"type":"list",
"member":{"shape":"ImportTaskIdentifier"},
"max":10,
"min":1
},
"UpdateApplicationRequest":{
"type":"structure",
"required":["configurationId"],
@ -1615,5 +1913,5 @@
]
}
},
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an AWS-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see <a href=\"http://aws.amazon.com/application-discovery/faqs/\">AWS Application Discovery Service FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation:</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. </p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>We recommend that you use agent-based discovery for non-VMware environments and to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts.</p> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, <a href=\"http://aws.amazon.com/application-discovery/\">sign up for Application Discovery Service</a>. </p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>"
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an AWS-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see <a href=\"http://aws.amazon.com/application-discovery/faqs/\">AWS Application Discovery Service FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation:</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. </p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>We recommend that you use agent-based discovery for non-VMware environments and to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts.</p> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.</p> </important> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>"
}

7
botocore/data/dlm/2018-01-12/service-2.json
View file

@ -521,7 +521,10 @@
"member":{"shape":"Time"},
"max":1
},
"Timestamp":{"type":"timestamp"},
"Timestamp":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"UpdateLifecyclePolicyRequest":{
"type":"structure",
"required":["PolicyId"],
@ -556,5 +559,5 @@
}
}
},
"documentation":"<fullname>Amazon Data Lifecycle Manager</fullname> <p>With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.</p> <p>Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html\">Automating the Amazon EBS Snapshot Lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p>"
"documentation":"<fullname>Amazon Data Lifecycle Manager</fullname> <p>With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.</p> <p>Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html\">Automating the Amazon EBS Snapshot Lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p>"
}

10
botocore/data/dms/2016-01-01/waiters-2.json
View file

@ -4,22 +4,22 @@
"TestConnectionSucceeds":{
"acceptors":[
{
"argument":"Connection.Status",
"argument":"Connections[].Status",
"expected":"successful",
"matcher":"path",
"matcher":"pathAll",
"state":"success"
},
{
"argument":"Connection.Status",
"argument":"Connections[].Status",
"expected":"failed",
"matcher":"path",
"matcher":"pathAny",
"state":"failure"
}
],
"delay":5,
"description":"Wait until testing connection succeeds.",
"maxAttempts":60,
"operation":"TestConnection"
"operation":"DescribeConnections"
},
"EndpointDeleted":{
"acceptors":[

40
botocore/data/docdb/2014-10-31/paginators-1.json Normal file
View file

@ -0,0 +1,40 @@
{
"pagination": {
"DescribeDBClusters": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBClusters"
},
"DescribeDBEngineVersions": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBEngineVersions"
},
"DescribeDBInstances": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBInstances"
},
"DescribeDBSubnetGroups": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBSubnetGroups"
},
"DescribeEvents": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "Events"
},
"DescribeOrderableDBInstanceOptions": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "OrderableDBInstanceOptions"
}
}
}

3720
botocore/data/docdb/2014-10-31/service-2.json Normal file
View file

@ -0,0 +1,3720 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2014-10-31",
"endpointPrefix":"rds",
"protocol":"query",
"serviceAbbreviation":"Amazon DocDB",
"serviceFullName":"Amazon DocumentDB with MongoDB compatibility",
"serviceId":"DocDB",
"signatureVersion":"v4",
"signingName":"rds",
"uid":"docdb-2014-10-31",
"xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/"
},
"operations":{
"AddTagsToResource":{
"name":"AddTagsToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToResourceMessage"},
"errors":[
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSnapshotNotFoundFault"},
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a <code>Condition</code> statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.</p>"
},
"ApplyPendingMaintenanceAction":{
"name":"ApplyPendingMaintenanceAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ApplyPendingMaintenanceActionMessage"},
"output":{
"shape":"ApplyPendingMaintenanceActionResult",
"resultWrapper":"ApplyPendingMaintenanceActionResult"
},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"<p>Applies a pending maintenance action to a resource (for example, to a DB instance).</p>"
},
"CopyDBClusterParameterGroup":{
"name":"CopyDBClusterParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CopyDBClusterParameterGroupMessage"},
"output":{
"shape":"CopyDBClusterParameterGroupResult",
"resultWrapper":"CopyDBClusterParameterGroupResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
"documentation":"<p>Copies the specified DB cluster parameter group.</p>"
},
"CopyDBClusterSnapshot":{
"name":"CopyDBClusterSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CopyDBClusterSnapshotMessage"},
"output":{
"shape":"CopyDBClusterSnapshotResult",
"resultWrapper":"CopyDBClusterSnapshotResult"
},
"errors":[
{"shape":"DBClusterSnapshotAlreadyExistsFault"},
{"shape":"DBClusterSnapshotNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p> <p>To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in the <i>copying</i> status.</p>"
},
"CreateDBCluster":{
"name":"CreateDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBClusterMessage"},
"output":{
"shape":"CreateDBClusterResult",
"resultWrapper":"CreateDBClusterResult"
},
"errors":[
{"shape":"DBClusterAlreadyExistsFault"},
{"shape":"InsufficientStorageClusterCapacityFault"},
{"shape":"DBClusterQuotaExceededFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBSubnetGroupStateFault"},
{"shape":"InvalidSubnet"},
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBClusterParameterGroupNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DBClusterNotFoundFault"},
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}
],
"documentation":"<p>Creates a new Amazon DocumentDB DB cluster.</p>"
},
"CreateDBClusterParameterGroup":{
"name":"CreateDBClusterParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBClusterParameterGroupMessage"},
"output":{
"shape":"CreateDBClusterParameterGroupResult",
"resultWrapper":"CreateDBClusterParameterGroupResult"
},
"errors":[
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
"documentation":"<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p>A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.</p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
},
"CreateDBClusterSnapshot":{
"name":"CreateDBClusterSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBClusterSnapshotMessage"},
"output":{
"shape":"CreateDBClusterSnapshotResult",
"resultWrapper":"CreateDBClusterSnapshotResult"
},
"errors":[
{"shape":"DBClusterSnapshotAlreadyExistsFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBClusterNotFoundFault"},
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"}
],
"documentation":"<p>Creates a snapshot of a DB cluster. </p>"
},
"CreateDBInstance":{
"name":"CreateDBInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBInstanceMessage"},
"output":{
"shape":"CreateDBInstanceResult",
"resultWrapper":"CreateDBInstanceResult"
},
"errors":[
{"shape":"DBInstanceAlreadyExistsFault"},
{"shape":"InsufficientDBInstanceCapacityFault"},
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"DBSecurityGroupNotFoundFault"},
{"shape":"InstanceQuotaExceededFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidSubnet"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"DBClusterNotFoundFault"},
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"<p>Creates a new DB instance.</p>"
},
"CreateDBSubnetGroup":{
"name":"CreateDBSubnetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBSubnetGroupMessage"},
"output":{
"shape":"CreateDBSubnetGroupResult",
"resultWrapper":"CreateDBSubnetGroupResult"
},
"errors":[
{"shape":"DBSubnetGroupAlreadyExistsFault"},
{"shape":"DBSubnetGroupQuotaExceededFault"},
{"shape":"DBSubnetQuotaExceededFault"},
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidSubnet"}
],
"documentation":"<p>Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.</p>"
},
"DeleteDBCluster":{
"name":"DeleteDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBClusterMessage"},
"output":{
"shape":"DeleteDBClusterResult",
"resultWrapper":"DeleteDBClusterResult"
},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBClusterSnapshotAlreadyExistsFault"},
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"}
],
"documentation":"<p>Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p/>"
},
"DeleteDBClusterParameterGroup":{
"name":"DeleteDBClusterParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBClusterParameterGroupMessage"},
"errors":[
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</p>"
},
"DeleteDBClusterSnapshot":{
"name":"DeleteDBClusterSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBClusterSnapshotMessage"},
"output":{
"shape":"DeleteDBClusterSnapshotResult",
"resultWrapper":"DeleteDBClusterSnapshotResult"
},
"errors":[
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"DBClusterSnapshotNotFoundFault"}
],
"documentation":"<p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note>"
},
"DeleteDBInstance":{
"name":"DeleteDBInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBInstanceMessage"},
"output":{
"shape":"DeleteDBInstanceResult",
"resultWrapper":"DeleteDBInstanceResult"
},
"errors":[
{"shape":"DBInstanceNotFoundFault"},
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBSnapshotAlreadyExistsFault"},
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterStateFault"}
],
"documentation":"<p>Deletes a previously provisioned DB instance. </p>"
},
"DeleteDBSubnetGroup":{
"name":"DeleteDBSubnetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBSubnetGroupMessage"},
"errors":[
{"shape":"InvalidDBSubnetGroupStateFault"},
{"shape":"InvalidDBSubnetStateFault"},
{"shape":"DBSubnetGroupNotFoundFault"}
],
"documentation":"<p>Deletes a DB subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>"
},
"DescribeDBClusterParameterGroups":{
"name":"DescribeDBClusterParameterGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBClusterParameterGroupsMessage"},
"output":{
"shape":"DBClusterParameterGroupsMessage",
"resultWrapper":"DescribeDBClusterParameterGroupsResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains only the description of the specified DB cluster parameter group. </p>"
},
"DescribeDBClusterParameters":{
"name":"DescribeDBClusterParameters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBClusterParametersMessage"},
"output":{
"shape":"DBClusterParameterGroupDetails",
"resultWrapper":"DescribeDBClusterParametersResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Returns the detailed parameter list for a particular DB cluster parameter group.</p>"
},
"DescribeDBClusterSnapshotAttributes":{
"name":"DescribeDBClusterSnapshotAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"},
"output":{
"shape":"DescribeDBClusterSnapshotAttributesResult",
"resultWrapper":"DescribeDBClusterSnapshotAttributesResult"
},
"errors":[
{"shape":"DBClusterSnapshotNotFoundFault"}
],
"documentation":"<p>Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other AWS accounts, <code>DescribeDBClusterSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.</p>"
},
"DescribeDBClusterSnapshots":{
"name":"DescribeDBClusterSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBClusterSnapshotsMessage"},
"output":{
"shape":"DBClusterSnapshotMessage",
"resultWrapper":"DescribeDBClusterSnapshotsResult"
},
"errors":[
{"shape":"DBClusterSnapshotNotFoundFault"}
],
"documentation":"<p>Returns information about DB cluster snapshots. This API operation supports pagination.</p>"
},
"DescribeDBClusters":{
"name":"DescribeDBClusters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBClustersMessage"},
"output":{
"shape":"DBClusterMessage",
"resultWrapper":"DescribeDBClustersResult"
},
"errors":[
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination.</p>"
},
"DescribeDBEngineVersions":{
"name":"DescribeDBEngineVersions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBEngineVersionsMessage"},
"output":{
"shape":"DBEngineVersionMessage",
"resultWrapper":"DescribeDBEngineVersionsResult"
},
"documentation":"<p>Returns a list of the available DB engines.</p>"
},
"DescribeDBInstances":{
"name":"DescribeDBInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBInstancesMessage"},
"output":{
"shape":"DBInstanceMessage",
"resultWrapper":"DescribeDBInstancesResult"
},
"errors":[
{"shape":"DBInstanceNotFoundFault"}
],
"documentation":"<p>Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.</p>"
},
"DescribeDBSubnetGroups":{
"name":"DescribeDBSubnetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBSubnetGroupsMessage"},
"output":{
"shape":"DBSubnetGroupMessage",
"resultWrapper":"DescribeDBSubnetGroupsResult"
},
"errors":[
{"shape":"DBSubnetGroupNotFoundFault"}
],
"documentation":"<p>Returns a list of <code>DBSubnetGroup</code> descriptions. If a <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the specified <code>DBSubnetGroup</code>.</p>"
},
"DescribeEngineDefaultClusterParameters":{
"name":"DescribeEngineDefaultClusterParameters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEngineDefaultClusterParametersMessage"},
"output":{
"shape":"DescribeEngineDefaultClusterParametersResult",
"resultWrapper":"DescribeEngineDefaultClusterParametersResult"
},
"documentation":"<p>Returns the default engine and system parameter information for the cluster database engine.</p>"
},
"DescribeEventCategories":{
"name":"DescribeEventCategories",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventCategoriesMessage"},
"output":{
"shape":"EventCategoriesMessage",
"resultWrapper":"DescribeEventCategoriesResult"
},
"documentation":"<p>Displays a list of categories for all event source types, or, if specified, for a specified source type. </p>"
},
"DescribeEvents":{
"name":"DescribeEvents",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventsMessage"},
"output":{
"shape":"EventsMessage",
"resultWrapper":"DescribeEventsResult"
},
"documentation":"<p>Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB parameter group by providing the name as a parameter. By default, the events of the past hour are returned.</p>"
},
"DescribeOrderableDBInstanceOptions":{
"name":"DescribeOrderableDBInstanceOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"},
"output":{
"shape":"OrderableDBInstanceOptionsMessage",
"resultWrapper":"DescribeOrderableDBInstanceOptionsResult"
},
"documentation":"<p>Returns a list of orderable DB instance options for the specified engine.</p>"
},
"DescribePendingMaintenanceActions":{
"name":"DescribePendingMaintenanceActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribePendingMaintenanceActionsMessage"},
"output":{
"shape":"PendingMaintenanceActionsMessage",
"resultWrapper":"DescribePendingMaintenanceActionsResult"
},
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"<p>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.</p>"
},
"FailoverDBCluster":{
"name":"FailoverDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"FailoverDBClusterMessage"},
"output":{
"shape":"FailoverDBClusterResult",
"resultWrapper":"FailoverDBClusterResult"
},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
"documentation":"<p>Forces a failover for a DB cluster.</p> <p>A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).</p> <p>If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceMessage"},
"output":{
"shape":"TagListMessage",
"resultWrapper":"ListTagsForResourceResult"
},
"errors":[
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSnapshotNotFoundFault"},
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Lists all tags on an Amazon DocumentDB resource.</p>"
},
"ModifyDBCluster":{
"name":"ModifyDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBClusterMessage"},
"output":{
"shape":"ModifyDBClusterResult",
"resultWrapper":"ModifyDBClusterResult"
},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"InvalidDBSubnetGroupStateFault"},
{"shape":"InvalidSubnet"},
{"shape":"DBClusterParameterGroupNotFoundFault"},
{"shape":"InvalidDBSecurityGroupStateFault"},
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBClusterAlreadyExistsFault"}
],
"documentation":"<p>Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </p>"
},
"ModifyDBClusterParameterGroup":{
"name":"ModifyDBClusterParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBClusterParameterGroupMessage"},
"output":{
"shape":"DBClusterParameterGroupNameMessage",
"resultWrapper":"ModifyDBClusterParameterGroupResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"InvalidDBParameterGroupStateFault"}
],
"documentation":"<p> Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <note> <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.</p> </note> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
},
"ModifyDBClusterSnapshotAttribute":{
"name":"ModifyDBClusterSnapshotAttribute",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"},
"output":{
"shape":"ModifyDBClusterSnapshotAttributeResult",
"resultWrapper":"ModifyDBClusterSnapshotAttributeResult"
},
"errors":[
{"shape":"DBClusterSnapshotNotFoundFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"SharedSnapshotQuotaExceededFault"}
],
"documentation":"<p>Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.</p> <p>To share a manual DB cluster snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code>, and use the <code>ValuesToAdd</code> parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value <code>all</code> to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the <code>ValuesToAdd</code> parameter. You can't use <code>all</code> as a value for that parameter in this case.</p>"
},
"ModifyDBInstance":{
"name":"ModifyDBInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBInstanceMessage"},
"output":{
"shape":"ModifyDBInstanceResult",
"resultWrapper":"ModifyDBInstanceResult"
},
"errors":[
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"InvalidDBSecurityGroupStateFault"},
{"shape":"DBInstanceAlreadyExistsFault"},
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSecurityGroupNotFoundFault"},
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"InsufficientDBInstanceCapacityFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"DBUpgradeDependencyFailureFault"},
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"CertificateNotFoundFault"}
],
"documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.</p>"
},
"ModifyDBSubnetGroup":{
"name":"ModifyDBSubnetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBSubnetGroupMessage"},
"output":{
"shape":"ModifyDBSubnetGroupResult",
"resultWrapper":"ModifyDBSubnetGroupResult"
},
"errors":[
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"DBSubnetQuotaExceededFault"},
{"shape":"SubnetAlreadyInUse"},
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidSubnet"}
],
"documentation":"<p>Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.</p>"
},
"RebootDBInstance":{
"name":"RebootDBInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RebootDBInstanceMessage"},
"output":{
"shape":"RebootDBInstanceResult",
"resultWrapper":"RebootDBInstanceResult"
},
"errors":[
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBInstanceNotFoundFault"}
],
"documentation":"<p>You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to <i>rebooting</i>. </p>"
},
"RemoveTagsFromResource":{
"name":"RemoveTagsFromResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsFromResourceMessage"},
"errors":[
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSnapshotNotFoundFault"},
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Removes metadata tags from an Amazon DocumentDB resource.</p>"
},
"ResetDBClusterParameterGroup":{
"name":"ResetDBClusterParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetDBClusterParameterGroupMessage"},
"output":{
"shape":"DBClusterParameterGroupNameMessage",
"resultWrapper":"ResetDBClusterParameterGroupResult"
},
"errors":[
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p> Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. </p> <p> When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance reboot.</p>"
},
"RestoreDBClusterFromSnapshot":{
"name":"RestoreDBClusterFromSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreDBClusterFromSnapshotMessage"},
"output":{
"shape":"RestoreDBClusterFromSnapshotResult",
"resultWrapper":"RestoreDBClusterFromSnapshotResult"
},
"errors":[
{"shape":"DBClusterAlreadyExistsFault"},
{"shape":"DBClusterQuotaExceededFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"DBSnapshotNotFoundFault"},
{"shape":"DBClusterSnapshotNotFoundFault"},
{"shape":"InsufficientDBClusterCapacityFault"},
{"shape":"InsufficientStorageClusterCapacityFault"},
{"shape":"InvalidDBSnapshotStateFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"InvalidRestoreFault"},
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"InvalidSubnet"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.</p> <p>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.</p>"
},
"RestoreDBClusterToPointInTime":{
"name":"RestoreDBClusterToPointInTime",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreDBClusterToPointInTimeMessage"},
"output":{
"shape":"RestoreDBClusterToPointInTimeResult",
"resultWrapper":"RestoreDBClusterToPointInTimeResult"
},
"errors":[
{"shape":"DBClusterAlreadyExistsFault"},
{"shape":"DBClusterNotFoundFault"},
{"shape":"DBClusterQuotaExceededFault"},
{"shape":"DBClusterSnapshotNotFoundFault"},
{"shape":"DBSubnetGroupNotFoundFault"},
{"shape":"InsufficientDBClusterCapacityFault"},
{"shape":"InsufficientStorageClusterCapacityFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBSnapshotStateFault"},
{"shape":"InvalidRestoreFault"},
{"shape":"InvalidSubnet"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"StorageQuotaExceededFault"}
],
"documentation":"<p>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. </p>"
}
},
"shapes":{
"AddTagsToResourceMessage":{
"type":"structure",
"required":[
"ResourceName",
"Tags"
],
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN).</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the Amazon DocumentDB resource. </p>"
}
},
"documentation":"<p>Represents the input to <a>AddTagsToResource</a>.</p>"
},
"ApplyMethod":{
"type":"string",
"enum":[
"immediate",
"pending-reboot"
]
},
"ApplyPendingMaintenanceActionMessage":{
"type":"structure",
"required":[
"ResourceIdentifier",
"ApplyAction",
"OptInType"
],
"members":{
"ResourceIdentifier":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.</p>"
},
"ApplyAction":{
"shape":"String",
"documentation":"<p>The pending maintenance action to apply to this resource.</p> <p>Valid values: <code>system-update</code>, <code>db-upgrade</code> </p>"
},
"OptInType":{
"shape":"String",
"documentation":"<p>A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type <code>immediate</code> can't be undone.</p> <p>Valid values:</p> <ul> <li> <p> <code>immediate</code> - Apply the maintenance action immediately.</p> </li> <li> <p> <code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource.</p> </li> <li> <p> <code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>ApplyPendingMaintenanceAction</a>.</p>"
},
"ApplyPendingMaintenanceActionResult":{
"type":"structure",
"members":{
"ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"}
}
},
"AttributeValueList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"AttributeValue"
}
},
"AuthorizationNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified DB security group.</p> <p>Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.</p>",
"error":{
"code":"AuthorizationNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"AvailabilityZone":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the Availability Zone.</p>"
}
},
"documentation":"<p>Information about an Availability Zone.</p>",
"wrapper":true
},
"AvailabilityZoneList":{
"type":"list",
"member":{
"shape":"AvailabilityZone",
"locationName":"AvailabilityZone"
}
},
"AvailabilityZones":{
"type":"list",
"member":{
"shape":"String",
"locationName":"AvailabilityZone"
}
},
"Boolean":{"type":"boolean"},
"BooleanOptional":{"type":"boolean"},
"CertificateNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>CertificateIdentifier</code> doesn't refer to an existing certificate. </p>",
"error":{
"code":"CertificateNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"CloudwatchLogsExportConfiguration":{
"type":"structure",
"members":{
"EnableLogTypes":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types to enable.</p>"
},
"DisableLogTypes":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types to disable.</p>"
}
},
"documentation":"<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster.</p> <p>The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine that is being used.</p>"
},
"CopyDBClusterParameterGroupMessage":{
"type":"structure",
"required":[
"SourceDBClusterParameterGroupIdentifier",
"TargetDBClusterParameterGroupIdentifier",
"TargetDBClusterParameterGroupDescription"
],
"members":{
"SourceDBClusterParameterGroupIdentifier":{
"shape":"String",
"documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB cluster parameter group.</p> </li> <li> <p>If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier; for example, <code>my-db-cluster-param-group</code>, or a valid ARN.</p> </li> <li> <p>If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN; for example, <code>arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1</code>.</p> </li> </ul>"
},
"TargetDBClusterParameterGroupIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the copied DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot be null, empty, or blank.</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-param-group1</code> </p>"
},
"TargetDBClusterParameterGroupDescription":{
"shape":"String",
"documentation":"<p>A description for the copied DB cluster parameter group.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that are to be assigned to the parameter group.</p>"
}
},
"documentation":"<p>Represents the input to <a>CopyDBClusterParameterGroup</a>.</p>"
},
"CopyDBClusterParameterGroupResult":{
"type":"structure",
"members":{
"DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"}
}
},
"CopyDBClusterSnapshotMessage":{
"type":"structure",
"required":[
"SourceDBClusterSnapshotIdentifier",
"TargetDBClusterSnapshotIdentifier"
],
"members":{
"SourceDBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot to copy. This parameter is not case sensitive.</p> <p>You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
},
"TargetDBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot2</code> </p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. </p> <p>If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. </p> <p>If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted DB cluster snapshot to another AWS Region, set <code>KmsKeyId</code> to the AWS KMS key ID that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
},
"PreSignedUrl":{
"shape":"String",
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source DB cluster snapshot to copy. You must use the <code>PreSignedUrl</code> parameter when copying an encrypted DB cluster snapshot from another AWS Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the presigned URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115</code>.</p> </li> </ul>"
},
"CopyTags":{
"shape":"BooleanOptional",
"documentation":"<p>Set to <code>true</code> to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster snapshot.</p>"
}
},
"documentation":"<p>Represents the input to <a>CopyDBClusterSnapshot</a>.</p>"
},
"CopyDBClusterSnapshotResult":{
"type":"structure",
"members":{
"DBClusterSnapshot":{"shape":"DBClusterSnapshot"}
}
},
"CreateDBClusterMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"Engine"
],
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 1 to 35.</p> </li> </ul>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster</code> </p>"
},
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p> The name of the DB cluster parameter group to associate with this DB cluster.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of EC2 VPC security groups to associate with this DB cluster.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>A DB subnet group to associate with this DB cluster.</p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>The name of the database engine to be used for this DB cluster.</p> <p>Valid values: <code>docdb</code> </p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the instances in the DB cluster accept connections.</p>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>The name of the master user for the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 16 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot be a reserved word for the chosen database engine.</p> </li> </ul>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
"documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster.</p>"
},
"StorageEncrypted":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies whether the DB cluster is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for an encrypted DB cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If an encryption key is not specified in <code>KmsKeyId</code>:</p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is <code>true</code> and <code>ReplicationSourceIdentifier</code> is not specified, Amazon DocumentDB uses your default encryption key.</p> </li> </ul> <p>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p> <p>If you create a replica of an encrypted DB cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Represents the input to <a>CreateDBCluster</a>.</p>"
},
"CreateDBClusterParameterGroupMessage":{
"type":"structure",
"required":[
"DBClusterParameterGroupName",
"DBParameterGroupFamily",
"Description"
],
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The DB cluster parameter group family name.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description for the DB cluster parameter group.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster parameter group.</p>"
}
},
"documentation":"<p>Represents the input of <a>CreateDBClusterParameterGroup</a>.</p>"
},
"CreateDBClusterParameterGroupResult":{
"type":"structure",
"members":{
"DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"}
}
},
"CreateDBClusterResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"CreateDBClusterSnapshotMessage":{
"type":"structure",
"required":[
"DBClusterSnapshotIdentifier",
"DBClusterIdentifier"
],
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster to create a snapshot for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul> <p>Example: <code>my-cluster</code> </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster snapshot.</p>"
}
},
"documentation":"<p>Represents the input of <a>CreateDBClusterSnapshot</a>.</p>"
},
"CreateDBClusterSnapshotResult":{
"type":"structure",
"members":{
"DBClusterSnapshot":{"shape":"DBClusterSnapshot"}
}
},
"CreateDBInstanceMessage":{
"type":"structure",
"required":[
"DBInstanceIdentifier",
"DBInstanceClass",
"Engine",
"DBClusterIdentifier"
],
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The compute and memory capacity of the DB instance; for example, <code>db.m4.large</code>. </p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>The name of the database engine to be used for this instance.</p> <p>Valid value: <code>docdb</code> </p>"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p> The Amazon EC2 Availability Zone that the DB instance is created in.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.</p> <p> Example: <code>us-east-1d</code> </p> <p> Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the <code>MultiAZ</code> parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. </p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.</p> <p>Default: <code>true</code> </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB instance.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster that the instance will belong to.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p> <p>Default: 1</p> <p>Valid values: 0-15</p>"
}
},
"documentation":"<p>Represents the input to <a>CreateDBInstance</a>.</p>"
},
"CreateDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"CreateDBSubnetGroupMessage":{
"type":"structure",
"required":[
"DBSubnetGroupName",
"DBSubnetGroupDescription",
"SubnetIds"
],
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name for the DB subnet group. This value is stored as a lowercase string.</p> <p>Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
"documentation":"<p>The description for the DB subnet group.</p>"
},
"SubnetIds":{
"shape":"SubnetIdentifierList",
"documentation":"<p>The Amazon EC2 subnet IDs for the DB subnet group.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB subnet group.</p>"
}
},
"documentation":"<p>Represents the input to <a>CreateDBSubnetGroup</a>.</p>"
},
"CreateDBSubnetGroupResult":{
"type":"structure",
"members":{
"DBSubnetGroup":{"shape":"DBSubnetGroup"}
}
},
"DBCluster":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the number of days for which automatic DB snapshots are retained.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.</p>"
},
"DBClusterParameterGroup":{
"shape":"String",
"documentation":"<p>Specifies the name of the DB cluster parameter group for the DB cluster.</p>"
},
"DBSubnetGroup":{
"shape":"String",
"documentation":"<p>Specifies information on the subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Specifies the current state of this DB cluster.</p>"
},
"PercentProgress":{
"shape":"String",
"documentation":"<p>Specifies the progress of the operation as a percentage.</p>"
},
"EarliestRestorableTime":{
"shape":"TStamp",
"documentation":"<p>The earliest time to which a database can be restored with point-in-time restore.</p>"
},
"Endpoint":{
"shape":"String",
"documentation":"<p>Specifies the connection endpoint for the primary instance of the DB cluster.</p>"
},
"ReaderEndpoint":{
"shape":"String",
"documentation":"<p>The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load balances connections across the Amazon DocumentDB replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the DB cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your DB cluster. </p> <p>If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.</p>"
},
"MultiAZ":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB cluster has instances in multiple Availability Zones.</p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>Provides the name of the database engine to be used for this DB cluster.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>Indicates the database engine version.</p>"
},
"LatestRestorableTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the latest time to which a database can be restored with point-in-time restore.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the port that the database engine is listening on.</p>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>Contains the master user name for the DB cluster.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
"documentation":"<p>Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>. </p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>"
},
"DBClusterMembers":{
"shape":"DBClusterMemberList",
"documentation":"<p>Provides the list of instances that make up the DB cluster.</p>"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
"documentation":"<p>Provides a list of virtual private cloud (VPC) security groups that the DB cluster belongs to.</p>"
},
"HostedZoneId":{
"shape":"String",
"documentation":"<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB cluster is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB cluster.</p>"
},
"DbClusterResourceId":{
"shape":"String",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.</p>"
},
"DBClusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster.</p>"
},
"AssociatedRoles":{
"shape":"DBClusterRoles",
"documentation":"<p>Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.</p>"
},
"ClusterCreateTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB cluster is configured to export to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Detailed information about a DB cluster. </p>",
"wrapper":true
},
"DBClusterAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You already have a DB cluster with the given identifier.</p>",
"error":{
"code":"DBClusterAlreadyExistsFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBClusterList":{
"type":"list",
"member":{
"shape":"DBCluster",
"locationName":"DBCluster"
}
},
"DBClusterMember":{
"type":"structure",
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the instance identifier for this member of the DB cluster.</p>"
},
"IsClusterWriter":{
"shape":"Boolean",
"documentation":"<p>A value that is <code>true</code> if the cluster member is the primary instance for the DB cluster and <code>false</code> otherwise.</p>"
},
"DBClusterParameterGroupStatus":{
"shape":"String",
"documentation":"<p>Specifies the status of the DB cluster parameter group for this member of the DB cluster.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. </p>"
}
},
"documentation":"<p>Contains information about an instance that is part of a DB cluster.</p>",
"wrapper":true
},
"DBClusterMemberList":{
"type":"list",
"member":{
"shape":"DBClusterMember",
"locationName":"DBClusterMember"
}
},
"DBClusterMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBClusters":{
"shape":"DBClusterList",
"documentation":"<p>A list of DB clusters.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBClusters</a>.</p>"
},
"DBClusterNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster. </p>",
"error":{
"code":"DBClusterNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBClusterParameterGroup":{
"type":"structure",
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>Provides the name of the DB cluster parameter group.</p>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>Provides the customer-specified description for this DB cluster parameter group.</p>"
},
"DBClusterParameterGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster parameter group.</p>"
}
},
"documentation":"<p>Detailed information about a DB cluster parameter group. </p>",
"wrapper":true
},
"DBClusterParameterGroupDetails":{
"type":"structure",
"members":{
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>Provides a list of parameters for the DB cluster parameter group.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the output of <a>DBClusterParameterGroup</a>.</p>"
},
"DBClusterParameterGroupList":{
"type":"list",
"member":{
"shape":"DBClusterParameterGroup",
"locationName":"DBClusterParameterGroup"
}
},
"DBClusterParameterGroupNameMessage":{
"type":"structure",
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
}
},
"documentation":"<p>Contains the name of a DB cluster parameter group.</p>"
},
"DBClusterParameterGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB cluster parameter group. </p>",
"error":{
"code":"DBClusterParameterGroupNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBClusterParameterGroupsMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBClusterParameterGroups":{
"shape":"DBClusterParameterGroupList",
"documentation":"<p>A list of DB cluster parameter groups.</p>"
}
},
"documentation":"<p>Represents the output of <a>DBClusterParameterGroups</a>.</p>"
},
"DBClusterQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB cluster can't be created because you have reached the maximum allowed quota of DB clusters.</p>",
"error":{
"code":"DBClusterQuotaExceededFault",
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"DBClusterRole":{
"type":"structure",
"members":{
"RoleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Describes the state of association between the IAM role and the DB cluster. The <code>Status</code> property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - The IAM role ARN is being associated with the DB cluster.</p> </li> <li> <p> <code>INVALID</code> - The IAM role ARN is associated with the DB cluster, but the DB cluster cannot assume the IAM role to access other AWS services on your behalf.</p> </li> </ul>"
}
},
"documentation":"<p>Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.</p>"
},
"DBClusterRoles":{
"type":"list",
"member":{
"shape":"DBClusterRole",
"locationName":"DBClusterRole"
}
},
"DBClusterSnapshot":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.</p>"
},
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the identifier for the DB cluster snapshot.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.</p>"
},
"SnapshotCreateTime":{
"shape":"TStamp",
"documentation":"<p>Provides the time when the snapshot was taken, in UTC.</p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>Specifies the name of the database engine.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Specifies the status of this DB cluster snapshot.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the DB cluster was listening on at the time of the snapshot.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot.</p>"
},
"ClusterCreateTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>Provides the master user name for the DB cluster snapshot.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>Provides the version of the database engine for this DB cluster snapshot.</p>"
},
"SnapshotType":{
"shape":"String",
"documentation":"<p>Provides the type of the DB cluster snapshot.</p>"
},
"PercentProgress":{
"shape":"Integer",
"documentation":"<p>Specifies the percentage of the estimated data that has been transferred.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB cluster snapshot is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB cluster snapshot.</p>"
},
"DBClusterSnapshotArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster snapshot.</p>"
},
"SourceDBClusterSnapshotArn":{
"shape":"String",
"documentation":"<p>If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster snapshot; otherwise, a null value.</p>"
}
},
"documentation":"<p>Detailed information about a DB cluster snapshot. </p>",
"wrapper":true
},
"DBClusterSnapshotAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You already have a DB cluster snapshot with the given identifier.</p>",
"error":{
"code":"DBClusterSnapshotAlreadyExistsFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBClusterSnapshotAttribute":{
"type":"structure",
"members":{
"AttributeName":{
"shape":"String",
"documentation":"<p>The name of the manual DB cluster snapshot attribute.</p> <p>The attribute named <code>restore</code> refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot.</p>"
},
"AttributeValues":{
"shape":"AttributeValueList",
"documentation":"<p>The values for the manual DB cluster snapshot attribute.</p> <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of <code>all</code> is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.</p>"
}
},
"documentation":"<p>Contains the name and values of a manual DB cluster snapshot attribute.</p> <p>Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot.</p>"
},
"DBClusterSnapshotAttributeList":{
"type":"list",
"member":{
"shape":"DBClusterSnapshotAttribute",
"locationName":"DBClusterSnapshotAttribute"
}
},
"DBClusterSnapshotAttributesResult":{
"type":"structure",
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot that the attributes apply to.</p>"
},
"DBClusterSnapshotAttributes":{
"shape":"DBClusterSnapshotAttributeList",
"documentation":"<p>The list of attributes and values for the DB cluster snapshot.</p>"
}
},
"documentation":"<p>Detailed information about the attributes that are associated with a DB cluster snapshot.</p>",
"wrapper":true
},
"DBClusterSnapshotList":{
"type":"list",
"member":{
"shape":"DBClusterSnapshot",
"locationName":"DBClusterSnapshot"
}
},
"DBClusterSnapshotMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBClusterSnapshots":{
"shape":"DBClusterSnapshotList",
"documentation":"<p>Provides a list of DB cluster snapshots.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBClusterSnapshots</a>.</p>"
},
"DBClusterSnapshotNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot. </p>",
"error":{
"code":"DBClusterSnapshotNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBEngineVersion":{
"type":"structure",
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The name of the database engine.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine.</p>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group family for the database engine.</p>"
},
"DBEngineDescription":{
"shape":"String",
"documentation":"<p>The description of the database engine.</p>"
},
"DBEngineVersionDescription":{
"shape":"String",
"documentation":"<p>The description of the database engine version.</p>"
},
"ValidUpgradeTarget":{
"shape":"ValidUpgradeTargetList",
"documentation":"<p>A list of engine versions that this database engine version can be upgraded to.</p>"
},
"ExportableLogTypes":{
"shape":"LogTypeList",
"documentation":"<p>The types of logs that the database engine has available for export to Amazon CloudWatch Logs.</p>"
},
"SupportsLogExportsToCloudwatchLogs":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the engine version supports exporting the log types specified by <code>ExportableLogTypes</code> to CloudWatch Logs.</p>"
}
},
"documentation":"<p> Detailed information about a DB engine version. </p>"
},
"DBEngineVersionList":{
"type":"list",
"member":{
"shape":"DBEngineVersion",
"locationName":"DBEngineVersion"
}
},
"DBEngineVersionMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBEngineVersions":{
"shape":"DBEngineVersionList",
"documentation":"<p>Detailed information about one or more DB engine versions.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBEngineVersions</a>.</p>"
},
"DBInstance":{
"type":"structure",
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>Contains a user-provided database identifier. This identifier is the unique key that identifies a DB instance.</p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>Contains the name of the compute and memory capacity class of the DB instance.</p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>Provides the name of the database engine to be used for this DB instance.</p>"
},
"DBInstanceStatus":{
"shape":"String",
"documentation":"<p>Specifies the current state of this database.</p>"
},
"Endpoint":{
"shape":"Endpoint",
"documentation":"<p>Specifies the connection endpoint.</p>"
},
"InstanceCreateTime":{
"shape":"TStamp",
"documentation":"<p>Provides the date and time that the DB instance was created.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
"documentation":"<p> Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>. </p>"
},
"BackupRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>Specifies the number of days for which automatic DB snapshots are retained.</p>"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
"documentation":"<p>Provides a list of VPC security group elements that the DB instance belongs to.</p>"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>Specifies the name of the Availability Zone that the DB instance is located in.</p>"
},
"DBSubnetGroup":{
"shape":"DBSubnetGroup",
"documentation":"<p>Specifies information on the subnet group that is associated with the DB instance, including the name, description, and subnets in the subnet group.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>"
},
"PendingModifiedValues":{
"shape":"PendingModifiedValues",
"documentation":"<p>Specifies that changes to the DB instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.</p>"
},
"LatestRestorableTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the latest time to which a database can be restored with point-in-time restore.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>Indicates the database engine version.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>Indicates that minor version patches are applied automatically.</p>"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>Specifies the availability options for the DB instance. A value of <code>true</code> specifies an internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of <code>false</code> specifies an internal instance with a DNS name that resolves to a private IP address.</p>"
},
"StatusInfos":{
"shape":"DBInstanceStatusInfoList",
"documentation":"<p>The status of a read replica. If the instance is not a read replica, this is blank.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>Contains the name of the DB cluster that the DB instance is a member of if the DB instance is a member of a DB cluster.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB instance is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p> If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB instance. </p>"
},
"DbiResourceId":{
"shape":"String",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p>"
},
"DBInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB instance.</p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB instance is configured to export to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Detailed information about a DB instance. </p>",
"wrapper":true
},
"DBInstanceAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You already have a DB instance with the given identifier.</p>",
"error":{
"code":"DBInstanceAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBInstanceList":{
"type":"list",
"member":{
"shape":"DBInstance",
"locationName":"DBInstance"
}
},
"DBInstanceMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBInstances":{
"shape":"DBInstanceList",
"documentation":"<p>Detailed information about one or more DB instances. </p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBInstances</a>.</p>"
},
"DBInstanceNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance. </p>",
"error":{
"code":"DBInstanceNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBInstanceStatusInfo":{
"type":"structure",
"members":{
"StatusType":{
"shape":"String",
"documentation":"<p>This value is currently \"<code>read replication</code>.\"</p>"
},
"Normal":{
"shape":"Boolean",
"documentation":"<p>A Boolean value that is <code>true</code> if the instance is operating normally, or <code>false</code> if the instance is in an error state.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Status of the DB instance. For a <code>StatusType</code> of read replica, the values can be <code>replicating</code>, error, <code>stopped</code>, or <code>terminated</code>.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.</p>"
}
},
"documentation":"<p>Provides a list of status information for a DB instance.</p>"
},
"DBInstanceStatusInfoList":{
"type":"list",
"member":{
"shape":"DBInstanceStatusInfo",
"locationName":"DBInstanceStatusInfo"
}
},
"DBParameterGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>A DB parameter group with the same name already exists.</p>",
"error":{
"code":"DBParameterGroupAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBParameterGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group. </p>",
"error":{
"code":"DBParameterGroupNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBParameterGroupQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>This request would cause you to exceed the allowed number of DB parameter groups.</p>",
"error":{
"code":"DBParameterGroupQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBSecurityGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group. </p>",
"error":{
"code":"DBSecurityGroupNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBSnapshotAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSnapshotIdentifier</code> is already being used by an existing snapshot. </p>",
"error":{
"code":"DBSnapshotAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBSnapshotNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot. </p>",
"error":{
"code":"DBSnapshotNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBSubnetGroup":{
"type":"structure",
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB subnet group.</p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
"documentation":"<p>Provides the description of the DB subnet group.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>Provides the virtual private cloud (VPC) ID of the DB subnet group.</p>"
},
"SubnetGroupStatus":{
"shape":"String",
"documentation":"<p>Provides the status of the DB subnet group.</p>"
},
"Subnets":{
"shape":"SubnetList",
"documentation":"<p>Detailed information about one or more subnets within a DB subnet group.</p>"
},
"DBSubnetGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Identifier (ARN) for the DB subnet group.</p>"
}
},
"documentation":"<p>Detailed information about a DB subnet group. </p>",
"wrapper":true
},
"DBSubnetGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSubnetGroupName</code> is already being used by an existing DB subnet group. </p>",
"error":{
"code":"DBSubnetGroupAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBSubnetGroupDoesNotCoverEnoughAZs":{
"type":"structure",
"members":{
},
"documentation":"<p>Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>",
"error":{
"code":"DBSubnetGroupDoesNotCoverEnoughAZs",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBSubnetGroupMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DBSubnetGroups":{
"shape":"DBSubnetGroups",
"documentation":"<p>Detailed information about one or more DB subnet groups.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBSubnetGroups</a>.</p>"
},
"DBSubnetGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group. </p>",
"error":{
"code":"DBSubnetGroupNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBSubnetGroupQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of DB subnet groups.</p>",
"error":{
"code":"DBSubnetGroupQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBSubnetGroups":{
"type":"list",
"member":{
"shape":"DBSubnetGroup",
"locationName":"DBSubnetGroup"
}
},
"DBSubnetQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of subnets in a DB subnet group.</p>",
"error":{
"code":"DBSubnetQuotaExceededFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBUpgradeDependencyFailureFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB upgrade failed because a resource that the DB depends on can't be modified.</p>",
"error":{
"code":"DBUpgradeDependencyFailure",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DeleteDBClusterMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match an existing <code>DBClusterIdentifier</code>.</p> </li> </ul>"
},
"SkipFinalSnapshot":{
"shape":"Boolean",
"documentation":"<p> Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If <code>true</code> is specified, no DB cluster snapshot is created. If <code>false</code> is specified, a DB cluster snapshot is created before the DB cluster is deleted. </p> <note> <p>If <code>SkipFinalSnapshot</code> is <code>false</code>, you must specify a <code>FinalDBSnapshotIdentifier</code> parameter.</p> </note> <p>Default: <code>false</code> </p>"
},
"FinalDBSnapshotIdentifier":{
"shape":"String",
"documentation":"<p> The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. </p> <note> <p> Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to <code>true</code> results in an error. </p> </note> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBCluster</a>.</p>"
},
"DeleteDBClusterParameterGroupMessage":{
"type":"structure",
"required":["DBClusterParameterGroupName"],
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing DB cluster parameter group.</p> </li> <li> <p>You can't delete a default DB cluster parameter group.</p> </li> <li> <p>Cannot be associated with any DB clusters.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBClusterParameterGroup</a>.</p>"
},
"DeleteDBClusterResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"DeleteDBClusterSnapshotMessage":{
"type":"structure",
"required":["DBClusterSnapshotIdentifier"],
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot to delete.</p> <p>Constraints: Must be the name of an existing DB cluster snapshot in the <code>available</code> state.</p>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBClusterSnapshot</a>.</p>"
},
"DeleteDBClusterSnapshotResult":{
"type":"structure",
"members":{
"DBClusterSnapshot":{"shape":"DBClusterSnapshot"}
}
},
"DeleteDBInstanceMessage":{
"type":"structure",
"required":["DBInstanceIdentifier"],
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing DB instance.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBInstance</a>.</p>"
},
"DeleteDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"DeleteDBSubnetGroupMessage":{
"type":"structure",
"required":["DBSubnetGroupName"],
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the database subnet group to delete.</p> <note> <p>You can't delete the default subnet group.</p> </note> <p>Constraints:</p> <p>Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBSubnetGroup</a>.</p>"
},
"DescribeDBClusterParameterGroupsMessage":{
"type":"structure",
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a specific DB cluster parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusterParameterGroups</a>.</p>"
},
"DescribeDBClusterParametersMessage":{
"type":"structure",
"required":["DBClusterParameterGroupName"],
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a specific DB cluster parameter group to return parameter details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>"
},
"Source":{
"shape":"String",
"documentation":"<p> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>. </p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusterParameters</a>.</p>"
},
"DescribeDBClusterSnapshotAttributesMessage":{
"type":"structure",
"required":["DBClusterSnapshotIdentifier"],
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the DB cluster snapshot to describe the attributes for.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusterSnapshotAttributes</a>.</p>"
},
"DescribeDBClusterSnapshotAttributesResult":{
"type":"structure",
"members":{
"DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"}
}
},
"DescribeDBClusterSnapshotsMessage":{
"type":"structure",
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>A specific DB cluster snapshot identifier to describe. This parameter can't be used with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBClusterSnapshot</code>.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
},
"SnapshotType":{
"shape":"String",
"documentation":"<p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p> <ul> <li> <p> <code>automated</code> - Return all DB cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.</p> </li> <li> <p> <code>manual</code> - Return all DB cluster snapshots that you have manually created for your AWS account.</p> </li> <li> <p> <code>shared</code> - Return all manual DB cluster snapshots that have been shared to your AWS account.</p> </li> <li> <p> <code>public</code> - Return all DB cluster snapshots that have been marked as public.</p> </li> </ul> <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public DB cluster snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>.</p> <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"IncludeShared":{
"shape":"Boolean",
"documentation":"<p>Set to <code>true</code> to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
},
"IncludePublic":{
"shape":"Boolean",
"documentation":"<p>Set to <code>true</code> to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusterSnapshots</a>.</p>"
},
"DescribeDBClustersMessage":{
"type":"structure",
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The user-provided DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBClusterIdentifier</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusters</a>.</p>"
},
"DescribeDBEngineVersionsMessage":{
"type":"structure",
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The database engine to return.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The database engine version to return.</p> <p>Example: <code>5.1.49</code> </p>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of a specific DB parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBParameterGroupFamily</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"DefaultOnly":{
"shape":"Boolean",
"documentation":"<p>Indicates that only the default version of the specified engine or engine and major version combination is returned.</p>"
},
"ListSupportedCharacterSets":{
"shape":"BooleanOptional",
"documentation":"<p>If this parameter is specified and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version. </p>"
},
"ListSupportedTimezones":{
"shape":"BooleanOptional",
"documentation":"<p>If this parameter is specified and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version. </p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBEngineVersions</a>.</p>"
},
"DescribeDBInstancesMessage":{
"type":"structure",
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The user-provided instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only the information about the DB instances that are associated with the DB clusters that are identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list includes only the information about the DB instances that are identified by these ARNs.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBInstances</a>.</p>"
},
"DescribeDBSubnetGroupsMessage":{
"type":"structure",
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB subnet group to return details for.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBSubnetGroups</a>.</p>"
},
"DescribeEngineDefaultClusterParametersMessage":{
"type":"structure",
"required":["DBParameterGroupFamily"],
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group family to return the engine parameter information for.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeEngineDefaultClusterParameters</a>.</p>"
},
"DescribeEngineDefaultClusterParametersResult":{
"type":"structure",
"members":{
"EngineDefaults":{"shape":"EngineDefaults"}
}
},
"DescribeEventCategoriesMessage":{
"type":"structure",
"members":{
"SourceType":{
"shape":"String",
"documentation":"<p>The type of source that is generating the events.</p> <p>Valid values: <code>db-instance</code>, <code>db-parameter-group</code>, <code>db-security-group</code>, <code>db-snapshot</code> </p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeEventCategories</a>.</p>"
},
"DescribeEventsMessage":{
"type":"structure",
"members":{
"SourceIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.</p> <p>Constraints:</p> <ul> <li> <p>If <code>SourceIdentifier</code> is provided, <code>SourceType</code> must also be provided.</p> </li> <li> <p>If the source type is <code>DBInstance</code>, a <code>DBInstanceIdentifier</code> must be provided.</p> </li> <li> <p>If the source type is <code>DBSecurityGroup</code>, a <code>DBSecurityGroupName</code> must be provided.</p> </li> <li> <p>If the source type is <code>DBParameterGroup</code>, a <code>DBParameterGroupName</code> must be provided.</p> </li> <li> <p>If the source type is <code>DBSnapshot</code>, a <code>DBSnapshotIdentifier</code> must be provided.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"SourceType":{
"shape":"SourceType",
"documentation":"<p>The event source to retrieve events for. If no value is specified, all events are returned.</p>"
},
"StartTime":{
"shape":"TStamp",
"documentation":"<p> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. </p> <p>Example: 2009-07-08T18:00Z</p>"
},
"EndTime":{
"shape":"TStamp",
"documentation":"<p> The end of the time interval for which to retrieve events, specified in ISO 8601 format. </p> <p>Example: 2009-07-08T18:00Z</p>"
},
"Duration":{
"shape":"IntegerOptional",
"documentation":"<p>The number of minutes to retrieve events for.</p> <p>Default: 60</p>"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"<p>A list of event categories that trigger notifications for an event notification subscription.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeEvents</a>.</p>"
},
"DescribeOrderableDBInstanceOptionsMessage":{
"type":"structure",
"required":["Engine"],
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The name of the engine to retrieve DB instance options for.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.</p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The DB instance class filter value. Specify this parameter to show only the available offerings that match the specified DB instance class.</p>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.</p>"
},
"Vpc":{
"shape":"BooleanOptional",
"documentation":"<p>The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeOrderableDBInstanceOptions</a>.</p>"
},
"DescribePendingMaintenanceActionsMessage":{
"type":"structure",
"members":{
"ResourceIdentifier":{
"shape":"String",
"documentation":"<p>The ARN of a resource to return pending maintenance actions for.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribePendingMaintenanceActions</a>.</p>"
},
"Endpoint":{
"type":"structure",
"members":{
"Address":{
"shape":"String",
"documentation":"<p>Specifies the DNS address of the DB instance.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the database engine is listening on.</p>"
},
"HostedZoneId":{
"shape":"String",
"documentation":"<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"
}
},
"documentation":"<p>Network information for accessing a DB cluster or DB instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.</p>"
},
"EngineDefaults":{
"type":"structure",
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group family to return the engine parameter information for.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>The parameters of a particular DB cluster parameter group family.</p>"
}
},
"documentation":"<p>Contains the result of a successful invocation of the <code>DescribeEngineDefaultClusterParameters</code> operation. </p>",
"wrapper":true
},
"Event":{
"type":"structure",
"members":{
"SourceIdentifier":{
"shape":"String",
"documentation":"<p>Provides the identifier for the source of the event.</p>"
},
"SourceType":{
"shape":"SourceType",
"documentation":"<p>Specifies the source type for this event.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>Provides the text of this event.</p>"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"<p>Specifies the category for the event.</p>"
},
"Date":{
"shape":"TStamp",
"documentation":"<p>Specifies the date and time of the event.</p>"
},
"SourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the event.</p>"
}
},
"documentation":"<p>Detailed information about an event.</p>"
},
"EventCategoriesList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"EventCategory"
}
},
"EventCategoriesMap":{
"type":"structure",
"members":{
"SourceType":{
"shape":"String",
"documentation":"<p>The source type that the returned categories belong to.</p>"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"<p>The event categories for the specified source type.</p>"
}
},
"documentation":"<p>An event source type, accompanied by one or more event category names.</p>",
"wrapper":true
},
"EventCategoriesMapList":{
"type":"list",
"member":{
"shape":"EventCategoriesMap",
"locationName":"EventCategoriesMap"
}
},
"EventCategoriesMessage":{
"type":"structure",
"members":{
"EventCategoriesMapList":{
"shape":"EventCategoriesMapList",
"documentation":"<p>A list of event category maps.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeEventCategories</a>.</p>"
},
"EventList":{
"type":"list",
"member":{
"shape":"Event",
"locationName":"Event"
}
},
"EventsMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
},
"Events":{
"shape":"EventList",
"documentation":"<p>Detailed information about one or more events. </p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeEvents</a>.</p>"
},
"FailoverDBClusterMessage":{
"type":"structure",
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>A DB cluster identifier to force a failover for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"TargetDBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The name of the instance to promote to the primary instance.</p> <p>You must specify the instance identifier for an Amazon DocumentDB replica in the DB cluster. For example, <code>mydbcluster-replica1</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>FailoverDBCluster</a>.</p>"
},
"FailoverDBClusterResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"Filter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the filter. Filter names are case sensitive.</p>"
},
"Values":{
"shape":"FilterValueList",
"documentation":"<p>One or more filter values. Filter values are case sensitive.</p>"
}
},
"documentation":"<p>A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.</p> <p>Wildcards are not supported in filters.</p>"
},
"FilterList":{
"type":"list",
"member":{
"shape":"Filter",
"locationName":"Filter"
}
},
"FilterValueList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"Value"
}
},
"InstanceQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of DB instances.</p>",
"error":{
"code":"InstanceQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InsufficientDBClusterCapacityFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB cluster doesn't have enough capacity for the current operation.</p>",
"error":{
"code":"InsufficientDBClusterCapacityFault",
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"InsufficientDBInstanceCapacityFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified DB instance class isn't available in the specified Availability Zone.</p>",
"error":{
"code":"InsufficientDBInstanceCapacity",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InsufficientStorageClusterCapacityFault":{
"type":"structure",
"members":{
},
"documentation":"<p>There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </p>",
"error":{
"code":"InsufficientStorageClusterCapacity",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"Integer":{"type":"integer"},
"IntegerOptional":{"type":"integer"},
"InvalidDBClusterSnapshotStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The provided value isn't a valid DB cluster snapshot state.</p>",
"error":{
"code":"InvalidDBClusterSnapshotStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBClusterStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB cluster isn't in a valid state.</p>",
"error":{
"code":"InvalidDBClusterStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBInstanceStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p> The specified DB instance isn't in the <i>available</i> state. </p>",
"error":{
"code":"InvalidDBInstanceState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBParameterGroupStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.</p>",
"error":{
"code":"InvalidDBParameterGroupState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSecurityGroupStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The state of the DB security group doesn't allow deletion.</p>",
"error":{
"code":"InvalidDBSecurityGroupState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSnapshotStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The state of the DB snapshot doesn't allow deletion.</p>",
"error":{
"code":"InvalidDBSnapshotState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSubnetGroupStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet group can't be deleted because it's in use.</p>",
"error":{
"code":"InvalidDBSubnetGroupStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSubnetStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p> The DB subnet isn't in the <i>available</i> state. </p>",
"error":{
"code":"InvalidDBSubnetStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidRestoreFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.</p>",
"error":{
"code":"InvalidRestoreFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidSubnet":{
"type":"structure",
"members":{
},
"documentation":"<p>The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).</p>",
"error":{
"code":"InvalidSubnet",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidVPCNetworkStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet group doesn't cover all Availability Zones after it is created because of changes that were made.</p>",
"error":{
"code":"InvalidVPCNetworkStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"KMSKeyNotAccessibleFault":{
"type":"structure",
"members":{
},
"documentation":"<p>An error occurred when accessing an AWS KMS key.</p>",
"error":{
"code":"KMSKeyNotAccessibleFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"KeyList":{
"type":"list",
"member":{"shape":"String"}
},
"ListTagsForResourceMessage":{
"type":"structure",
"required":["ResourceName"],
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
}
},
"documentation":"<p>Represents the input to <a>ListTagsForResource</a>.</p>"
},
"LogTypeList":{
"type":"list",
"member":{"shape":"String"}
},
"ModifyDBClusterMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"NewDBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>"
},
"ApplyImmediately":{
"shape":"Boolean",
"documentation":"<p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB cluster. If this parameter is set to <code>false</code>, changes to the DB cluster are applied during the next maintenance window.</p> <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>Default: <code>false</code> </p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 1 to 35.</p> </li> </ul>"
},
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to use for the DB cluster.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of virtual private cloud (VPC) security groups that the DB cluster will belong to.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the DB cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The same port as the original DB cluster.</p>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>The new password for the master database user. This password can contain any printable ASCII character except \"<code>/</code>\", \"<code>\"</code>\", or \"<code>@</code>\".</p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
"documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. </p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</p>"
},
"CloudwatchLogsExportConfiguration":{
"shape":"CloudwatchLogsExportConfiguration",
"documentation":"<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBCluster</a>.</p>"
},
"ModifyDBClusterParameterGroupMessage":{
"type":"structure",
"required":[
"DBClusterParameterGroupName",
"Parameters"
],
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to modify.</p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>A list of parameters in the DB cluster parameter group to modify.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBClusterParameterGroup</a>.</p>"
},
"ModifyDBClusterResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"ModifyDBClusterSnapshotAttributeMessage":{
"type":"structure",
"required":[
"DBClusterSnapshotIdentifier",
"AttributeName"
],
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the DB cluster snapshot to modify the attributes for.</p>"
},
"AttributeName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster snapshot attribute to modify.</p> <p>To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to <code>restore</code>.</p>"
},
"ValuesToAdd":{
"shape":"AttributeValueList",
"documentation":"<p>A list of DB cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>.</p> <p>To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs. To make the manual DB cluster snapshot restorable by any AWS account, set it to <code>all</code>. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want to be available to all AWS accounts.</p>"
},
"ValuesToRemove":{
"shape":"AttributeValueList",
"documentation":"<p>A list of DB cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>.</p> <p>To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the DB cluster snapshot, set it to <code>all</code> . If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore a manual DB cluster snapshot.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBClusterSnapshotAttribute</a>.</p>"
},
"ModifyDBClusterSnapshotAttributeResult":{
"type":"structure",
"members":{
"DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"}
}
},
"ModifyDBInstanceMessage":{
"type":"structure",
"required":["DBInstanceIdentifier"],
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The new compute and memory capacity of the DB instance; for example, <code>db.m4.large</code>. Not all DB instance classes are available in all AWS Regions. </p> <p>If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless <code>ApplyImmediately</code> is specified as <code>true</code> for this request. </p> <p>Default: Uses existing setting.</p>"
},
"ApplyImmediately":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. </p> <p> If this parameter is set to <code>false</code>, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.</p> <p>Default: <code>false</code> </p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.</p> <p>Default: Uses existing setting.</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Must be at least 30 minutes.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version. </p>"
},
"NewDBInstanceIdentifier":{
"shape":"String",
"documentation":"<p> The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you set <code>Apply Immediately</code> to <code>true</code>. It occurs during the next maintenance window if you set <code>Apply Immediately</code> to <code>false</code>. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p> <p>Default: 1</p> <p>Valid values: 0-15</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBInstance</a>.</p>"
},
"ModifyDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"ModifyDBSubnetGroupMessage":{
"type":"structure",
"required":[
"DBSubnetGroupName",
"SubnetIds"
],
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. </p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
"documentation":"<p>The description for the DB subnet group.</p>"
},
"SubnetIds":{
"shape":"SubnetIdentifierList",
"documentation":"<p>The Amazon EC2 subnet IDs for the DB subnet group.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBSubnetGroup</a>.</p>"
},
"ModifyDBSubnetGroupResult":{
"type":"structure",
"members":{
"DBSubnetGroup":{"shape":"DBSubnetGroup"}
}
},
"OrderableDBInstanceOption":{
"type":"structure",
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The engine type of a DB instance.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The engine version of a DB instance.</p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The DB instance class for a DB instance.</p>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>The license model for a DB instance.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZoneList",
"documentation":"<p>A list of Availability Zones for a DB instance.</p>"
},
"Vpc":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance is in a virtual private cloud (VPC).</p>"
}
},
"documentation":"<p>The options that are available for a DB instance.</p>",
"wrapper":true
},
"OrderableDBInstanceOptionsList":{
"type":"list",
"member":{
"shape":"OrderableDBInstanceOption",
"locationName":"OrderableDBInstanceOption"
}
},
"OrderableDBInstanceOptionsMessage":{
"type":"structure",
"members":{
"OrderableDBInstanceOptions":{
"shape":"OrderableDBInstanceOptionsList",
"documentation":"<p>The options that are available for a particular orderable DB instance.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeOrderableDBInstanceOptions</a>.</p>"
},
"Parameter":{
"type":"structure",
"members":{
"ParameterName":{
"shape":"String",
"documentation":"<p>Specifies the name of the parameter.</p>"
},
"ParameterValue":{
"shape":"String",
"documentation":"<p>Specifies the value of the parameter.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>Provides a description of the parameter.</p>"
},
"Source":{
"shape":"String",
"documentation":"<p>Indicates the source of the parameter value.</p>"
},
"ApplyType":{
"shape":"String",
"documentation":"<p>Specifies the engine-specific parameters type.</p>"
},
"DataType":{
"shape":"String",
"documentation":"<p>Specifies the valid data type for the parameter.</p>"
},
"AllowedValues":{
"shape":"String",
"documentation":"<p>Specifies the valid range of values for the parameter.</p>"
},
"IsModifiable":{
"shape":"Boolean",
"documentation":"<p> Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </p>"
},
"MinimumEngineVersion":{
"shape":"String",
"documentation":"<p>The earliest engine version to which the parameter can apply.</p>"
},
"ApplyMethod":{
"shape":"ApplyMethod",
"documentation":"<p>Indicates when to apply parameter updates.</p>"
}
},
"documentation":"<p>Detailed information about an individual parameter.</p>"
},
"ParametersList":{
"type":"list",
"member":{
"shape":"Parameter",
"locationName":"Parameter"
}
},
"PendingCloudwatchLogsExports":{
"type":"structure",
"members":{
"LogTypesToEnable":{
"shape":"LogTypeList",
"documentation":"<p>Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.</p>"
},
"LogTypesToDisable":{
"shape":"LogTypeList",
"documentation":"<p>Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.</p>"
},
"PendingMaintenanceAction":{
"type":"structure",
"members":{
"Action":{
"shape":"String",
"documentation":"<p>The type of pending maintenance action that is available for the resource.</p>"
},
"AutoAppliedAfterDate":{
"shape":"TStamp",
"documentation":"<p>The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any <code>next-maintenance</code> opt-in requests are ignored.</p>"
},
"ForcedApplyDate":{
"shape":"TStamp",
"documentation":"<p>The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any <code>immediate</code> opt-in requests are ignored.</p>"
},
"OptInStatus":{
"shape":"String",
"documentation":"<p>Indicates the type of opt-in request that has been received for the resource.</p>"
},
"CurrentApplyDate":{
"shape":"TStamp",
"documentation":"<p>The effective date when the pending maintenance action is applied to the resource.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>A description providing more detail about the maintenance action.</p>"
}
},
"documentation":"<p>Provides information about a pending maintenance action for a resource.</p>"
},
"PendingMaintenanceActionDetails":{
"type":"list",
"member":{
"shape":"PendingMaintenanceAction",
"locationName":"PendingMaintenanceAction"
}
},
"PendingMaintenanceActions":{
"type":"list",
"member":{
"shape":"ResourcePendingMaintenanceActions",
"locationName":"ResourcePendingMaintenanceActions"
}
},
"PendingMaintenanceActionsMessage":{
"type":"structure",
"members":{
"PendingMaintenanceActions":{
"shape":"PendingMaintenanceActions",
"documentation":"<p>The maintenance actions to be applied.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribePendingMaintenanceActions</a>.</p>"
},
"PendingModifiedValues":{
"type":"structure",
"members":{
"DBInstanceClass":{
"shape":"String",
"documentation":"<p> Contains the new <code>DBInstanceClass</code> for the DB instance that will be applied or is currently being applied. </p>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p> Contains the new <code>AllocatedStorage</code> size for the DB instance that will be applied or is currently being applied. </p>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>Contains the pending or currently in-progress change of the master credentials for the DB instance.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the pending port for the DB instance.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the pending number of days for which automated backups are retained.</p>"
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>Indicates the database engine version.</p>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>The license model for the DB instance.</p> <p>Valid values: <code>license-included</code>, <code>bring-your-own-license</code>, <code>general-public-license</code> </p>"
},
"Iops":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.</p>"
},
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p> Contains the new <code>DBInstanceIdentifier</code> for the DB instance that will be applied or is currently being applied. </p>"
},
"StorageType":{
"shape":"String",
"documentation":"<p>Specifies the storage type to be associated with the DB instance.</p>"
},
"CACertificateIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the identifier of the certificate authority (CA) certificate for the DB instance.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The new DB subnet group for the DB instance. </p>"
},
"PendingCloudwatchLogsExports":{
"shape":"PendingCloudwatchLogsExports",
"documentation":"<p>A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.</p>"
}
},
"documentation":"<p> One or more modified settings for a DB instance. These modified settings have been requested, but haven't been applied yet.</p>"
},
"RebootDBInstanceMessage":{
"type":"structure",
"required":["DBInstanceIdentifier"],
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
},
"ForceFailover":{
"shape":"BooleanOptional",
"documentation":"<p> When <code>true</code>, the reboot is conducted through a Multi-AZ failover. </p> <p>Constraint: You can't specify <code>true</code> if the instance is not configured for Multi-AZ.</p>"
}
},
"documentation":"<p>Represents the input to <a>RebootDBInstance</a>.</p>"
},
"RebootDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"RemoveTagsFromResourceMessage":{
"type":"structure",
"required":[
"ResourceName",
"TagKeys"
],
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).</p>"
},
"TagKeys":{
"shape":"KeyList",
"documentation":"<p>The tag key (name) of the tag to be removed.</p>"
}
},
"documentation":"<p>Represents the input to <a>RemoveTagsFromResource</a>.</p>"
},
"ResetDBClusterParameterGroupMessage":{
"type":"structure",
"required":["DBClusterParameterGroupName"],
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to reset.</p>"
},
"ResetAllParameters":{
"shape":"Boolean",
"documentation":"<p>A value that is set to <code>true</code> to reset all parameters in the DB cluster parameter group to their default values, and <code>false</code> otherwise. You can't use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>ResetDBClusterParameterGroup</a>.</p>"
},
"ResourceNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified resource ID was not found.</p>",
"error":{
"code":"ResourceNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ResourcePendingMaintenanceActions":{
"type":"structure",
"members":{
"ResourceIdentifier":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.</p>"
},
"PendingMaintenanceActionDetails":{
"shape":"PendingMaintenanceActionDetails",
"documentation":"<p>A list that provides details about the pending maintenance actions for the resource.</p>"
}
},
"documentation":"<p>Represents the output of <a>ApplyPendingMaintenanceAction</a>.</p>",
"wrapper":true
},
"RestoreDBClusterFromSnapshotMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"SnapshotIdentifier",
"Engine"
],
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-snapshot-id</code> </p>"
},
"SnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the DB snapshot or DB cluster snapshot to restore from.</p> <p>You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing snapshot.</p> </li> </ul>"
},
"Engine":{
"shape":"String",
"documentation":"<p>The database engine to use for the new DB cluster.</p> <p>Default: The same as source.</p> <p>Constraint: Must be compatible with the engine of the source.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version of the database engine to use for the new DB cluster.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the new DB cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p> <p>Default: The same port as the original DB cluster.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB subnet group to use for the new DB cluster.</p> <p>Constraints: If provided, must match the name of an existing <code>DBSubnetGroup</code>.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of virtual private cloud (VPC) security groups that the new DB cluster will belong to.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the restored DB cluster.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p> <ul> <li> <p>If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the DB snapshot or the DB cluster snapshot.</p> </li> <li> <p>If the DB snapshot or the DB cluster snapshot in <code>SnapshotIdentifier</code> is not encrypted, then the restored DB cluster is not encrypted.</p> </li> </ul>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Represents the input to <a>RestoreDBClusterFromSnapshot</a>.</p>"
},
"RestoreDBClusterFromSnapshotResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"RestoreDBClusterToPointInTimeMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"SourceDBClusterIdentifier"
],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The name of the new DB cluster to be created.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"SourceDBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the source DB cluster from which to restore.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"RestoreToTime":{
"shape":"TStamp",
"documentation":"<p>The date and time to restore the DB cluster to.</p> <p>Valid values: A time in Universal Coordinated Time (UTC) format.</p> <p>Constraints:</p> <ul> <li> <p>Must be before the latest restorable time for the DB instance.</p> </li> <li> <p>Must be specified if the <code>UseLatestRestorableTime</code> parameter is not provided.</p> </li> <li> <p>Cannot be specified if the <code>UseLatestRestorableTime</code> parameter is <code>true</code>.</p> </li> <li> <p>Cannot be specified if the <code>RestoreType</code> parameter is <code>copy-on-write</code>.</p> </li> </ul> <p>Example: <code>2015-03-07T23:45:00Z</code> </p>"
},
"UseLatestRestorableTime":{
"shape":"Boolean",
"documentation":"<p>A value that is set to <code>true</code> to restore the DB cluster to the latest restorable backup time, and <code>false</code> otherwise. </p> <p>Default: <code>false</code> </p> <p>Constraints: Cannot be specified if the <code>RestoreToTime</code> parameter is provided.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the new DB cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The default port for the engine.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The DB subnet group name to use for the new DB cluster.</p> <p>Constraints: If provided, must match the name of an existing <code>DBSubnetGroup</code>.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of VPC security groups that the new DB cluster belongs to.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the restored DB cluster.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>You can restore to a new DB cluster and encrypt the new DB cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS key identified by the <code>KmsKeyId</code> parameter.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p> <ul> <li> <p>If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the source DB cluster.</p> </li> <li> <p>If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.</p> </li> </ul> <p>If <code>DBClusterIdentifier</code> refers to a DB cluster that is not encrypted, then the restore request is rejected.</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Represents the input to <a>RestoreDBClusterToPointInTime</a>.</p>"
},
"RestoreDBClusterToPointInTimeResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"SharedSnapshotQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You have exceeded the maximum number of accounts that you can share a manual DB snapshot with. </p>",
"error":{
"code":"SharedSnapshotQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SnapshotQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of DB snapshots.</p>",
"error":{
"code":"SnapshotQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SourceType":{
"type":"string",
"enum":[
"db-instance",
"db-parameter-group",
"db-security-group",
"db-snapshot",
"db-cluster",
"db-cluster-snapshot"
]
},
"StorageQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed amount of storage available across all DB instances.</p>",
"error":{
"code":"StorageQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"StorageTypeNotSupportedFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Storage of the specified <code>StorageType</code> can't be associated with the DB instance. </p>",
"error":{
"code":"StorageTypeNotSupported",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"String":{"type":"string"},
"Subnet":{
"type":"structure",
"members":{
"SubnetIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the identifier of the subnet.</p>"
},
"SubnetAvailabilityZone":{
"shape":"AvailabilityZone",
"documentation":"<p>Specifies the Availability Zone for the subnet.</p>"
},
"SubnetStatus":{
"shape":"String",
"documentation":"<p>Specifies the status of the subnet.</p>"
}
},
"documentation":"<p> Detailed information about a subnet. </p>"
},
"SubnetAlreadyInUse":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet is already in use in the Availability Zone.</p>",
"error":{
"code":"SubnetAlreadyInUse",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SubnetIdentifierList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"SubnetIdentifier"
}
},
"SubnetList":{
"type":"list",
"member":{
"shape":"Subnet",
"locationName":"Subnet"
}
},
"TStamp":{"type":"timestamp"},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"String",
"documentation":"<p>The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
},
"Value":{
"shape":"String",
"documentation":"<p>The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
}
},
"documentation":"<p>Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.</p>"
},
"TagList":{
"type":"list",
"member":{
"shape":"Tag",
"locationName":"Tag"
}
},
"TagListMessage":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"<p>A list of one or more tags.</p>"
}
},
"documentation":"<p>Represents the output of <a>ListTagsForResource</a>.</p>"
},
"UpgradeTarget":{
"type":"structure",
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The name of the upgrade target database engine.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the upgrade target database engine.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The version of the database engine that a DB instance can be upgraded to.</p>"
},
"AutoUpgrade":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the target version is applied to any source DB instances that have <code>AutoMinorVersionUpgrade</code> set to <code>true</code>.</p>"
},
"IsMajorVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether a database engine is upgraded to a major version.</p>"
}
},
"documentation":"<p>The version of the database engine that a DB instance can be upgraded to.</p>"
},
"ValidUpgradeTargetList":{
"type":"list",
"member":{
"shape":"UpgradeTarget",
"locationName":"UpgradeTarget"
}
},
"VpcSecurityGroupIdList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"VpcSecurityGroupId"
}
},
"VpcSecurityGroupMembership":{
"type":"structure",
"members":{
"VpcSecurityGroupId":{
"shape":"String",
"documentation":"<p>The name of the VPC security group.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the VPC security group.</p>"
}
},
"documentation":"<p>Used as a response element for queries on virtual private cloud (VPC) security group membership.</p>"
},
"VpcSecurityGroupMembershipList":{
"type":"list",
"member":{
"shape":"VpcSecurityGroupMembership",
"locationName":"VpcSecurityGroupMembership"
}
}
},
"documentation":"<p>Amazon DocumentDB API documentation</p>"
}

90
botocore/data/docdb/2014-10-31/waiters-2.json Normal file
View file

@ -0,0 +1,90 @@
{
"version": 2,
"waiters": {
"DBInstanceAvailable": {
"delay": 30,
"operation": "DescribeDBInstances",
"maxAttempts": 60,
"acceptors": [
{
"expected": "available",
"matcher": "pathAll",
"state": "success",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "deleted",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "deleting",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "failed",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "incompatible-restore",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "incompatible-parameters",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
}
]
},
"DBInstanceDeleted": {
"delay": 30,
"operation": "DescribeDBInstances",
"maxAttempts": 60,
"acceptors": [
{
"expected": "deleted",
"matcher": "pathAll",
"state": "success",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "DBInstanceNotFound",
"matcher": "error",
"state": "success"
},
{
"expected": "creating",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "modifying",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "rebooting",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "resetting-master-credentials",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
}
]
}
}
}

48
botocore/data/ds/2015-04-16/paginators-1.json
View file

@ -5,6 +5,54 @@
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "Limit"
},
"DescribeDirectories": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "DirectoryDescriptions"
},
"DescribeSharedDirectories": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "SharedDirectories"
},
"DescribeSnapshots": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Snapshots"
},
"DescribeTrusts": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Trusts"
},
"ListIpRoutes": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "IpRoutesInfo"
},
"ListLogSubscriptions": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "LogSubscriptions"
},
"ListSchemaExtensions": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "SchemaExtensionsInfo"
},
"ListTagsForResource": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Tags"
}
}
}

12
botocore/data/ds/2015-04-16/service-2.json
View file

@ -1122,6 +1122,10 @@
"ConnectSettings":{
"shape":"DirectoryConnectSettings",
"documentation":"<p>A <a>DirectoryConnectSettings</a> object that contains additional information for the operation.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to be assigned to AD Connector.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>ConnectDirectory</a> operation.</p>"
@ -1276,6 +1280,10 @@
"VpcSettings":{
"shape":"DirectoryVpcSettings",
"documentation":"<p>A <a>DirectoryVpcSettings</a> object that contains additional information for the operation.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to be assigned to the Simple AD directory.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>CreateDirectory</a> operation. </p>"
@ -1343,6 +1351,10 @@
"Edition":{
"shape":"DirectoryEdition",
"documentation":"<p>AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to be assigned to the AWS Managed Microsoft AD directory.</p>"
}
},
"documentation":"<p>Creates an AWS Managed Microsoft AD directory.</p>"

5
botocore/data/dynamodb/2012-08-10/paginators-1.json
View file

@ -37,6 +37,11 @@
"non_aggregate_keys": [
"ConsumedCapacity"
]
},
"ListTagsOfResource": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Tags"
}
}
}

35
botocore/data/dynamodb/2012-08-10/service-2.json
View file

@ -202,6 +202,7 @@
},
"input":{"shape":"DescribeEndpointsRequest"},
"output":{"shape":"DescribeEndpointsResponse"},
"documentation":"<p>Returns the regional endpoint information.</p>",
"endpointoperation":true
},
"DescribeGlobalTable":{
@ -729,7 +730,7 @@
},
"L":{
"shape":"ListAttributeValue",
"documentation":"<p>An attribute of type List. For example:</p> <p> <code>\"L\": [\"Cookies\", \"Coffee\", 3.14159]</code> </p>"
"documentation":"<p>An attribute of type List. For example:</p> <p> <code>\"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]</code> </p>"
},
"NULL":{
"shape":"NullAttributeValue",
@ -956,7 +957,7 @@
},
"BackupType":{
"shape":"BackupType",
"documentation":"<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - You create and manage these using the on-demand backup feature.</p> </li> <li> <p> <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, a <code>SYSTEM</code> backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. </p> </li> </ul>"
"documentation":"<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - You create and manage these using the on-demand backup feature.</p> </li> <li> <p> <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, a <code>SYSTEM</code> backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. </p> </li> <li> <p> <code>AWS_BACKUP</code> - On-demand backup created by you from AWS Backup service.</p> </li> </ul>"
},
"BackupCreationDateTime":{
"shape":"BackupCreationDateTime",
@ -1044,7 +1045,7 @@
},
"BackupType":{
"shape":"BackupType",
"documentation":"<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - You create and manage these using the on-demand backup feature.</p> </li> <li> <p> <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, a <code>SYSTEM</code> backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. </p> </li> </ul>"
"documentation":"<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - You create and manage these using the on-demand backup feature.</p> </li> <li> <p> <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, a <code>SYSTEM</code> backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. </p> </li> <li> <p> <code>AWS_BACKUP</code> - On-demand backup created by you from AWS Backup service.</p> </li> </ul>"
},
"BackupSizeBytes":{
"shape":"BackupSizeBytes",
@ -1057,7 +1058,8 @@
"type":"string",
"enum":[
"USER",
"SYSTEM"
"SYSTEM",
"AWS_BACKUP"
]
},
"BackupTypeFilter":{
@ -1065,6 +1067,7 @@
"enum":[
"USER",
"SYSTEM",
"AWS_BACKUP",
"ALL"
]
},
@ -1501,11 +1504,11 @@
},
"LocalSecondaryIndexes":{
"shape":"LocalSecondaryIndexList",
"documentation":"<p>One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.</p> <p>Each local secondary index in the array includes the following:</p> <ul> <li> <p> <code>IndexName</code> - The name of the local secondary index. Must be unique only for this table.</p> <p/> </li> <li> <p> <code>KeySchema</code> - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.</p> </li> <li> <p> <code>Projection</code> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p> <code>ProjectionType</code> - One of the following:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <code>NonKeyAttributes</code>.</p> </li> <li> <p> <code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p> <code>NonKeyAttributes</code> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in <code>NonKeyAttributes</code>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> </ul>"
"documentation":"<p>One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.</p> <p>Each local secondary index in the array includes the following:</p> <ul> <li> <p> <code>IndexName</code> - The name of the local secondary index. Must be unique only for this table.</p> <p/> </li> <li> <p> <code>KeySchema</code> - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.</p> </li> <li> <p> <code>Projection</code> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p> <code>ProjectionType</code> - One of the following:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <code>NonKeyAttributes</code>.</p> </li> <li> <p> <code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p> <code>NonKeyAttributes</code> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in <code>NonKeyAttributes</code>, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> </ul>"
},
"GlobalSecondaryIndexes":{
"shape":"GlobalSecondaryIndexList",
"documentation":"<p>One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:</p> <ul> <li> <p> <code>IndexName</code> - The name of the global secondary index. Must be unique only for this table.</p> <p/> </li> <li> <p> <code>KeySchema</code> - Specifies the key schema for the global secondary index.</p> </li> <li> <p> <code>Projection</code> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p> <code>ProjectionType</code> - One of the following:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <code>NonKeyAttributes</code>.</p> </li> <li> <p> <code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p> <code>NonKeyAttributes</code> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in <code>NonKeyAttributes</code>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> <li> <p> <code>ProvisionedThroughput</code> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.</p> </li> </ul>"
"documentation":"<p>One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:</p> <ul> <li> <p> <code>IndexName</code> - The name of the global secondary index. Must be unique only for this table.</p> <p/> </li> <li> <p> <code>KeySchema</code> - Specifies the key schema for the global secondary index.</p> </li> <li> <p> <code>Projection</code> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:</p> <ul> <li> <p> <code>ProjectionType</code> - One of the following:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index.</p> </li> <li> <p> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <code>NonKeyAttributes</code>.</p> </li> <li> <p> <code>ALL</code> - All of the table attributes are projected into the index.</p> </li> </ul> </li> <li> <p> <code>NonKeyAttributes</code> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in <code>NonKeyAttributes</code>, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.</p> </li> </ul> </li> <li> <p> <code>ProvisionedThroughput</code> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.</p> </li> </ul>"
},
"BillingMode":{
"shape":"BillingMode",
@ -1756,7 +1759,10 @@
"type":"structure",
"required":["Endpoints"],
"members":{
"Endpoints":{"shape":"Endpoints"}
"Endpoints":{
"shape":"Endpoints",
"documentation":"<p>List of endpoints.</p>"
}
}
},
"DescribeGlobalTableInput":{
@ -1877,9 +1883,16 @@
"CachePeriodInMinutes"
],
"members":{
"Address":{"shape":"String"},
"CachePeriodInMinutes":{"shape":"Long"}
}
"Address":{
"shape":"String",
"documentation":"<p>IP address of the endpoint.</p>"
},
"CachePeriodInMinutes":{
"shape":"Long",
"documentation":"<p>Endpoint cache time to live (TTL) value.</p>"
}
},
"documentation":"<p>An endpoint information details.</p>"
},
"Endpoints":{
"type":"list",
@ -4021,7 +4034,7 @@
"documentation":"<p>A list of cancellation reasons.</p>"
}
},
"documentation":"<p>The entire transaction request was rejected.</p> <p>DynamoDB will reject the entire <code>TransactWriteItems</code> request if any of the following is true:</p> <ul> <li> <p> A table in the <code>TransactWriteItems</code> request does not exist. </p> </li> <li> <p> A table in the <code>TransactWriteItems</code> request is on a different account or region. </p> </li> <li> <p> Operations contain item schema violations. </p> </li> <li> <p> More than one write operation (<code>UpdateItem</code>, <code>PutItem</code>, <code>DeleteItem</code>) operates on the same item. </p> </li> <li> <p> More than one check operation operates on the same item. </p> </li> <li> <p> The number of operations sent in the <code>TransactWriteItems</code> request is 0 or greater than 10. </p> </li> <li> <p> A <code>TransactWriteItems</code> request exceeds the maximum 4 MB request size. </p> </li> <li> <p> Any operation in the <code>TransactWriteItems</code> request would cause an item to become larger than 400KB. </p> </li> </ul>",
"documentation":"<p>The entire transaction request was rejected.</p> <p>DynamoDB rejects a <code>TransactWriteItems</code> request under the following circumstances:</p> <ul> <li> <p>A condition in one of the condition expressions is not met.</p> </li> <li> <p>A table in the <code>TransactWriteItems</code> request is in a different account or region.</p> </li> <li> <p>More than one action in the <code>TransactWriteItems</code> operation targets the same item.</p> </li> <li> <p>There is insufficient provisioned capacity for the transaction to be completed.</p> </li> <li> <p>An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.</p> </li> <li> <p>There is a user error, such as an invalid data format.</p> </li> </ul> <p>DynamoDB rejects a <code>TransactGetItems</code> request under the following circumstances:</p> <ul> <li> <p>There is an ongoing <code>TransactGetItems</code> operation that conflicts with a concurrent <code>PutItem</code>, <code>UpdateItem</code>, <code>DeleteItem</code> or <code>TransactWriteItems</code> request. In this case the <code>TransactGetItems</code> operation fails with a <code>TransactionCanceledException</code>.</p> </li> <li> <p>A table in the <code>TransactGetItems</code> request is in a different account or region.</p> </li> <li> <p>There is insufficient provisioned capacity for the transaction to be completed.</p> </li> <li> <p>There is a user error, such as an invalid data format.</p> </li> </ul>",
"exception":true
},
"TransactionConflictException":{

246
botocore/data/ec2/2016-11-15/paginators-1.json
View file

@ -112,6 +112,252 @@
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "VpcEndpointConnections"
},
"DescribeByoipCidrs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ByoipCidrs"
},
"DescribeCapacityReservations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "CapacityReservations"
},
"DescribeClassicLinkInstances": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Instances"
},
"DescribeClientVpnAuthorizationRules": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "AuthorizationRules"
},
"DescribeClientVpnConnections": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Connections"
},
"DescribeClientVpnEndpoints": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ClientVpnEndpoints"
},
"DescribeClientVpnRoutes": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Routes"
},
"DescribeClientVpnTargetNetworks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ClientVpnTargetNetworks"
},
"DescribeEgressOnlyInternetGateways": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "EgressOnlyInternetGateways"
},
"DescribeFleets": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Fleets"
},
"DescribeFlowLogs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "FlowLogs"
},
"DescribeFpgaImages": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "FpgaImages"
},
"DescribeHostReservationOfferings": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "OfferingSet"
},
"DescribeHostReservations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "HostReservationSet"
},
"DescribeHosts": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Hosts"
},
"DescribeImportImageTasks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ImportImageTasks"
},
"DescribeImportSnapshotTasks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ImportSnapshotTasks"
},
"DescribeInstanceCreditSpecifications": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "InstanceCreditSpecifications"
},
"DescribeLaunchTemplateVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "LaunchTemplateVersions"
},
"DescribeLaunchTemplates": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "LaunchTemplates"
},
"DescribeMovingAddresses": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "MovingAddressStatuses"
},
"DescribeNetworkInterfacePermissions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "NetworkInterfacePermissions"
},
"DescribePrefixLists": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "PrefixLists"
},
"DescribePrincipalIdFormat": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Principals"
},
"DescribePublicIpv4Pools": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "PublicIpv4Pools"
},
"DescribeScheduledInstanceAvailability": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScheduledInstanceAvailabilitySet"
},
"DescribeScheduledInstances": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScheduledInstanceSet"
},
"DescribeStaleSecurityGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "StaleSecurityGroupSet"
},
"DescribeTransitGatewayAttachments": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGatewayAttachments"
},
"DescribeTransitGatewayRouteTables": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGatewayRouteTables"
},
"DescribeTransitGatewayVpcAttachments": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGatewayVpcAttachments"
},
"DescribeTransitGateways": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGateways"
},
"DescribeVolumesModifications": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "VolumesModifications"
},
"DescribeVpcClassicLinkDnsSupport": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Vpcs"
},
"DescribeVpcEndpointConnectionNotifications": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ConnectionNotificationSet"
},
"DescribeVpcEndpointServiceConfigurations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ServiceConfigurations"
},
"DescribeVpcEndpointServicePermissions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "AllowedPrincipals"
},
"DescribeVpcPeeringConnections": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "VpcPeeringConnections"
},
"GetTransitGatewayAttachmentPropagations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGatewayAttachmentPropagations"
},
"GetTransitGatewayRouteTableAssociations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Associations"
},
"GetTransitGatewayRouteTablePropagations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGatewayRouteTablePropagations"
}
}
}

585
botocore/data/ec2/2016-11-15/service-2.json
View file

File diff suppressed because one or more lines are too long

3
botocore/data/ecr/2015-09-21/service-2.json
View file

@ -2,13 +2,14 @@
"version":"2.0",
"metadata":{
"apiVersion":"2015-09-21",
"endpointPrefix":"ecr",
"endpointPrefix":"api.ecr",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"Amazon ECR",
"serviceFullName":"Amazon EC2 Container Registry",
"serviceId":"ECR",
"signatureVersion":"v4",
"signingName":"ecr",
"targetPrefix":"AmazonEC2ContainerRegistry_V20150921",
"uid":"ecr-2015-09-21"
},

12
botocore/data/ecs/2014-11-13/paginators-1.json
View file

@ -35,6 +35,18 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "serviceArns"
},
"ListAccountSettings": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "settings"
},
"ListAttributes": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "attributes"
}
}
}

230
botocore/data/ecs/2014-11-13/service-2.json
View file

File diff suppressed because one or more lines are too long

218
botocore/data/efs/2015-02-01/service-2.json
View file

File diff suppressed because one or more lines are too long

15
botocore/data/eks/2017-11-01/paginators-1.json
View file

@ -1,3 +1,16 @@
{
"pagination": {}
"pagination": {
"ListClusters": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "clusters"
},
"ListUpdates": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "updateIds"
}
}
}

24
botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json
View file

@ -5,6 +5,30 @@
"output_token": "NextToken",
"limit_key": "MaxRecords",
"result_key": "Events"
},
"DescribeApplicationVersions": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "ApplicationVersions"
},
"DescribeEnvironmentManagedActionHistory": {
"input_token": "NextToken",
"limit_key": "MaxItems",
"output_token": "NextToken",
"result_key": "ManagedActionHistoryItems"
},
"DescribeEnvironments": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "Environments"
},
"ListPlatformVersions": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "PlatformSummaryList"
}
}
}

6
botocore/data/elb/2012-06-01/paginators-1.json
View file

@ -5,6 +5,12 @@
"output_token": "NextMarker",
"result_key": "LoadBalancerDescriptions",
"limit_key": "PageSize"
},
"DescribeAccountLimits": {
"input_token": "Marker",
"limit_key": "PageSize",
"output_token": "NextMarker",
"result_key": "Limits"
}
}
}

24
botocore/data/elbv2/2015-12-01/paginators-1.json
View file

@ -17,6 +17,30 @@
"output_token": "NextMarker",
"limit_key": "PageSize",
"result_key": "Listeners"
},
"DescribeAccountLimits": {
"input_token": "Marker",
"limit_key": "PageSize",
"output_token": "NextMarker",
"result_key": "Limits"
},
"DescribeListenerCertificates": {
"input_token": "Marker",
"limit_key": "PageSize",
"output_token": "NextMarker",
"result_key": "Certificates"
},
"DescribeRules": {
"input_token": "Marker",
"limit_key": "PageSize",
"output_token": "NextMarker",
"result_key": "Rules"
},
"DescribeSSLPolicies": {
"input_token": "Marker",
"limit_key": "PageSize",
"output_token": "NextMarker",
"result_key": "SslPolicies"
}
}
}

73
botocore/data/elbv2/2015-12-01/service-2.json
View file

@ -28,7 +28,7 @@
{"shape":"TooManyCertificatesException"},
{"shape":"CertificateNotFoundException"}
],
"documentation":"<p>Adds the specified certificate to the specified secure listener.</p> <p>If the certificate was already added, the call is successful but the certificate is not added again.</p> <p>To list the certificates for your listener, use <a>DescribeListenerCertificates</a>. To remove certificates from your listener, use <a>RemoveListenerCertificates</a>. To specify the default SSL server certificate, use <a>ModifyListener</a>.</p>"
"documentation":"<p>Adds the specified certificate to the specified HTTPS listener.</p> <p>If the certificate was already added, the call is successful but the certificate is not added again.</p> <p>To list the certificates for your listener, use <a>DescribeListenerCertificates</a>. To remove certificates from your listener, use <a>RemoveListenerCertificates</a>. To specify the default SSL server certificate, use <a>ModifyListener</a>.</p>"
},
"AddTags":{
"name":"AddTags",
@ -77,7 +77,7 @@
{"shape":"TooManyActionsException"},
{"shape":"InvalidLoadBalancerActionException"}
],
"documentation":"<p>Creates a listener for the specified Application Load Balancer or Network Load Balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> and <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html\">Listeners for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
"documentation":"<p>Creates a listener for the specified Application Load Balancer or Network Load Balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> and <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html\">Listeners for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
},
"CreateLoadBalancer":{
"name":"CreateLoadBalancer",
@ -105,7 +105,7 @@
{"shape":"AvailabilityZoneNotSupportedException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Creates an Application Load Balancer or a Network Load Balancer.</p> <p>When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, <a>SetIpAddressType</a>, and <a>AddTags</a>.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>For limit information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i> and <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Limits for Your Network Load Balancer</a> in the <i>Network Load Balancers Guide</i>.</p> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> and <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html\">Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
"documentation":"<p>Creates an Application Load Balancer or a Network Load Balancer.</p> <p>When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, <a>SetIpAddressType</a>, and <a>AddTags</a>.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>For limit information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i> and <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Limits for Your Network Load Balancer</a> in the <i>Network Load Balancers Guide</i>.</p> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> and <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html\">Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
},
"CreateRule":{
"name":"CreateRule",
@ -133,7 +133,7 @@
{"shape":"TooManyActionsException"},
{"shape":"InvalidLoadBalancerActionException"}
],
"documentation":"<p>Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.</p> <p>Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener Rules</a> in the <i>Application Load Balancers Guide</i>.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>"
"documentation":"<p>Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.</p> <p>Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener Rules</a> in the <i>Application Load Balancers Guide</i>.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>"
},
"CreateTargetGroup":{
"name":"CreateTargetGroup",
@ -151,7 +151,7 @@
{"shape":"TooManyTargetGroupsException"},
{"shape":"InvalidConfigurationRequestException"}
],
"documentation":"<p>Creates a target group.</p> <p>To register targets with the target group, use <a>RegisterTargets</a>. To update the health check settings for the target group, use <a>ModifyTargetGroup</a>. To monitor the health of targets in the target group, use <a>DescribeTargetHealth</a>.</p> <p>To route traffic to the targets in a target group, specify the target group in an action using <a>CreateListener</a> or <a>CreateRule</a>.</p> <p>To delete a target group, use <a>DeleteTargetGroup</a>.</p> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html\">Target Groups for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> or <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html\">Target Groups for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
"documentation":"<p>Creates a target group.</p> <p>To register targets with the target group, use <a>RegisterTargets</a>. To update the health check settings for the target group, use <a>ModifyTargetGroup</a>. To monitor the health of targets in the target group, use <a>DescribeTargetHealth</a>.</p> <p>To route traffic to the targets in a target group, specify the target group in an action using <a>CreateListener</a> or <a>CreateRule</a>.</p> <p>To delete a target group, use <a>DeleteTargetGroup</a>.</p> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html\">Target Groups for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html\">Target Groups for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
},
"DeleteListener":{
"name":"DeleteListener",
@ -248,7 +248,7 @@
"shape":"DescribeAccountLimitsOutput",
"resultWrapper":"DescribeAccountLimitsResult"
},
"documentation":"<p>Describes the current Elastic Load Balancing resource limits for your AWS account.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancers</a> in the <i>Application Load Balancer Guide</i> or <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Limits for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
"documentation":"<p>Describes the current Elastic Load Balancing resource limits for your AWS account.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancers</a> in the <i>Application Load Balancer Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Limits for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>"
},
"DescribeListenerCertificates":{
"name":"DescribeListenerCertificates",
@ -264,7 +264,7 @@
"errors":[
{"shape":"ListenerNotFoundException"}
],
"documentation":"<p>Describes the certificates for the specified secure listener.</p>"
"documentation":"<p>Describes the certificates for the specified HTTPS listener.</p>"
},
"DescribeListeners":{
"name":"DescribeListeners",
@ -298,7 +298,7 @@
"errors":[
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified Application Load Balancer or Network Load Balancer.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes\">Load Balancer Attributes</a> in the <i>Application Load Balancers Guide</i> or <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#load-balancer-attributes\">Load Balancer Attributes</a> in the <i>Network Load Balancers Guide</i>.</p>"
"documentation":"<p>Describes the attributes for the specified Application Load Balancer or Network Load Balancer.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes\">Load Balancer Attributes</a> in the <i>Application Load Balancers Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#load-balancer-attributes\">Load Balancer Attributes</a> in the <i>Network Load Balancers Guide</i>.</p>"
},
"DescribeLoadBalancers":{
"name":"DescribeLoadBalancers",
@ -348,7 +348,7 @@
"errors":[
{"shape":"SSLPolicyNotFoundException"}
],
"documentation":"<p>Describes the specified policies or all policies used for SSL negotiation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>"
"documentation":"<p>Describes the specified policies or all policies used for SSL negotiation.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
@ -383,7 +383,7 @@
"errors":[
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified target group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes\">Target Group Attributes</a> in the <i>Application Load Balancers Guide</i> or <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#target-group-attributes\">Target Group Attributes</a> in the <i>Network Load Balancers Guide</i>.</p>"
"documentation":"<p>Describes the attributes for the specified target group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes\">Target Group Attributes</a> in the <i>Application Load Balancers Guide</i> or <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#target-group-attributes\">Target Group Attributes</a> in the <i>Network Load Balancers Guide</i>.</p>"
},
"DescribeTargetGroups":{
"name":"DescribeTargetGroups",
@ -448,7 +448,7 @@
{"shape":"TooManyActionsException"},
{"shape":"InvalidLoadBalancerActionException"}
],
"documentation":"<p>Modifies the specified properties of the specified listener.</p> <p>Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.</p>"
"documentation":"<p>Modifies the specified properties of the specified listener.</p> <p>Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and server certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and server certificate properties.</p>"
},
"ModifyLoadBalancerAttributes":{
"name":"ModifyLoadBalancerAttributes",
@ -560,7 +560,7 @@
{"shape":"ListenerNotFoundException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Removes the specified certificate from the specified secure listener.</p> <p>You can't remove the default certificate for a listener. To replace the default certificate, call <a>ModifyListener</a>.</p> <p>To list the certificates for your listener, use <a>DescribeListenerCertificates</a>.</p>"
"documentation":"<p>Removes the specified certificate from the specified HTTPS listener.</p> <p>You can't remove the default certificate for a listener. To replace the default certificate, call <a>ModifyListener</a>.</p> <p>To list the certificates for your listener, use <a>DescribeListenerCertificates</a>.</p>"
},
"RemoveTags":{
"name":"RemoveTags",
@ -673,11 +673,11 @@
},
"AuthenticateOidcConfig":{
"shape":"AuthenticateOidcActionConfig",
"documentation":"<p>[HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when <code>Type</code> is <code>authenticate-oidc</code>.</p>"
"documentation":"<p>[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when <code>Type</code> is <code>authenticate-oidc</code>.</p>"
},
"AuthenticateCognitoConfig":{
"shape":"AuthenticateCognitoActionConfig",
"documentation":"<p>[HTTPS listener] Information for using Amazon Cognito to authenticate users. Specify only when <code>Type</code> is <code>authenticate-cognito</code>.</p>"
"documentation":"<p>[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when <code>Type</code> is <code>authenticate-cognito</code>.</p>"
},
"Order":{
"shape":"ActionOrder",
@ -863,8 +863,7 @@
"AuthorizationEndpoint",
"TokenEndpoint",
"UserInfoEndpoint",
"ClientId",
"ClientSecret"
"ClientId"
],
"members":{
"Issuer":{
@ -889,7 +888,7 @@
},
"ClientSecret":{
"shape":"AuthenticateOidcActionClientSecret",
"documentation":"<p>The OAuth 2.0 client secret.</p>"
"documentation":"<p>The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set <code>UseExistingClientSecret</code> to true.</p>"
},
"SessionCookieName":{
"shape":"AuthenticateOidcActionSessionCookieName",
@ -910,6 +909,10 @@
"OnUnauthenticatedRequest":{
"shape":"AuthenticateOidcActionConditionalBehaviorEnum",
"documentation":"<p>The behavior if the user is not authenticated. The following are possible values:</p> <ul> <li> <p>deny<code/> - Return an HTTP 401 Unauthorized error.</p> </li> <li> <p>allow<code/> - Allow the request to be forwarded to the target.</p> </li> <li> <p>authenticate<code/> - Redirect the request to the IdP authorization endpoint. This is the default value.</p> </li> </ul>"
},
"UseExistingClientSecret":{
"shape":"AuthenticateOidcActionUseExistingClientSecret",
"documentation":"<p>Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.</p>"
}
},
"documentation":"<p>Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.</p>"
@ -919,6 +922,7 @@
"AuthenticateOidcActionSessionCookieName":{"type":"string"},
"AuthenticateOidcActionSessionTimeout":{"type":"long"},
"AuthenticateOidcActionTokenEndpoint":{"type":"string"},
"AuthenticateOidcActionUseExistingClientSecret":{"type":"boolean"},
"AuthenticateOidcActionUserInfoEndpoint":{"type":"string"},
"AvailabilityZone":{
"type":"structure",
@ -1025,7 +1029,7 @@
},
"Protocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.</p>"
"documentation":"<p>The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS.</p>"
},
"Port":{
"shape":"Port",
@ -1033,15 +1037,15 @@
},
"SslPolicy":{
"shape":"SslPolicyName",
"documentation":"<p>[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>"
"documentation":"<p>[HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>"
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p> <p>To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
"documentation":"<p>[HTTPS and TLS listeners] The default SSL server certificate. You must provide exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p> <p>To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
"documentation":"<p>The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
}
}
},
@ -1124,7 +1128,7 @@
},
"Actions":{
"shape":"Actions",
"documentation":"<p>The actions. Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>fixed-response</code>, or <code>redirect</code>.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
"documentation":"<p>The actions. Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>fixed-response</code>, or <code>redirect</code>.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
}
}
},
@ -1147,7 +1151,7 @@
},
"Protocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP. If the target is a Lambda function, this parameter does not apply.</p>"
"documentation":"<p>The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP and TLS. If the target is a Lambda function, this parameter does not apply.</p>"
},
"Port":{
"shape":"Port",
@ -1159,7 +1163,7 @@
},
"HealthCheckProtocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.</p>"
"documentation":"<p>The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks.</p>"
},
"HealthCheckPort":{
"shape":"HealthCheckPort",
@ -1847,7 +1851,7 @@
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>The SSL server certificate. You must provide a certificate if the protocol is HTTPS.</p>"
"documentation":"<p>The SSL server certificate. You must provide a certificate if the protocol is HTTPS or TLS.</p>"
},
"SslPolicy":{
"shape":"SslPolicyName",
@ -1963,7 +1967,7 @@
"members":{
"Key":{
"shape":"LoadBalancerAttributeKey",
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>true</code>.</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>true</code>.</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
},
"Value":{
"shape":"LoadBalancerAttributeValue",
@ -2071,19 +2075,19 @@
},
"Protocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.</p>"
"documentation":"<p>The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP and TLS protocols.</p>"
},
"SslPolicy":{
"shape":"SslPolicyName",
"documentation":"<p>[HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>"
"documentation":"<p>[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p> <p>To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
"documentation":"<p>[HTTPS and TLS listeners] The default SSL server certificate. You must provide exactly one certificate. Set <code>CertificateArn</code> to the certificate ARN but do not set <code>IsDefault</code>.</p> <p>To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
"documentation":"<p>The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
}
}
},
@ -2136,7 +2140,7 @@
},
"Actions":{
"shape":"Actions",
"documentation":"<p>The actions.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
"documentation":"<p>The actions.</p> <p>If the action type is <code>forward</code>, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP or TLS for a Network Load Balancer.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-oidc</code>, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.</p> <p>[HTTPS listeners] If the action type is <code>authenticate-cognito</code>, you authenticate users through the user pools supported by Amazon Cognito.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you redirect specified client requests from one URL to another.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you drop specified client requests and return a custom HTTP response.</p>"
}
}
},
@ -2185,7 +2189,7 @@
},
"HealthCheckProtocol":{
"shape":"ProtocolEnum",
"documentation":"<p>The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP.</p> <p>If the protocol of the target group is TCP, you can't modify this setting.</p>"
"documentation":"<p>The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP or TLS. The TLS protocol is not supported for health checks.</p> <p>If the protocol of the target group is TCP, you can't modify this setting.</p>"
},
"HealthCheckPort":{
"shape":"HealthCheckPort",
@ -2275,7 +2279,8 @@
"enum":[
"HTTP",
"HTTPS",
"TCP"
"TCP",
"TLS"
]
},
"RedirectActionConfig":{
@ -3101,5 +3106,5 @@
"VpcId":{"type":"string"},
"ZoneName":{"type":"string"}
},
"documentation":"<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers.</p> <p>An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC).</p> <p>A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. For more information, see the <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application Load Balancers and Network Load Balancers. The 2012-06-01 API supports Classic Load Balancers.</p> <p>To get started, complete the following tasks:</p> <ol> <li> <p>Create a load balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> </ol> <p>To delete a load balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>"
"documentation":"<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers.</p> <p>An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC).</p> <p>A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. For more information, see the <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application Load Balancers and Network Load Balancers. The 2012-06-01 API supports Classic Load Balancers.</p> <p>To get started, complete the following tasks:</p> <ol> <li> <p>Create a load balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> </ol> <p>To delete a load balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>"
}

5
botocore/data/emr/2009-03-31/paginators-1.json
View file

@ -29,6 +29,11 @@
"input_token": "Marker",
"output_token": "Marker",
"result_key": "InstanceFleets"
},
"ListSecurityConfigurations": {
"input_token": "Marker",
"output_token": "Marker",
"result_key": "SecurityConfigurations"
}
}
}

27
botocore/data/emr/2009-03-31/service-2.json
View file

@ -10,7 +10,6 @@
"serviceId":"EMR",
"signatureVersion":"v4",
"targetPrefix":"ElasticMapReduce",
"timestampFormat":"unixTimestamp",
"uid":"elasticmapreduce-2009-03-31"
},
"operations":{
@ -525,7 +524,7 @@
"documentation":"<p>This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.</p>"
}
},
"documentation":"<p>An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see <a href=\"http://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-mapr.html\">Using the MapR Distribution for Hadoop</a>. Currently supported values are:</p> <ul> <li> <p>\"mapr-m3\" - launch the cluster using MapR M3 Edition.</p> </li> <li> <p>\"mapr-m5\" - launch the cluster using MapR M5 Edition.</p> </li> <li> <p>\"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the cluster using MapR M3 or M5 Edition, respectively.</p> </li> </ul> <note> <p>In Amazon EMR releases 4.x and later, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application.</p> </note>"
"documentation":"<p>With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see <a href=\"http://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html\">Configuring Applications</a>.</p> <p>With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument.</p>"
},
"ApplicationList":{
"type":"list",
@ -1286,7 +1285,7 @@
},
"EmrManagedSlaveSecurityGroup":{
"shape":"String",
"documentation":"<p>The identifier of the Amazon EC2 security group for the slave nodes.</p>"
"documentation":"<p>The identifier of the Amazon EC2 security group for the core and task nodes.</p>"
},
"ServiceAccessSecurityGroup":{
"shape":"String",
@ -1298,7 +1297,7 @@
},
"AdditionalSlaveSecurityGroups":{
"shape":"StringList",
"documentation":"<p>A list of additional Amazon EC2 security group IDs for the slave nodes.</p>"
"documentation":"<p>A list of additional Amazon EC2 security group IDs for the core and task nodes.</p>"
}
},
"documentation":"<p>Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.</p>"
@ -2290,7 +2289,7 @@
},
"SlaveInstanceType":{
"shape":"InstanceType",
"documentation":"<p>The EC2 instance type of the slave nodes.</p>"
"documentation":"<p>The EC2 instance type of the core and task nodes.</p>"
},
"InstanceCount":{
"shape":"Integer",
@ -2338,7 +2337,7 @@
},
"EmrManagedSlaveSecurityGroup":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The identifier of the Amazon EC2 security group for the slave nodes.</p>"
"documentation":"<p>The identifier of the Amazon EC2 security group for the core and task nodes.</p>"
},
"ServiceAccessSecurityGroup":{
"shape":"XmlStringMaxLen256",
@ -2350,7 +2349,7 @@
},
"AdditionalSlaveSecurityGroups":{
"shape":"SecurityGroupsList",
"documentation":"<p>A list of additional Amazon EC2 security group IDs for the slave nodes.</p>"
"documentation":"<p>A list of additional Amazon EC2 security group IDs for the core and task nodes.</p>"
}
},
"documentation":"<p>A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets, which is the recommended configuration. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.</p>"
@ -2377,11 +2376,11 @@
},
"SlaveInstanceType":{
"shape":"InstanceType",
"documentation":"<p>The Amazon EC2 slave node instance type.</p>"
"documentation":"<p>The Amazon EC2 core and task node instance type.</p>"
},
"InstanceCount":{
"shape":"Integer",
"documentation":"<p>The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.</p>"
"documentation":"<p>The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.</p>"
},
"InstanceGroups":{
"shape":"InstanceGroupDetailList",
@ -2916,7 +2915,7 @@
},
"Applications":{
"shape":"ApplicationList",
"documentation":"<p>For Amazon EMR releases 4.0 and later. A list of applications for the cluster. Valid values are: \"Hadoop\", \"Hive\", \"Mahout\", \"Pig\", and \"Spark.\" They are case insensitive.</p>"
"documentation":"<p>Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the <a href=\"http://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">Amazon EMR Release Guide</a>.</p>"
},
"Configurations":{
"shape":"ConfigurationList",
@ -3180,7 +3179,7 @@
},
"TimeoutAction":{
"shape":"SpotProvisioningTimeoutAction",
"documentation":"<p>The action to take when <code>TargetSpotCapacity</code> has not been fulfilled when the <code>TimeoutDurationMinutes</code> has expired. Spot instances are not uprovisioned within the Spot provisioining timeout. Valid values are <code>TERMINATE_CLUSTER</code> and <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.</p>"
"documentation":"<p>The action to take when <code>TargetSpotCapacity</code> has not been fulfilled when the <code>TimeoutDurationMinutes</code> has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are <code>TERMINATE_CLUSTER</code> and <code>SWITCH_TO_ON_DEMAND</code>. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.</p>"
},
"BlockDurationMinutes":{
"shape":"WholeNumber",
@ -3223,7 +3222,7 @@
},
"ActionOnFailure":{
"shape":"ActionOnFailure",
"documentation":"<p>This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.</p>"
"documentation":"<p>The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.</p>"
},
"Status":{
"shape":"StepStatus",
@ -3245,7 +3244,7 @@
},
"ActionOnFailure":{
"shape":"ActionOnFailure",
"documentation":"<p>The action to take if the step fails.</p>"
"documentation":"<p>The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.</p>"
},
"HadoopJarStep":{
"shape":"HadoopJarStepConfig",
@ -3400,7 +3399,7 @@
},
"ActionOnFailure":{
"shape":"ActionOnFailure",
"documentation":"<p>This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.</p>"
"documentation":"<p>The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.</p>"
},
"Status":{
"shape":"StepStatus",

408
botocore/data/endpoints.json
View file

@ -102,13 +102,114 @@
"us-west-2" : { }
}
},
"api.ecr" : {
"endpoints" : {
"ap-northeast-1" : {
"credentialScope" : {
"region" : "ap-northeast-1"
},
"hostname" : "api.ecr.ap-northeast-1.amazonaws.com"
},
"ap-northeast-2" : {
"credentialScope" : {
"region" : "ap-northeast-2"
},
"hostname" : "api.ecr.ap-northeast-2.amazonaws.com"
},
"ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
},
"hostname" : "api.ecr.ap-south-1.amazonaws.com"
},
"ap-southeast-1" : {
"credentialScope" : {
"region" : "ap-southeast-1"
},
"hostname" : "api.ecr.ap-southeast-1.amazonaws.com"
},
"ap-southeast-2" : {
"credentialScope" : {
"region" : "ap-southeast-2"
},
"hostname" : "api.ecr.ap-southeast-2.amazonaws.com"
},
"ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "api.ecr.ca-central-1.amazonaws.com"
},
"eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
},
"hostname" : "api.ecr.eu-central-1.amazonaws.com"
},
"eu-north-1" : {
"credentialScope" : {
"region" : "eu-north-1"
},
"hostname" : "api.ecr.eu-north-1.amazonaws.com"
},
"eu-west-1" : {
"credentialScope" : {
"region" : "eu-west-1"
},
"hostname" : "api.ecr.eu-west-1.amazonaws.com"
},
"eu-west-2" : {
"credentialScope" : {
"region" : "eu-west-2"
},
"hostname" : "api.ecr.eu-west-2.amazonaws.com"
},
"eu-west-3" : {
"credentialScope" : {
"region" : "eu-west-3"
},
"hostname" : "api.ecr.eu-west-3.amazonaws.com"
},
"sa-east-1" : {
"credentialScope" : {
"region" : "sa-east-1"
},
"hostname" : "api.ecr.sa-east-1.amazonaws.com"
},
"us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "api.ecr.us-east-1.amazonaws.com"
},
"us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "api.ecr.us-east-2.amazonaws.com"
},
"us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "api.ecr.us-west-1.amazonaws.com"
},
"us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "api.ecr.us-west-2.amazonaws.com"
}
}
},
"api.mediatailor" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-west-1" : { },
"us-east-1" : { }
"us-east-1" : { },
"us-west-2" : { }
}
},
"api.pricing" : {
@ -134,9 +235,33 @@
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-1-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "api-fips.sagemaker.us-east-1.amazonaws.com"
},
"us-east-2" : { },
"us-east-2-fips" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "api-fips.sagemaker.us-east-2.amazonaws.com"
},
"us-west-1" : { },
"us-west-2" : { }
"us-west-1-fips" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "api-fips.sagemaker.us-west-1.amazonaws.com"
},
"us-west-2" : { },
"us-west-2-fips" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "api-fips.sagemaker.us-west-2.amazonaws.com"
}
}
},
"apigateway" : {
@ -195,6 +320,10 @@
},
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
@ -285,6 +414,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -662,7 +792,10 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -724,12 +857,27 @@
"us-west-2" : { }
}
},
"datasync" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
"dax" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -777,6 +925,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -787,6 +936,34 @@
"us-west-2" : { }
}
},
"docdb" : {
"endpoints" : {
"eu-west-1" : {
"credentialScope" : {
"region" : "eu-west-1"
},
"hostname" : "rds.eu-west-1.amazonaws.com"
},
"us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "rds.us-east-1.amazonaws.com"
},
"us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "rds.us-east-2.amazonaws.com"
},
"us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "rds.us-west-2.amazonaws.com"
}
}
},
"ds" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -858,26 +1035,6 @@
"us-west-2" : { }
}
},
"ecr" : {
"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" : { }
}
},
"ecs" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -952,6 +1109,7 @@
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -1051,6 +1209,12 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "es-fips.us-west-1.amazonaws.com"
},
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1111,6 +1275,14 @@
"us-west-2" : { }
}
},
"fsx" : {
"endpoints" : {
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"gamelift" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -1163,6 +1335,7 @@
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -1321,6 +1494,12 @@
},
"kms" : {
"endpoints" : {
"ProdFips" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "kms-fips.ca-central-1.amazonaws.com"
},
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -1359,6 +1538,21 @@
"us-west-2" : { }
}
},
"license-manager" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"lightsail" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -1536,6 +1730,20 @@
"us-west-2" : { }
}
},
"mq" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
"mturk-requester" : {
"endpoints" : {
"sandbox" : {
@ -1547,12 +1755,24 @@
},
"neptune" : {
"endpoints" : {
"ap-northeast-1" : {
"credentialScope" : {
"region" : "ap-northeast-1"
},
"hostname" : "rds.ap-northeast-1.amazonaws.com"
},
"ap-southeast-1" : {
"credentialScope" : {
"region" : "ap-southeast-1"
},
"hostname" : "rds.ap-southeast-1.amazonaws.com"
},
"ap-southeast-2" : {
"credentialScope" : {
"region" : "ap-southeast-2"
},
"hostname" : "rds.ap-southeast-2.amazonaws.com"
},
"eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
@ -1642,6 +1862,7 @@
}
},
"endpoints" : {
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
@ -1656,6 +1877,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -1711,6 +1933,8 @@
"rekognition" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-2" : { },
"eu-west-1" : { },
"us-east-1" : { },
@ -1762,6 +1986,27 @@
"us-east-1" : { }
}
},
"route53resolver" : {
"defaults" : {
"protocols" : [ "https" ]
},
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
"runtime.lex" : {
"defaults" : {
"credentialScope" : {
@ -2057,6 +2302,25 @@
}
}
},
"securityhub" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-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" : { }
}
},
"serverlessrepo" : {
"defaults" : {
"protocols" : [ "https" ]
@ -2115,6 +2379,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2487,6 +2752,7 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
@ -2628,6 +2894,22 @@
}
},
"services" : {
"api.ecr" : {
"endpoints" : {
"cn-north-1" : {
"credentialScope" : {
"region" : "cn-north-1"
},
"hostname" : "api.ecr.cn-north-1.amazonaws.com.cn"
},
"cn-northwest-1" : {
"credentialScope" : {
"region" : "cn-northwest-1"
},
"hostname" : "api.ecr.cn-northwest-1.amazonaws.com.cn"
}
}
},
"apigateway" : {
"endpoints" : {
"cn-north-1" : { },
@ -2738,12 +3020,6 @@
"cn-northwest-1" : { }
}
},
"ecr" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"ecs" : {
"endpoints" : {
"cn-north-1" : { },
@ -2792,6 +3068,17 @@
"cn-northwest-1" : { }
}
},
"firehose" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"gamelift" : {
"endpoints" : {
"cn-north-1" : { }
}
},
"glacier" : {
"defaults" : {
"protocols" : [ "http", "https" ]
@ -2935,6 +3222,12 @@
"cn-northwest-1" : { }
}
},
"states" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"storagegateway" : {
"endpoints" : {
"cn-north-1" : { }
@ -2996,6 +3289,22 @@
"us-gov-west-1" : { }
}
},
"api.ecr" : {
"endpoints" : {
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "api.ecr.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "api.ecr.us-gov-west-1.amazonaws.com"
}
}
},
"api.sagemaker" : {
"endpoints" : {
"us-gov-west-1" : { }
@ -3013,6 +3322,11 @@
"us-gov-west-1" : { }
}
},
"athena" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"autoscaling" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -3124,12 +3438,6 @@
"us-gov-west-1" : { }
}
},
"ecr" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"ecs" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -3177,6 +3485,12 @@
},
"es" : {
"endpoints" : {
"fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "es-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -3187,6 +3501,11 @@
"us-gov-west-1" : { }
}
},
"firehose" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"glacier" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -3195,6 +3514,11 @@
}
}
},
"glue" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"guardduty" : {
"defaults" : {
"protocols" : [ "https" ]
@ -3240,6 +3564,12 @@
},
"kms" : {
"endpoints" : {
"ProdFips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "kms-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
@ -3256,6 +3586,11 @@
"us-gov-west-1" : { }
}
},
"mediaconvert" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"metering.marketplace" : {
"defaults" : {
"credentialScope" : {
@ -3450,6 +3785,11 @@
"hostname" : "translate-fips.us-gov-west-1.amazonaws.com"
}
}
},
"workspaces" : {
"endpoints" : {
"us-gov-west-1" : { }
}
}
}
} ],

18
botocore/data/es/2015-01-01/paginators-1.json
View file

@ -11,6 +11,24 @@
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"DescribeReservedElasticsearchInstanceOfferings": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ReservedElasticsearchInstanceOfferings"
},
"DescribeReservedElasticsearchInstances": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ReservedElasticsearchInstances"
},
"GetUpgradeHistory": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "UpgradeHistories"
}
}
}

14
botocore/data/es/2015-01-01/service-2.json
View file

@ -982,6 +982,10 @@
"shape":"Boolean",
"documentation":"<p>A boolean value to indicate whether zone awareness is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness\" target=\"_blank\">About Zone Awareness</a> for more information.</p>"
},
"ZoneAwarenessConfig":{
"shape":"ZoneAwarenessConfig",
"documentation":"<p>Specifies the zone awareness configuration for a domain when zone awareness is enabled.</p>"
},
"DedicatedMasterType":{
"shape":"ESPartitionInstanceType",
"documentation":"<p>The instance type for a dedicated master node.</p>"
@ -2259,6 +2263,16 @@
"gp2",
"io1"
]
},
"ZoneAwarenessConfig":{
"type":"structure",
"members":{
"AvailabilityZoneCount":{
"shape":"IntegerClass",
"documentation":"<p>An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled</p>"
}
},
"documentation":"<p>Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.</p>"
}
},
"documentation":"<fullname>Amazon Elasticsearch Configuration Service</fullname> <p>Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.</p> <p>The endpoint for configuration service requests is region-specific: es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions\" target=\"_blank\">Regions and Endpoints</a>.</p>"

21
botocore/data/fms/2018-01-01/paginators-1.json
View file

@ -1,3 +1,22 @@
{
"pagination": {}
"pagination": {
"ListComplianceStatus": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "PolicyComplianceStatusList"
},
"ListMemberAccounts": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "MemberAccounts"
},
"ListPolicies": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "PolicyList"
}
}
}

16
botocore/data/fms/2018-01-01/service-2.json
View file

@ -68,7 +68,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalErrorException"}
],
"documentation":"<p>Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an <code>AssociateAdminAccount</code> request to set a new account as the AWS Firewall administrator.</p>"
"documentation":"<p>Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an <code>AssociateAdminAccount</code> request .</p>"
},
"GetAdminAccount":{
"name":"GetAdminAccount",
@ -286,6 +286,10 @@
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The ID of the policy that you want to delete. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</code>.</p>"
},
"DeleteAllPolicyResources":{
"shape":"Boolean",
"documentation":"<p>If <code>True</code>, the request will also delete all web ACLs in this policy. Associated resources will no longer be protected by web ACLs in this policy.</p>"
}
}
},
@ -499,7 +503,7 @@
},
"MaxResults":{
"shape":"PaginationMaxResults",
"documentation":"<p>Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of member account IDs. The maximum value for <code>MaxResults</code> is 100.</p>"
"documentation":"<p>Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of member account IDs.</p>"
}
}
},
@ -604,11 +608,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 AWS Organization are included in the policy. If <code>IncludeMap</code> is not null, only values listed in <code>IncludeMap</code> will be 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 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>"
},
"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 of 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 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>An AWS Firewall Manager policy.</p>"
@ -642,7 +646,7 @@
},
"IssueInfoMap":{
"shape":"IssueInfoMap",
"documentation":"<p>Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message recieved indicating the problem with the service.</p>"
"documentation":"<p>Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.</p>"
}
},
"documentation":"<p>Describes the non-compliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are non-compliant, <code>EvaluationLimitExceeded</code> is set to <code>True</code>.</p>"
@ -676,7 +680,7 @@
},
"IssueInfoMap":{
"shape":"IssueInfoMap",
"documentation":"<p>Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message recieved indicating the problem with the service.</p>"
"documentation":"<p>Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.</p>"
}
},
"documentation":"<p>Indicates whether the account is compliant with the specified policy. An account is considered non-compliant if it includes resources that are not protected by the policy.</p>"

21
botocore/data/fsx/2018-03-01/paginators-1.json
View file

@ -1,3 +1,22 @@
{
"pagination": {}
"pagination": {
"DescribeBackups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Backups"
},
"DescribeFileSystems": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "FileSystems"
},
"ListTagsForResource": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Tags"
}
}
}

42
botocore/data/fsx/2018-03-01/service-2.json
View file

@ -44,6 +44,7 @@
{"shape":"ActiveDirectoryError"},
{"shape":"IncompatibleParameterError"},
{"shape":"InvalidImportPath"},
{"shape":"InvalidExportPath"},
{"shape":"InvalidNetworkSettings"},
{"shape":"ServiceLimitExceeded"},
{"shape":"InternalServerError"},
@ -81,6 +82,7 @@
"output":{"shape":"DeleteBackupResponse"},
"errors":[
{"shape":"BadRequest"},
{"shape":"BackupInProgress"},
{"shape":"BackupNotFound"},
{"shape":"BackupRestoring"},
{"shape":"IncompatibleParameterError"},
@ -476,7 +478,11 @@
},
"ImportPath":{
"shape":"ArchivePath",
"documentation":"<p>(Optional) The path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example <code>s3://import-bucket/optional-prefix</code>. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.</p>"
"documentation":"<p>(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is <code>s3://import-bucket/optional-prefix</code>. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.</p>"
},
"ExportPath":{
"shape":"ArchivePath",
"documentation":"<p>(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an <code>ExportPath</code> value is not provided, Amazon FSx sets a default export path, <code>s3://import-bucket/FSxLustre[creation-timestamp]</code>. The timestamp is in UTC format, for example <code>s3://import-bucket/FSxLustre20181105T222312Z</code>.</p> <p>The Amazon S3 export bucket must be the same as the import bucket specified by <code>ImportPath</code>. If you only specify a bucket name, such as <code>s3://import-bucket</code>, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as <code>s3://import-bucket/[custom-optional-prefix]</code>, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.</p>"
},
"ImportedFileChunkSize":{
"shape":"Megabytes",
@ -595,7 +601,7 @@
},
"ExportPath":{
"shape":"ArchivePath",
"documentation":"<p>The Amazon S3 commit path to use for storing new and changed Lustre file system files as part of the archive operation from the file system to Amazon S3. The value is <code>s3://import-bucket/FSxLustre[creationtimestamp]</code>. The timestamp is presented in UTC format, for example <code>s3://import-bucket/FSxLustre20181105T222312Z</code>. Files are archived to a different prefix in the Amazon S3 bucket, preventing input data from being overwritten.</p>"
"documentation":"<p>The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.</p>"
},
"ImportedFileChunkSize":{
"shape":"Megabytes",
@ -812,7 +818,7 @@
},
"NetworkInterfaceIds":{
"shape":"NetworkInterfaceIds",
"documentation":"<p>The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html\">Elastic Network Interfaces</a> in the <i>Amazon EC2 User Guide.</i> </p> <p>For an Amazon FSx for Windows File Server file system, you can have one network interface Id. For an Amazon FSx for Lustre file system, you can have more than one.</p>"
"documentation":"<p>The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html\">Elastic Network Interfaces</a> in the <i>Amazon EC2 User Guide.</i> </p> <p>For an Amazon FSx for Windows File Server file system, you can have one network interface Id. For an Amazon FSx for Lustre file system, you can have more than one.</p>"
},
"DNSName":{
"shape":"DNSName",
@ -828,7 +834,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the file system. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Amazon EC2 Resources</a> in the <i>Amazon EC2 User Guide</i>.</p>"
"documentation":"<p>The tags to associate with the file system. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Amazon EC2 Resources</a> in the <i>Amazon EC2 User Guide</i>.</p>"
},
"WindowsConfiguration":{
"shape":"WindowsFileSystemConfiguration",
@ -971,6 +977,14 @@
"exception":true,
"fault":true
},
"InvalidExportPath":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The path provided for data repository export isn't valid.</p>",
"exception":true
},
"InvalidImportPath":{
"type":"structure",
"members":{
@ -991,7 +1005,7 @@
},
"KmsKeyId":{
"type":"string",
"documentation":"<p>The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html\">Encrypt</a> in the <i>AWS Key Management Service API Reference</i>.</p>",
"documentation":"<p>The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. 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:\\/_-]+$"
@ -1066,7 +1080,7 @@
},
"NetworkInterfaceId":{
"type":"string",
"documentation":"<p>An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html\">Elastic Network Interfaces</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>",
"documentation":"<p>An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html\">Elastic Network Interfaces</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>",
"max":21,
"min":12,
"pattern":"^(eni-[0-9a-f]{8,})$"
@ -1110,7 +1124,7 @@
},
"ResourceARN":{
"type":"string",
"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=\"http://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>",
"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}$"
@ -1143,7 +1157,7 @@
},
"SecurityGroupId":{
"type":"string",
"documentation":"<p>The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups for Linux Instances</a> in the <i>Amazon EC2 User Guide</i>.</p>",
"documentation":"<p>The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups for Linux Instances</a> in the <i>Amazon EC2 User Guide</i>.</p>",
"max":20,
"min":11,
"pattern":"^(sg-[0-9a-f]{8,})$"
@ -1180,11 +1194,11 @@
"StorageCapacity":{
"type":"integer",
"documentation":"<p>The storage capacity for your Amazon FSx file system, in gibibytes.</p>",
"min":300
"min":1
},
"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=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">VPC and Subnets</a> in the <i>Amazon VPC User Guide.</i> </p>",
"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>",
"max":24,
"min":15,
"pattern":"^(subnet-[0-9a-f]{8,})$"
@ -1213,8 +1227,7 @@
"type":"string",
"documentation":"<p>A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached.</p>",
"max":128,
"min":1,
"pattern":"^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
"min":1
},
"TagKeys":{
"type":"list",
@ -1251,8 +1264,7 @@
"type":"string",
"documentation":"<p>A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.</p>",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
"min":0
},
"Tags":{
"type":"list",
@ -1343,7 +1355,7 @@
},
"VpcId":{
"type":"string",
"documentation":"<p>The ID of your virtual private cloud (VPC). For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">VPC and Subnets</a> in the <i>Amazon VPC User Guide</i>.</p>",
"documentation":"<p>The ID of 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>",
"max":21,
"min":12,
"pattern":"^(vpc-[0-9a-f]{8,})$"

99
botocore/data/gamelift/2015-10-01/paginators-1.json
View file

@ -1,3 +1,100 @@
{
"pagination": {}
"pagination": {
"DescribeFleetAttributes": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "FleetAttributes"
},
"DescribeFleetCapacity": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "FleetCapacity"
},
"DescribeFleetEvents": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Events"
},
"DescribeFleetUtilization": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "FleetUtilization"
},
"DescribeGameSessionDetails": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "GameSessionDetails"
},
"DescribeGameSessionQueues": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "GameSessionQueues"
},
"DescribeGameSessions": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "GameSessions"
},
"DescribeInstances": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Instances"
},
"DescribeMatchmakingConfigurations": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Configurations"
},
"DescribeMatchmakingRuleSets": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "RuleSets"
},
"DescribePlayerSessions": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "PlayerSessions"
},
"DescribeScalingPolicies": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "ScalingPolicies"
},
"ListAliases": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Aliases"
},
"ListBuilds": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Builds"
},
"ListFleets": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "FleetIds"
},
"SearchGameSessions": {
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "GameSessions"
}
}
}

293
botocore/data/gamelift/2015-10-01/service-2.json
View file

File diff suppressed because one or more lines are too long

21
botocore/data/globalaccelerator/2018-08-08/paginators-1.json
View file

@ -1,3 +1,22 @@
{
"pagination": {}
"pagination": {
"ListAccelerators": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Accelerators"
},
"ListEndpointGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "EndpointGroups"
},
"ListListeners": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Listeners"
}
}
}

6
botocore/data/glue/2017-03-31/paginators-1.json
View file

@ -77,6 +77,12 @@
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"GetSecurityConfigurations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SecurityConfigurations"
}
}
}

621
botocore/data/glue/2017-03-31/service-2.json
View file

@ -93,6 +93,51 @@
],
"documentation":"<p>Deletes a specified batch of versions of a table.</p>"
},
"BatchGetCrawlers":{
"name":"BatchGetCrawlers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetCrawlersRequest"},
"output":{"shape":"BatchGetCrawlersResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Returns a list of resource metadata for a given list of crawler names. After calling the <code>ListCrawlers</code> operation, you can call this operation to access the data to which you have been granted permissions to based on tags.</p>"
},
"BatchGetDevEndpoints":{
"name":"BatchGetDevEndpoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetDevEndpointsRequest"},
"output":{"shape":"BatchGetDevEndpointsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of resource metadata for a given list of DevEndpoint names. After calling the <code>ListDevEndpoints</code> operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.</p>"
},
"BatchGetJobs":{
"name":"BatchGetJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetJobsRequest"},
"output":{"shape":"BatchGetJobsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of resource metadata for a given list of job names. After calling the <code>ListJobs</code> operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags. </p>"
},
"BatchGetPartition":{
"name":"BatchGetPartition",
"http":{
@ -110,6 +155,21 @@
],
"documentation":"<p>Retrieves partitions in a batch request.</p>"
},
"BatchGetTriggers":{
"name":"BatchGetTriggers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetTriggersRequest"},
"output":{"shape":"BatchGetTriggersResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of resource metadata for a given list of trigger names. After calling the <code>ListTriggers</code> operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.</p>"
},
"BatchStopJobRun":{
"name":"BatchStopJobRun",
"http":{
@ -995,6 +1055,22 @@
],
"documentation":"<p>Retrieves the definitions of some or all of the tables in a given <code>Database</code>.</p>"
},
"GetTags":{
"name":"GetTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTagsRequest"},
"output":{"shape":"GetTagsResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Retrieves a list of tags associated with a resource.</p>"
},
"GetTrigger":{
"name":"GetTrigger",
"http":{
@ -1075,6 +1151,67 @@
],
"documentation":"<p>Imports an existing Athena Data Catalog to AWS Glue</p>"
},
"ListCrawlers":{
"name":"ListCrawlers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCrawlersRequest"},
"output":{"shape":"ListCrawlersResponse"},
"errors":[
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.</p> <p>This operation takes the optional <code>Tags</code> field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.</p>"
},
"ListDevEndpoints":{
"name":"ListDevEndpoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDevEndpointsRequest"},
"output":{"shape":"ListDevEndpointsResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"EntityNotFoundException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.</p> <p>This operation takes the optional <code>Tags</code> field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.</p>"
},
"ListJobs":{
"name":"ListJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListJobsRequest"},
"output":{"shape":"ListJobsResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"EntityNotFoundException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.</p> <p>This operation takes the optional <code>Tags</code> field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.</p>"
},
"ListTriggers":{
"name":"ListTriggers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTriggersRequest"},
"output":{"shape":"ListTriggersResponse"},
"errors":[
{"shape":"EntityNotFoundException"},
{"shape":"InvalidInputException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.</p> <p>This operation takes the optional <code>Tags</code> field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.</p>"
},
"PutDataCatalogEncryptionSettings":{
"name":"PutDataCatalogEncryptionSettings",
"http":{
@ -1088,7 +1225,7 @@
{"shape":"InvalidInputException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Sets the security configuration for a specified catalog. Once the configuration has been set, the specified encryption is applied to every catalog write thereafter.</p>"
"documentation":"<p>Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.</p>"
},
"PutResourcePolicy":{
"name":"PutResourcePolicy",
@ -1240,6 +1377,38 @@
],
"documentation":"<p>Stops a specified trigger.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">AWS Tags in AWS Glue</a>.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"},
{"shape":"EntityNotFoundException"}
],
"documentation":"<p>Removes tags from a resource.</p>"
},
"UpdateClassifier":{
"name":"UpdateClassifier",
"http":{
@ -1450,7 +1619,7 @@
},
"Arguments":{
"shape":"GenericMap",
"documentation":"<p>Arguments to be passed to the job run.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
"documentation":"<p>The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
},
"Timeout":{
"shape":"Timeout",
@ -1524,7 +1693,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which the connections reside. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.</p>"
},
"ConnectionNameList":{
"shape":"DeleteConnectionNameList",
@ -1663,6 +1832,75 @@
}
}
},
"BatchGetCrawlersRequest":{
"type":"structure",
"required":["CrawlerNames"],
"members":{
"CrawlerNames":{
"shape":"CrawlerNameList",
"documentation":"<p>A list of crawler names, which may be the names returned from the <code>ListCrawlers</code> operation.</p>"
}
}
},
"BatchGetCrawlersResponse":{
"type":"structure",
"members":{
"Crawlers":{
"shape":"CrawlerList",
"documentation":"<p>A list of crawler definitions.</p>"
},
"CrawlersNotFound":{
"shape":"CrawlerNameList",
"documentation":"<p>A list of crawlers not found.</p>"
}
}
},
"BatchGetDevEndpointsRequest":{
"type":"structure",
"required":["DevEndpointNames"],
"members":{
"DevEndpointNames":{
"shape":"DevEndpointNames",
"documentation":"<p>The list of DevEndpoint names, which may be the names returned from the <code>ListDevEndpoint</code> operation.</p>"
}
}
},
"BatchGetDevEndpointsResponse":{
"type":"structure",
"members":{
"DevEndpoints":{
"shape":"DevEndpointList",
"documentation":"<p>A list of DevEndpoint definitions.</p>"
},
"DevEndpointsNotFound":{
"shape":"DevEndpointNames",
"documentation":"<p>A list of DevEndpoints not found.</p>"
}
}
},
"BatchGetJobsRequest":{
"type":"structure",
"required":["JobNames"],
"members":{
"JobNames":{
"shape":"JobNameList",
"documentation":"<p>A list of job names, which may be the names returned from the <code>ListJobs</code> operation.</p>"
}
}
},
"BatchGetJobsResponse":{
"type":"structure",
"members":{
"Jobs":{
"shape":"JobList",
"documentation":"<p>A list of job definitions.</p>"
},
"JobsNotFound":{
"shape":"JobNameList",
"documentation":"<p>A list of names of jobs not found.</p>"
}
}
},
"BatchGetPartitionRequest":{
"type":"structure",
"required":[
@ -1708,6 +1946,29 @@
"max":1000,
"min":0
},
"BatchGetTriggersRequest":{
"type":"structure",
"required":["TriggerNames"],
"members":{
"TriggerNames":{
"shape":"TriggerNameList",
"documentation":"<p>A list of trigger names, which may be the names returned from the <code>ListTriggers</code> operation.</p>"
}
}
},
"BatchGetTriggersResponse":{
"type":"structure",
"members":{
"Triggers":{
"shape":"TriggerList",
"documentation":"<p>A list of trigger definitions.</p>"
},
"TriggersNotFound":{
"shape":"TriggerNameList",
"documentation":"<p>A list of names of triggers not found.</p>"
}
}
},
"BatchStopJobRunError":{
"type":"structure",
"members":{
@ -2084,7 +2345,7 @@
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>Description of the connection.</p>"
"documentation":"<p>The description of the connection.</p>"
},
"ConnectionType":{
"shape":"ConnectionType",
@ -2096,23 +2357,23 @@
},
"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 key you designate to encrypt the password.</p> </li> <li> <p> <code>JDBC_DRIVER_JAR_URI</code> - The S3 path of the a 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 SSL with hostname matching will be enforced for the JDBC connection on the client. The default is false.</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 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 will be enforced for the JDBC connection on the client. The default is false.</p> </li> </ul>"
},
"PhysicalConnectionRequirements":{
"shape":"PhysicalConnectionRequirements",
"documentation":"<p>A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.</p>"
"documentation":"<p>A map of physical connection requirements, such as virtual private cloud (VPC) and <code>SecurityGroup</code>, that are needed to make this connection successfully.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>The time this connection definition was created.</p>"
"documentation":"<p>The time that this connection definition was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time this connection definition was updated.</p>"
"documentation":"<p>The last time that this connection definition was updated.</p>"
},
"LastUpdatedBy":{
"shape":"NameString",
"documentation":"<p>The user, group or role that last updated this connection definition.</p>"
"documentation":"<p>The user, group, or role that last updated this connection definition.</p>"
}
},
"documentation":"<p>Defines a connection to a data source.</p>"
@ -2131,7 +2392,7 @@
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>Description of the connection.</p>"
"documentation":"<p>The description of the connection.</p>"
},
"ConnectionType":{
"shape":"ConnectionType",
@ -2147,10 +2408,10 @@
},
"PhysicalConnectionRequirements":{
"shape":"PhysicalConnectionRequirements",
"documentation":"<p>A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.</p>"
"documentation":"<p>A map of physical connection requirements, such as virtual private cloud (VPC) and <code>SecurityGroup</code>, that are needed to successfully make this connection.</p>"
}
},
"documentation":"<p>A structure used to specify a connection to create or update.</p>"
"documentation":"<p>A structure that is used to specify a connection to create or update.</p>"
},
"ConnectionList":{
"type":"list",
@ -2167,10 +2428,10 @@
},
"AwsKmsKeyId":{
"shape":"NameString",
"documentation":"<p>A KMS key used to protect access to the JDBC source. </p> <p>All users in your account should be granted the <code>kms:encrypt</code> permission to encrypt passwords before storing them in the Data Catalog (through the AWS Glue <code>CreateConnection</code> operation).</p> <p>The decrypt permission should be granted only to KMS key admins and IAM roles designated for AWS Glue crawlers.</p>"
"documentation":"<p>An AWS KMS key that is used to encrypt the connection password. </p> <p>If connection password protection is enabled, the caller of <code>CreateConnection</code> and <code>UpdateConnection</code> needs at least <code>kms:Encrypt</code> permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog. </p> <p>You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.</p>"
}
},
"documentation":"<p>The data structure used by the Data Catalog to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p> <p>When a <code>CreationConnection</code> request arrives containing a password, the Data Catalog first encrypts the password using your KMS key, and then encrypts the whole connection object again if catalog encryption is also enabled.</p> <p>This encryption requires that you set KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you may want only admin users to have decrypt permission on the password key.</p>"
"documentation":"<p>The data structure used by the Data Catalog to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p> <p>When a <code>CreationConnection</code> request arrives containing a password, the Data Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.</p> <p>This encryption requires that you set AWS KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only admin users to have decrypt permission on the password key.</p>"
},
"ConnectionProperties":{
"type":"map",
@ -2433,7 +2694,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by default.</p>"
},
"ConnectionInput":{
"shape":"ConnectionInput",
@ -2498,6 +2759,10 @@
"CrawlerSecurityConfiguration":{
"shape":"CrawlerSecurityConfiguration",
"documentation":"<p>The name of the SecurityConfiguration structure to be used by this Crawler.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in AWS Glue, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">AWS Tags in AWS Glue</a> in the developer guide.</p>"
}
}
},
@ -2571,6 +2836,10 @@
"SecurityConfiguration":{
"shape":"NameString",
"documentation":"<p>The name of the SecurityConfiguration structure to be used with this DevEndpoint.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">AWS Tags in AWS Glue</a> in the developer guide.</p>"
}
}
},
@ -2712,12 +2981,18 @@
},
"AllocatedCapacity":{
"shape":"IntegerValue",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>"
"documentation":"<p>This parameter is deprecated. Use <code>MaxCapacity</code> instead.</p> <p>The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"deprecated":true,
"deprecatedMessage":"This property is deprecated, use MaxCapacity instead."
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
},
"MaxCapacity":{
"shape":"NullableDouble",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p> <p>The value that can be allocated for <code>MaxCapacity</code> depends on whether you are running a python shell job, or an Apache Spark ETL job:</p> <ul> <li> <p>When you specify a python shell job (<code>JobCommand.Name</code>=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.</p> </li> <li> <p>When you specify an Apache Spark ETL job (<code>JobCommand.Name</code>=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.</p> </li> </ul>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job notification.</p>"
@ -2725,6 +3000,10 @@
"SecurityConfiguration":{
"shape":"NameString",
"documentation":"<p>The name of the SecurityConfiguration structure to be used with this job.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">AWS Tags in AWS Glue</a> in the developer guide.</p>"
}
}
},
@ -2907,6 +3186,10 @@
"StartOnCreation":{
"shape":"BooleanValue",
"documentation":"<p>Set to true to start SCHEDULED and CONDITIONAL triggers when created. True not supported for ON_DEMAND triggers.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">AWS Tags in AWS Glue</a> in the developer guide. </p>"
}
}
},
@ -2987,11 +3270,11 @@
"members":{
"EncryptionAtRest":{
"shape":"EncryptionAtRest",
"documentation":"<p>Specifies encryption-at-rest configuration for the Data Catalog.</p>"
"documentation":"<p>Specifies the encryption-at-rest configuration for the Data Catalog.</p>"
},
"ConnectionPasswordEncryption":{
"shape":"ConnectionPasswordEncryption",
"documentation":"<p>When password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p>"
"documentation":"<p>When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of <code>CreateConnection</code> or <code>UpdateConnection</code> and store it in the <code>ENCRYPTED_PASSWORD</code> field in the connection properties. You can enable catalog encryption or only password encryption.</p>"
}
},
"documentation":"<p>Contains configuration information for maintaining Data Catalog security.</p>"
@ -3086,7 +3369,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.</p>"
},
"ConnectionName":{
"shape":"NameString",
@ -3449,6 +3732,16 @@
"type":"list",
"member":{"shape":"DevEndpoint"}
},
"DevEndpointNameList":{
"type":"list",
"member":{"shape":"NameString"}
},
"DevEndpointNames":{
"type":"list",
"member":{"shape":"GenericString"},
"max":25,
"min":1
},
"DynamoDBTarget":{
"type":"structure",
"members":{
@ -3476,7 +3769,7 @@
"documentation":"<p>The ID of the AWS KMS key to use for encryption at rest.</p>"
}
},
"documentation":"<p>Specifies encryption-at-rest configuration for the Data Catalog.</p>"
"documentation":"<p>Specifies the encryption-at-rest configuration for the Data Catalog.</p>"
},
"EncryptionConfiguration":{
"type":"structure",
@ -3633,7 +3926,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.</p>"
},
"Name":{
"shape":"NameString",
@ -3641,7 +3934,7 @@
},
"HidePassword":{
"shape":"Boolean",
"documentation":"<p>Allow you to retrieve the connection metadata without displaying the password. For instance, the AWS Glue console uses this flag to retrieve connections, since the console does not display passwords. Set this parameter where the caller may not have permission to use the KMS key to decrypt the password, but does have permission to access the rest of the connection metadata (that is, the other connection properties).</p>"
"documentation":"<p>Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.</p>"
}
}
},
@ -3666,14 +3959,14 @@
"documentation":"<p>The type of connections to return. Currently, only JDBC is supported; SFTP is not supported.</p>"
}
},
"documentation":"<p>Filters the connection definitions returned by the <code>GetConnections</code> API.</p>"
"documentation":"<p>Filters the connection definitions that are returned by the <code>GetConnections</code> API operation.</p>"
},
"GetConnectionsRequest":{
"type":"structure",
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which the connections reside. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.</p>"
},
"Filter":{
"shape":"GetConnectionsFilter",
@ -3681,7 +3974,7 @@
},
"HidePassword":{
"shape":"Boolean",
"documentation":"<p>Allow you to retrieve the connection metadata without displaying the password. For instance, the AWS Glue console uses this flag to retrieve connections, since the console does not display passwords. Set this parameter where the caller may not have permission to use the KMS key to decrypt the password, but does have permission to access the rest of the connection metadata (that is, the other connection properties).</p>"
"documentation":"<p>Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.</p>"
},
"NextToken":{
"shape":"Token",
@ -3786,7 +4079,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog for which to retrieve the security configuration. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog for which to retrieve the security configuration. If none is provided, the AWS account ID is used by default.</p>"
}
}
},
@ -4401,6 +4694,25 @@
}
}
},
"GetTagsRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"GlueResourceArn",
"documentation":"<p>The Amazon ARN of the resource for which to retrieve tags.</p>"
}
}
},
"GetTagsResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagsMap",
"documentation":"<p>The requested tags.</p>"
}
}
},
"GetTriggerRequest":{
"type":"structure",
"required":["Name"],
@ -4533,6 +4845,12 @@
"documentation":"<p>An encryption operation failed.</p>",
"exception":true
},
"GlueResourceArn":{
"type":"string",
"max":10240,
"min":1,
"pattern":"arn:aws:glue:.*"
},
"GrokClassifier":{
"type":"structure",
"required":[
@ -4716,12 +5034,18 @@
},
"AllocatedCapacity":{
"shape":"IntegerValue",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>"
"documentation":"<p>This field is deprecated, use <code>MaxCapacity</code> instead.</p> <p>The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p> <p/>",
"deprecated":true,
"deprecatedMessage":"This property is deprecated, use MaxCapacity instead."
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
},
"MaxCapacity":{
"shape":"NullableDouble",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p> <p>The value that can be allocated for <code>MaxCapacity</code> depends on whether you are running a python shell job, or an Apache Spark ETL job:</p> <ul> <li> <p>When you specify a python shell job (<code>JobCommand.Name</code>=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.</p> </li> <li> <p>When you specify an Apache Spark ETL job (<code>JobCommand.Name</code>=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.</p> </li> </ul>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job notification.</p>"
@ -4785,7 +5109,7 @@
"members":{
"Name":{
"shape":"GenericString",
"documentation":"<p>The name of the job command: this must be <code>glueetl</code>.</p>"
"documentation":"<p>The name of the job command: this must be <code>glueetl</code>, for an Apache Spark ETL job, or <code>pythonshell</code>, for a Python shell job.</p>"
},
"ScriptLocation":{
"shape":"ScriptLocationString",
@ -4799,6 +5123,10 @@
"member":{"shape":"Job"}
},
"JobName":{"type":"string"},
"JobNameList":{
"type":"list",
"member":{"shape":"NameString"}
},
"JobRun":{
"type":"structure",
"members":{
@ -4840,7 +5168,7 @@
},
"Arguments":{
"shape":"GenericMap",
"documentation":"<p>The job arguments associated with this run. These override equivalent default arguments set for the job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
"documentation":"<p>The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
},
"ErrorMessage":{
"shape":"ErrorString",
@ -4852,7 +5180,9 @@
},
"AllocatedCapacity":{
"shape":"IntegerValue",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>"
"documentation":"<p>This field is deprecated, use <code>MaxCapacity</code> instead.</p> <p>The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"deprecated":true,
"deprecatedMessage":"This property is deprecated, use MaxCapacity instead."
},
"ExecutionTime":{
"shape":"ExecutionTime",
@ -4862,6 +5192,10 @@
"shape":"Timeout",
"documentation":"<p>The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.</p>"
},
"MaxCapacity":{
"shape":"NullableDouble",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p> <p>The value that can be allocated for <code>MaxCapacity</code> depends on whether you are running a python shell job, or an Apache Spark ETL job:</p> <ul> <li> <p>When you specify a python shell job (<code>JobCommand.Name</code>=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.</p> </li> <li> <p>When you specify an Apache Spark ETL job (<code>JobCommand.Name</code>=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.</p> </li> </ul>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job run notification.</p>"
@ -4930,12 +5264,18 @@
},
"AllocatedCapacity":{
"shape":"IntegerValue",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>"
"documentation":"<p>This field is deprecated. Use <code>MaxCapacity</code> instead.</p> <p>The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"deprecated":true,
"deprecatedMessage":"This property is deprecated, use MaxCapacity instead."
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
},
"MaxCapacity":{
"shape":"NullableDouble",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p> <p>The value that can be allocated for <code>MaxCapacity</code> depends on whether you are running a python shell job, or an Apache Spark ETL job:</p> <ul> <li> <p>When you specify a python shell job (<code>JobCommand.Name</code>=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.</p> </li> <li> <p>When you specify an Apache Spark ETL job (<code>JobCommand.Name</code>=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.</p> </li> </ul>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job notification.</p>"
@ -5034,6 +5374,130 @@
"FAILED"
]
},
"ListCrawlersRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"PageSize",
"documentation":"<p>The maximum size of a list to return.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A continuation token, if this is a continuation request.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>Specifies to return only these tagged resources.</p>"
}
}
},
"ListCrawlersResponse":{
"type":"structure",
"members":{
"CrawlerNames":{
"shape":"CrawlerNameList",
"documentation":"<p>The names of all crawlers in the account, or the crawlers with the specified tags.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A continuation token, if the returned list does not contain the last metric available.</p>"
}
}
},
"ListDevEndpointsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"GenericString",
"documentation":"<p>A continuation token, if this is a continuation request.</p>"
},
"MaxResults":{
"shape":"PageSize",
"documentation":"<p>The maximum size of a list to return.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>Specifies to return only these tagged resources.</p>"
}
}
},
"ListDevEndpointsResponse":{
"type":"structure",
"members":{
"DevEndpointNames":{
"shape":"DevEndpointNameList",
"documentation":"<p>The names of all DevEndpoints in the account, or the DevEndpoints with the specified tags.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>A continuation token, if the returned list does not contain the last metric available.</p>"
}
}
},
"ListJobsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"GenericString",
"documentation":"<p>A continuation token, if this is a continuation request.</p>"
},
"MaxResults":{
"shape":"PageSize",
"documentation":"<p>The maximum size of a list to return.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>Specifies to return only these tagged resources.</p>"
}
}
},
"ListJobsResponse":{
"type":"structure",
"members":{
"JobNames":{
"shape":"JobNameList",
"documentation":"<p>The names of all jobs in the account, or the jobs with the specified tags.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>A continuation token, if the returned list does not contain the last metric available.</p>"
}
}
},
"ListTriggersRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"GenericString",
"documentation":"<p>A continuation token, if this is a continuation request.</p>"
},
"DependentJobName":{
"shape":"NameString",
"documentation":"<p> The name of the job for which to retrieve triggers. The trigger that can start this job will be returned, and if there is no such trigger, all triggers will be returned.</p>"
},
"MaxResults":{
"shape":"PageSize",
"documentation":"<p>The maximum size of a list to return.</p>"
},
"Tags":{
"shape":"TagsMap",
"documentation":"<p>Specifies to return only these tagged resources.</p>"
}
}
},
"ListTriggersResponse":{
"type":"structure",
"members":{
"TriggerNames":{
"shape":"TriggerNameList",
"documentation":"<p>The names of all triggers in the account, or the triggers with the specified tags.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>A continuation token, if the returned list does not contain the last metric available.</p>"
}
}
},
"Location":{
"type":"structure",
"members":{
@ -5179,6 +5643,10 @@
"box":true,
"min":1
},
"NullableDouble":{
"type":"double",
"box":true
},
"OperationTimeoutException":{
"type":"structure",
"members":{
@ -5288,7 +5756,7 @@
"members":{
"Values":{
"shape":"ValueStringList",
"documentation":"<p>The values of the partition.</p>"
"documentation":"<p>The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.</p>"
},
"LastAccessTime":{
"shape":"Timestamp",
@ -5348,7 +5816,7 @@
},
"AvailabilityZone":{
"shape":"NameString",
"documentation":"<p>The connection's availability zone. This field is redundant, since the specified subnet implies the availability zone to be used. The field must be populated now, but will be deprecated in the future.</p>"
"documentation":"<p>The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.</p>"
}
},
"documentation":"<p>Specifies the physical requirements for a connection.</p>"
@ -5415,7 +5883,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog for which to set the security configuration. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog for which to set the security configuration. If none is provided, the AWS account ID is used by default.</p>"
},
"DataCatalogEncryptionSettings":{
"shape":"DataCatalogEncryptionSettings",
@ -5438,7 +5906,7 @@
},
"PolicyHashCondition":{
"shape":"HashString",
"documentation":"<p>This is the hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.</p>"
"documentation":"<p>The hash value returned when the previous policy was set using <code>PutResourcePolicy</code>. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.</p>"
},
"PolicyExistsCondition":{
"shape":"ExistCondition",
@ -5763,16 +6231,22 @@
},
"Arguments":{
"shape":"GenericMap",
"documentation":"<p>The job arguments specifically for this run. They override the equivalent default arguments set for in the job definition itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
"documentation":"<p>The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
},
"AllocatedCapacity":{
"shape":"IntegerValue",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>"
"documentation":"<p>This field is deprecated, use <code>MaxCapacity</code> instead.</p> <p>The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"deprecated":true,
"deprecatedMessage":"This property is deprecated, use MaxCapacity instead."
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.</p>"
},
"MaxCapacity":{
"shape":"NullableDouble",
"documentation":"<p>The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p> <p>The value that can be allocated for <code>MaxCapacity</code> depends on whether you are running a python shell job, or an Apache Spark ETL job:</p> <ul> <li> <p>When you specify a python shell job (<code>JobCommand.Name</code>=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.</p> </li> <li> <p>When you specify an Apache Spark ETL job (<code>JobCommand.Name</code>=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.</p> </li> </ul>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job run notification.</p>"
@ -6112,6 +6586,51 @@
"type":"list",
"member":{"shape":"TableVersionError"}
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeysList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagsToAdd"
],
"members":{
"ResourceArn":{
"shape":"GlueResourceArn",
"documentation":"<p>The ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id\">AWS Glue ARN string pattern</a>.</p>"
},
"TagsToAdd":{
"shape":"TagsMap",
"documentation":"<p>Tags to add to this resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"TagsMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50,
"min":0
},
"Timeout":{
"type":"integer",
"box":true,
@ -6167,6 +6686,10 @@
"type":"list",
"member":{"shape":"Trigger"}
},
"TriggerNameList":{
"type":"list",
"member":{"shape":"NameString"}
},
"TriggerState":{
"type":"string",
"enum":[
@ -6220,6 +6743,28 @@
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagsToRemove"
],
"members":{
"ResourceArn":{
"shape":"GlueResourceArn",
"documentation":"<p>The ARN of the resource from which to remove the tags.</p>"
},
"TagsToRemove":{
"shape":"TagKeysList",
"documentation":"<p>Tags to remove from this resource.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateBehavior":{
"type":"string",
"enum":[
@ -6258,7 +6803,7 @@
"members":{
"CatalogId":{
"shape":"CatalogIdString",
"documentation":"<p>The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.</p>"
"documentation":"<p>The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.</p>"
},
"Name":{
"shape":"NameString",

118
botocore/data/greengrass/2017-06-07/paginators-1.json Normal file
View file

@ -0,0 +1,118 @@
{
"pagination": {
"ListBulkDeploymentDetailedReports": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Deployments"
},
"ListBulkDeployments": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "BulkDeployments"
},
"ListConnectorDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListConnectorDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
},
"ListCoreDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListCoreDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
},
"ListDeployments": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Deployments"
},
"ListDeviceDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListDeviceDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
},
"ListFunctionDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListFunctionDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
},
"ListGroupVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Groups"
},
"ListLoggerDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListLoggerDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
},
"ListResourceDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListResourceDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
},
"ListSubscriptionDefinitionVersions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Versions"
},
"ListSubscriptionDefinitions": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Definitions"
}
}
}

6
botocore/data/inspector/2016-02-16/paginators-1.json
View file

@ -47,6 +47,12 @@
"output_token": "nextToken",
"input_token": "nextToken",
"limit_key": "maxResults"
},
"ListExclusions": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "exclusionArns"
}
}
}

155
botocore/data/iot/2015-05-28/paginators-1.json
View file

@ -65,6 +65,161 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "rules"
},
"ListActiveViolations": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "activeViolations"
},
"ListAttachedPolicies": {
"input_token": "marker",
"limit_key": "pageSize",
"output_token": "nextMarker",
"result_key": "policies"
},
"ListAuditFindings": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "findings"
},
"ListAuditTasks": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "tasks"
},
"ListAuthorizers": {
"input_token": "marker",
"limit_key": "pageSize",
"output_token": "nextMarker",
"result_key": "authorizers"
},
"ListBillingGroups": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "billingGroups"
},
"ListIndices": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "indexNames"
},
"ListJobExecutionsForJob": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "executionSummaries"
},
"ListJobExecutionsForThing": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "executionSummaries"
},
"ListJobs": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "jobs"
},
"ListOTAUpdates": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "otaUpdates"
},
"ListRoleAliases": {
"input_token": "marker",
"limit_key": "pageSize",
"output_token": "nextMarker",
"result_key": "roleAliases"
},
"ListScheduledAudits": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "scheduledAudits"
},
"ListSecurityProfiles": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "securityProfileIdentifiers"
},
"ListSecurityProfilesForTarget": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "securityProfileTargetMappings"
},
"ListStreams": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "streams"
},
"ListTagsForResource": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "tags"
},
"ListTargetsForPolicy": {
"input_token": "marker",
"limit_key": "pageSize",
"output_token": "nextMarker",
"result_key": "targets"
},
"ListTargetsForSecurityProfile": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "securityProfileTargets"
},
"ListThingGroups": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "thingGroups"
},
"ListThingGroupsForThing": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "thingGroups"
},
"ListThingRegistrationTasks": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "taskIds"
},
"ListThingsInBillingGroup": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "things"
},
"ListThingsInThingGroup": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "things"
},
"ListV2LoggingLevels": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "logTargetConfigurations"
},
"ListViolationEvents": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "violationEvents"
}
}
}

150
botocore/data/iot/2015-05-28/service-2.json
View file

@ -149,7 +149,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Attaches the specified principal to the specified thing.</p>"
"documentation":"<p>Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.</p>"
},
"CancelAuditTask":{
"name":"CancelAuditTask",
@ -489,7 +489,7 @@
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates a thing record in the registry.</p> <note> <p>This is a control plane operation. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
"documentation":"<p>Creates a thing record in the registry.</p> <note> <p>This is a control plane operation. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
},
"CreateThingGroup":{
"name":"CreateThingGroup",
@ -505,7 +505,7 @@
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Create a thing group.</p> <note> <p>This is a control plane operation. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
"documentation":"<p>Create a thing group.</p> <note> <p>This is a control plane operation. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
},
"CreateThingType":{
"name":"CreateThingType",
@ -1325,7 +1325,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Detaches the specified principal from the specified thing.</p> <note> <p>This call is asynchronous. It might take several seconds for the detachment to propagate.</p> </note>"
"documentation":"<p>Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.</p> <note> <p>This call is asynchronous. It might take several seconds for the detachment to propagate.</p> </note>"
},
"DisableTopicRule":{
"name":"DisableTopicRule",
@ -1846,7 +1846,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in <a href=\"http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax\">AmazonCognito Identity format</a>.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>ListAttachedPolicies</a> instead.</p>",
"documentation":"<p>Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in <a href=\"https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax\">AmazonCognito Identity format</a>.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>ListAttachedPolicies</a> instead.</p>",
"deprecated":true
},
"ListPrincipalThings":{
@ -1865,7 +1865,7 @@
{"shape":"InternalFailureException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the things associated with the specified principal.</p>"
"documentation":"<p>Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. </p>"
},
"ListRoleAliases":{
"name":"ListRoleAliases",
@ -2044,7 +2044,7 @@
{"shape":"InternalFailureException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the principals associated with the specified thing.</p>"
"documentation":"<p>Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.</p>"
},
"ListThingRegistrationTaskReports":{
"name":"ListThingRegistrationTaskReports",
@ -3095,6 +3095,10 @@
"members":{
}
},
"AdditionalMetricsToRetainList":{
"type":"list",
"member":{"shape":"BehaviorMetric"}
},
"AdditionalParameterMap":{
"type":"map",
"key":{"shape":"AttributeKey"},
@ -3693,7 +3697,7 @@
"members":{
"comparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"<p>The operator that relates the thing measured (<code>metric</code>) to the criteria (<code>value</code>).</p>"
"documentation":"<p>The operator that relates the thing measured (<code>metric</code>) to the criteria (containing a <code>value</code> or <code>statisticalThreshold</code>).</p>"
},
"value":{
"shape":"MetricValue",
@ -3701,7 +3705,19 @@
},
"durationSeconds":{
"shape":"DurationSeconds",
"documentation":"<p>Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>).</p>"
"documentation":"<p>Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>). For a <code>statisticalThreshhold</code> metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.</p>"
},
"consecutiveDatapointsToAlarm":{
"shape":"ConsecutiveDatapointsToAlarm",
"documentation":"<p>If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.</p>"
},
"consecutiveDatapointsToClear":{
"shape":"ConsecutiveDatapointsToClear",
"documentation":"<p>If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.</p>"
},
"statisticalThreshold":{
"shape":"StatisticalThreshold",
"documentation":"<p>A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.</p>"
}
},
"documentation":"<p>The criteria by which the behavior is determined to be normal.</p>"
@ -4211,11 +4227,11 @@
},
"metricUnit":{
"shape":"String",
"documentation":"<p>The <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit\">metric unit</a> supported by CloudWatch.</p>"
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit\">metric unit</a> supported by CloudWatch.</p>"
},
"metricTimestamp":{
"shape":"String",
"documentation":"<p>An optional <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Unix timestamp</a>.</p>"
"documentation":"<p>An optional <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Unix timestamp</a>.</p>"
}
},
"documentation":"<p>Describes an action that captures a CloudWatch metric.</p>"
@ -4306,6 +4322,16 @@
"exception":true
},
"ConnectivityTimestamp":{"type":"long"},
"ConsecutiveDatapointsToAlarm":{
"type":"integer",
"max":10,
"min":1
},
"ConsecutiveDatapointsToClear":{
"type":"integer",
"max":10,
"min":1
},
"Count":{"type":"integer"},
"CreateAuthorizerRequest":{
"type":"structure",
@ -4448,7 +4474,7 @@
},
"queryString":{
"shape":"QueryString",
"documentation":"<p>The dynamic thing group search query string.</p> <p>See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html\">Query Syntax</a> for information about query string syntax.</p>"
"documentation":"<p>The dynamic thing group search query string.</p> <p>See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html\">Query Syntax</a> for information about query string syntax.</p>"
},
"queryVersion":{
"shape":"QueryVersion",
@ -4815,6 +4841,10 @@
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata which can be used to manage the scheduled audit.</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>",
@ -4834,10 +4864,7 @@
},
"CreateSecurityProfileRequest":{
"type":"structure",
"required":[
"securityProfileName",
"behaviors"
],
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
@ -4857,6 +4884,10 @@
"shape":"AlertTargets",
"documentation":"<p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.</p>"
},
"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>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata which can be used to manage the security profile.</p>"
@ -5064,6 +5095,12 @@
"topicRulePayload":{
"shape":"TopicRulePayload",
"documentation":"<p>The rule payload.</p>"
},
"tags":{
"shape":"String",
"documentation":"<p>Metadata which can be used to manage the topic rule.</p> <note> <p>For URI Request parameters use format: ...key1=value1&amp;key2=value2...</p> <p>For the CLI command-line parameter use format: --tags \"key1=value1&amp;key2=value2...\"</p> <p>For the cli-input-json file use format: \"tags\": \"key1=value1&amp;key2=value2...\"</p> </note>",
"location":"header",
"locationName":"x-amz-tagging"
}
},
"documentation":"<p>The input for the CreateTopicRule operation.</p>",
@ -5135,6 +5172,8 @@
"members":{
}
},
"DeleteAdditionalMetricsToRetain":{"type":"boolean"},
"DeleteAlertTargets":{"type":"boolean"},
"DeleteAuthorizerRequest":{
"type":"structure",
"required":["authorizerName"],
@ -5152,6 +5191,7 @@
"members":{
}
},
"DeleteBehaviors":{"type":"boolean"},
"DeleteBillingGroupRequest":{
"type":"structure",
"required":["billingGroupName"],
@ -6012,6 +6052,10 @@
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"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>"
},
"version":{
"shape":"Version",
"documentation":"<p>The version of the security profile. A new version is generated whenever the security profile is updated.</p>"
@ -6459,6 +6503,10 @@
},
"DynamoDBv2Action":{
"type":"structure",
"required":[
"roleArn",
"putItem"
],
"members":{
"roleArn":{
"shape":"AwsArn",
@ -6576,6 +6624,10 @@
"type":"string",
"max":2048
},
"EvaluationStatistic":{
"type":"string",
"pattern":"(p0|p0\\.1|p0\\.01|p1|p10|p50|p90|p99|p99\\.9|p99\\.99|p100)"
},
"EventConfigurations":{
"type":"map",
"key":{"shape":"EventType"},
@ -7220,15 +7272,15 @@
},
"createdAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was created.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job was created.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was last updated.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job was last updated.</p>"
},
"completedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was completed.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job was completed.</p>"
},
"jobProcessDetails":{
"shape":"JobProcessDetails",
@ -7281,15 +7333,15 @@
},
"queuedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was queued.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job execution was queued.</p>"
},
"startedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution started.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job execution started.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job execution was last updated.</p>"
},
"executionNumber":{
"shape":"ExecutionNumber",
@ -7347,15 +7399,15 @@
},
"queuedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was queued.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job execution was queued.</p>"
},
"startedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution started.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job execution started.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job execution was last updated.</p>"
},
"executionNumber":{
"shape":"ExecutionNumber",
@ -7496,15 +7548,15 @@
},
"createdAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was created.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job was created.</p>"
},
"lastUpdatedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job was last updated.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job was last updated.</p>"
},
"completedAt":{
"shape":"DateType",
"documentation":"<p>The time, in milliseconds since the epoch, when the job completed.</p>"
"documentation":"<p>The time, in seconds since the epoch, when the job completed.</p>"
}
},
"documentation":"<p>The job summary.</p>"
@ -9842,11 +9894,11 @@
"members":{
"templateBody":{
"shape":"TemplateBody",
"documentation":"<p>The provisioning template. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
"documentation":"<p>The provisioning template. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
},
"parameters":{
"shape":"Parameters",
"documentation":"<p>The parameters for provisioning a thing. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
"documentation":"<p>The parameters for provisioning a thing. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
}
}
},
@ -10234,7 +10286,7 @@
},
"cannedAcl":{
"shape":"CannedAccessControlList",
"documentation":"<p>The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl\">S3 canned ACLs</a>.</p>"
"documentation":"<p>The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl\">S3 canned ACLs</a>.</p>"
}
},
"documentation":"<p>Describes an action to write data to an Amazon S3 bucket.</p>"
@ -10620,7 +10672,7 @@
},
"messageFormat":{
"shape":"MessageFormat",
"documentation":"<p>(Optional) The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/json-formats.html\">http://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</p>"
"documentation":"<p>(Optional) The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/json-formats.html\">https://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation.</p>"
}
},
"documentation":"<p>Describes an action to publish to an Amazon SNS topic.</p>"
@ -10735,6 +10787,16 @@
"StateMachineName":{"type":"string"},
"StateReason":{"type":"string"},
"StateValue":{"type":"string"},
"StatisticalThreshold":{
"type":"structure",
"members":{
"statistic":{
"shape":"EvaluationStatistic",
"documentation":"<p>The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (<code>durationSeconds</code>) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (<code>comparisonOperator</code>) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.</p>"
}
},
"documentation":"<p>A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.</p>"
},
"Status":{
"type":"string",
"enum":[
@ -11530,7 +11592,7 @@
"members":{
"sql":{
"shape":"SQL",
"documentation":"<p>The SQL statement used to query the topic. For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference\">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</p>"
"documentation":"<p>The SQL statement used to query the topic. For more information, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference\">AWS IoT SQL Reference</a> in the <i>AWS IoT Developer Guide</i>.</p>"
},
"description":{
"shape":"Description",
@ -12032,6 +12094,22 @@
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"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>"
},
"deleteBehaviors":{
"shape":"DeleteBehaviors",
"documentation":"<p>If true, delete all <code>behaviors</code> defined for this security profile. If any <code>behaviors</code> are defined in the current invocation an exception occurs.</p>"
},
"deleteAlertTargets":{
"shape":"DeleteAlertTargets",
"documentation":"<p>If true, delete all <code>alertTargets</code> defined for this security profile. If any <code>alertTargets</code> are defined in the current invocation an exception occurs.</p>"
},
"deleteAdditionalMetricsToRetain":{
"shape":"DeleteAdditionalMetricsToRetain",
"documentation":"<p>If true, delete all <code>additionalMetricsToRetain</code> defined for this security profile. If any <code>additionalMetricsToRetain</code> are defined in the current invocation an exception occurs.</p>"
},
"expectedVersion":{
"shape":"OptionalVersion",
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
@ -12063,6 +12141,10 @@
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"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>"
},
"version":{
"shape":"Version",
"documentation":"<p>The updated version of the security profile.</p>"
@ -12338,5 +12420,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=\"http://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=\"http://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>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>"
}

16
botocore/data/iot1click-devices/2018-05-14/paginators-1.json Normal file
View file

@ -0,0 +1,16 @@
{
"pagination": {
"ListDeviceEvents": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Events"
},
"ListDevices": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Devices"
}
}
}

15
botocore/data/iot1click-projects/2018-05-14/paginators-1.json
View file

@ -1,3 +1,16 @@
{
"pagination": {}
"pagination": {
"ListPlacements": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "placements"
},
"ListProjects": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "projects"
}
}
}

33
botocore/data/iotanalytics/2017-11-27/paginators-1.json
View file

@ -1,3 +1,34 @@
{
"pagination": {}
"pagination": {
"ListChannels": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "channelSummaries"
},
"ListDatasetContents": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "datasetContentSummaries"
},
"ListDatasets": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "datasetSummaries"
},
"ListDatastores": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "datastoreSummaries"
},
"ListPipelines": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "pipelineSummaries"
}
}
}

95
botocore/data/iotanalytics/2017-11-27/service-2.json
View file

@ -99,7 +99,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Creates the content of a data set by applying a SQL action.</p>"
"documentation":"<p>Creates the content of a data set by applying a \"queryAction\" (a SQL query) or a \"containerAction\" (executing a containerized application).</p>"
},
"CreateDatastore":{
"name":"CreateDatastore",
@ -681,7 +681,7 @@
},
"messages":{
"shape":"Messages",
"documentation":"<p>The list of messages to be sent. Each message has format: '{ \"messageId\": \"string\", \"payload\": \"string\"}'.</p>"
"documentation":"<p>The list of messages to be sent. Each message has format: '{ \"messageId\": \"string\", \"payload\": \"string\"}'.</p> <p>Note that the field names of message payloads (data) that you send to AWS IoT Analytics:</p> <ul> <li> <p>Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.</p> </li> <li> <p>Must begin with an alphabetic character or single underscore (_).</p> </li> <li> <p>Cannot contain hyphens (-).</p> </li> <li> <p>In regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\". </p> </li> <li> <p>Cannot be greater than 255 characters.</p> </li> <li> <p>Are case-insensitive. (Fields named \"foo\" and \"FOO\" in the same payload are considered duplicates.)</p> </li> </ul> <p>For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads. </p>"
}
}
},
@ -932,7 +932,10 @@
"shape":"DatasetTriggers",
"documentation":"<p>A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five <b>DataSetTrigger</b> objects.</p>"
},
"contentDeliveryRules":{"shape":"DatasetContentDeliveryRules"},
"contentDeliveryRules":{
"shape":"DatasetContentDeliveryRules",
"documentation":"<p>When data set contents are created they are delivered to destinations specified here.</p>"
},
"retentionPeriod":{
"shape":"RetentionPeriod",
"documentation":"<p>[Optional] How long, in days, message data is kept for the data set. If not given or set to null, the latest version of the dataset content plus the latest succeeded version (if they are different) are retained for at most 90 days.</p>"
@ -1048,7 +1051,10 @@
"shape":"DatasetTriggers",
"documentation":"<p>The \"DatasetTrigger\" objects that specify when the data set is automatically updated.</p>"
},
"contentDeliveryRules":{"shape":"DatasetContentDeliveryRules"},
"contentDeliveryRules":{
"shape":"DatasetContentDeliveryRules",
"documentation":"<p>When data set contents are created they are delivered to destinations specified here.</p>"
},
"status":{
"shape":"DatasetStatus",
"documentation":"<p>The status of the data set.</p>"
@ -1077,14 +1083,14 @@
},
"queryAction":{
"shape":"SqlQueryDatasetAction",
"documentation":"<p>An \"SqlQueryDatasetAction\" object that contains the SQL query to modify the message.</p>"
"documentation":"<p>An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.</p>"
},
"containerAction":{
"shape":"ContainerDatasetAction",
"documentation":"<p>Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.</p>"
}
},
"documentation":"<p>A \"DatasetAction\" object specifying the query that creates the data set content.</p>"
"documentation":"<p>A \"DatasetAction\" object that specifies how data set contents are automatically created.</p>"
},
"DatasetActionName":{
"type":"string",
@ -1129,16 +1135,27 @@
"DatasetContentDeliveryDestination":{
"type":"structure",
"members":{
"iotEventsDestinationConfiguration":{"shape":"IotEventsDestinationConfiguration"}
}
"iotEventsDestinationConfiguration":{
"shape":"IotEventsDestinationConfiguration",
"documentation":"<p>Configuration information for delivery of data set contents to AWS IoT Events.</p>"
}
},
"documentation":"<p>The destination to which data set contents are delivered.</p>"
},
"DatasetContentDeliveryRule":{
"type":"structure",
"required":["destination"],
"members":{
"entryName":{"shape":"EntryName"},
"destination":{"shape":"DatasetContentDeliveryDestination"}
}
"entryName":{
"shape":"EntryName",
"documentation":"<p>The name of the data set content delivery rules entry.</p>"
},
"destination":{
"shape":"DatasetContentDeliveryDestination",
"documentation":"<p>The destination to which data set contents are delivered.</p>"
}
},
"documentation":"<p>When data set contents are created they are delivered to destination specified here.</p>"
},
"DatasetContentDeliveryRules":{
"type":"list",
@ -1205,10 +1222,10 @@
"members":{
"datasetName":{
"shape":"DatasetName",
"documentation":"<p>The name of the data set whose latest contents will be used as input to the notebook or application.</p>"
"documentation":"<p>The name of the data set whose latest contents are used as input to the notebook or application.</p>"
}
},
"documentation":"<p>The data set whose latest contents will be used as input to the notebook or application.</p>"
"documentation":"<p>The data set whose latest contents are used as input to the notebook or application.</p>"
},
"DatasetEntries":{
"type":"list",
@ -1285,7 +1302,7 @@
},
"dataset":{
"shape":"TriggeringDataset",
"documentation":"<p>The data set whose content creation will trigger the creation of this data set's contents.</p>"
"documentation":"<p>The data set whose content creation triggers the creation of this data set's contents.</p>"
}
},
"documentation":"<p>The \"DatasetTrigger\" that specifies when the data set is automatically updated.</p>"
@ -1470,14 +1487,14 @@
"members":{
"offsetSeconds":{
"shape":"OffsetSeconds",
"documentation":"<p>The number of seconds of estimated \"in flight\" lag time of message data.</p>"
"documentation":"<p>The number of seconds of estimated \"in flight\" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.</p>"
},
"timeExpression":{
"shape":"TimeExpression",
"documentation":"<p>An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.</p>"
}
},
"documentation":"<p>When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of your message data, so that data not processed from the previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.</p>"
"documentation":"<p>Used to limit data to that which has arrived since the last execution of the action.</p>"
},
"DescribeChannelRequest":{
"type":"structure",
@ -1773,9 +1790,16 @@
"roleArn"
],
"members":{
"inputName":{"shape":"IotEventsInputName"},
"roleArn":{"shape":"RoleArn"}
}
"inputName":{
"shape":"IotEventsInputName",
"documentation":"<p>The name of the AWS IoT Events input to which data set contents are delivered.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.</p>"
}
},
"documentation":"<p>Configuration information for delivery of data set contents to AWS IoT Events.</p>"
},
"IotEventsInputName":{
"type":"string",
@ -1876,6 +1900,18 @@
"documentation":"<p>The maximum number of results to return in this request.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"scheduledOnOrAfter":{
"shape":"Timestamp",
"documentation":"<p>A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field <code>triggers.schedule</code> in the CreateDataset request. (timestamp)</p>",
"location":"querystring",
"locationName":"scheduledOnOrAfter"
},
"scheduledBefore":{
"shape":"Timestamp",
"documentation":"<p>A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field <code>triggers.schedule</code> in the CreateDataset request. (timestamp)</p>",
"location":"querystring",
"locationName":"scheduledBefore"
}
}
},
@ -2046,7 +2082,7 @@
},
"attribute":{
"shape":"AttributeName",
"documentation":"<p>The name of the attribute that will contain the result of the math operation.</p>"
"documentation":"<p>The name of the attribute that contains the result of the math operation.</p>"
},
"math":{
"shape":"MathExpression",
@ -2123,7 +2159,7 @@
"documentation":"<p>The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.</p>"
}
},
"documentation":"<p>The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.</p>"
"documentation":"<p>The value of the variable as a structure that specifies an output file URI.</p>"
},
"Pipeline":{
"type":"structure",
@ -2256,7 +2292,7 @@
"members":{
"deltaTime":{
"shape":"DeltaTime",
"documentation":"<p>Used to limit data to that which has arrived since the last execution of the action. When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of you message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.</p>"
"documentation":"<p>Used to limit data to that which has arrived since the last execution of the action.</p>"
}
},
"documentation":"<p>Information which is used to filter message data, to segregate it according to the time frame in which it arrives.</p>"
@ -2602,7 +2638,7 @@
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource whose tags will be modified.</p>",
"documentation":"<p>The ARN of the resource whose tags you want to modify.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
@ -2639,10 +2675,10 @@
"members":{
"name":{
"shape":"DatasetName",
"documentation":"<p>The name of the data set whose content generation will trigger the new data set content generation.</p>"
"documentation":"<p>The name of the data set whose content generation triggers the new data set content generation.</p>"
}
},
"documentation":"<p>Information about the data set whose content generation will trigger the new data set content generation.</p>"
"documentation":"<p>Information about the data set whose content generation triggers the new data set content generation.</p>"
},
"UnlimitedRetentionPeriod":{"type":"boolean"},
"UntagResourceRequest":{
@ -2654,13 +2690,13 @@
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource whose tags will be removed.</p>",
"documentation":"<p>The ARN of the resource whose tags you want to remove.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of those tags which will be removed.</p>",
"documentation":"<p>The keys of those tags which you want to remove.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
@ -2708,7 +2744,10 @@
"shape":"DatasetTriggers",
"documentation":"<p>A list of \"DatasetTrigger\" objects. The list can be empty or can contain up to five <b>DataSetTrigger</b> objects.</p>"
},
"contentDeliveryRules":{"shape":"DatasetContentDeliveryRules"},
"contentDeliveryRules":{
"shape":"DatasetContentDeliveryRules",
"documentation":"<p>When data set contents are created they are delivered to destinations specified here.</p>"
},
"retentionPeriod":{
"shape":"RetentionPeriod",
"documentation":"<p>How long, in days, message data is kept for the data set.</p>"

15
botocore/data/kafka/2018-11-14/paginators-1.json
View file

@ -1,3 +1,16 @@
{
"pagination": {}
"pagination": {
"ListClusters": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ClusterInfoList"
},
"ListNodes": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "NodeInfoList"
}
}
}

9
botocore/data/kinesis-video-archived-media/2017-09-30/paginators-1.json
View file

@ -1,3 +1,10 @@
{
"pagination": {}
"pagination": {
"ListFragments": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Fragments"
}
}
}

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