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

New upstream version 1.10.55+repack

Browse source
This commit is contained in:
Alexander Gerasiov 2018-07-11 09:25:50 +03:00
parent eae16722ce
commit d004fbc02a
135 changed files with 28082 additions and 2622 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.10.15
Version: 1.10.55
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.10.15
Version: 1.10.55
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

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

@ -47,6 +47,7 @@ botocore/data/acm-pca/2017-08-22/service-2.json
botocore/data/acm/2015-12-08/examples-1.json
botocore/data/acm/2015-12-08/paginators-1.json
botocore/data/acm/2015-12-08/service-2.json
botocore/data/acm/2015-12-08/waiters-2.json
botocore/data/alexaforbusiness/2017-11-09/paginators-1.json
botocore/data/alexaforbusiness/2017-11-09/service-2.json
botocore/data/apigateway/2015-07-09/examples-1.json
@ -80,6 +81,8 @@ botocore/data/cloud9/2017-09-23/paginators-1.json
botocore/data/cloud9/2017-09-23/service-2.json
botocore/data/clouddirectory/2016-05-10/paginators-1.json
botocore/data/clouddirectory/2016-05-10/service-2.json
botocore/data/clouddirectory/2017-01-11/paginators-1.json
botocore/data/clouddirectory/2017-01-11/service-2.json
botocore/data/cloudformation/2010-05-15/examples-1.json
botocore/data/cloudformation/2010-05-15/paginators-1.json
botocore/data/cloudformation/2010-05-15/service-2.json
@ -243,6 +246,8 @@ botocore/data/ecs/2014-11-13/waiters-2.json
botocore/data/efs/2015-02-01/examples-1.json
botocore/data/efs/2015-02-01/paginators-1.json
botocore/data/efs/2015-02-01/service-2.json
botocore/data/eks/2017-11-01/paginators-1.json
botocore/data/eks/2017-11-01/service-2.json
botocore/data/elasticache/2014-09-30/paginators-1.json
botocore/data/elasticache/2014-09-30/service-2.json
botocore/data/elasticache/2014-09-30/waiters-2.json
@ -310,6 +315,9 @@ 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/service-2.json
botocore/data/iot1click-projects/2018-05-14/paginators-1.json
botocore/data/iot1click-projects/2018-05-14/service-2.json
botocore/data/iotanalytics/2017-11-27/paginators-1.json
botocore/data/iotanalytics/2017-11-27/service-2.json
botocore/data/kinesis-video-archived-media/2017-09-30/paginators-1.json
@ -346,6 +354,8 @@ botocore/data/machinelearning/2014-12-12/examples-1.json
botocore/data/machinelearning/2014-12-12/paginators-1.json
botocore/data/machinelearning/2014-12-12/service-2.json
botocore/data/machinelearning/2014-12-12/waiters-2.json
botocore/data/macie/2017-12-19/paginators-1.json
botocore/data/macie/2017-12-19/service-2.json
botocore/data/marketplace-entitlement/2017-01-11/paginators-1.json
botocore/data/marketplace-entitlement/2017-01-11/service-2.json
botocore/data/marketplacecommerceanalytics/2015-07-01/examples-1.json
@ -360,6 +370,8 @@ botocore/data/mediastore-data/2017-09-01/paginators-1.json
botocore/data/mediastore-data/2017-09-01/service-2.json
botocore/data/mediastore/2017-09-01/paginators-1.json
botocore/data/mediastore/2017-09-01/service-2.json
botocore/data/mediatailor/2018-04-23/paginators-1.json
botocore/data/mediatailor/2018-04-23/service-2.json
botocore/data/meteringmarketplace/2016-01-14/examples-1.json
botocore/data/meteringmarketplace/2016-01-14/service-2.json
botocore/data/mgh/2017-05-31/paginators-1.json
@ -369,6 +381,9 @@ botocore/data/mobile/2017-07-01/service-2.json
botocore/data/mq/2017-11-27/service-2.json
botocore/data/mturk/2017-01-17/paginators-1.json
botocore/data/mturk/2017-01-17/service-2.json
botocore/data/neptune/2014-10-31/paginators-1.json
botocore/data/neptune/2014-10-31/service-2.json
botocore/data/neptune/2014-10-31/waiters-2.json
botocore/data/opsworks/2013-02-18/examples-1.json
botocore/data/opsworks/2013-02-18/paginators-1.json
botocore/data/opsworks/2013-02-18/service-2.json
@ -379,6 +394,8 @@ botocore/data/opsworkscm/2016-11-01/service-2.json
botocore/data/opsworkscm/2016-11-01/waiters-2.json
botocore/data/organizations/2016-11-28/paginators-1.json
botocore/data/organizations/2016-11-28/service-2.json
botocore/data/pi/2018-02-27/paginators-1.json
botocore/data/pi/2018-02-27/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

18
botocore/__init__.py
View file

@ -16,7 +16,7 @@ import os
import re
import logging
__version__ = '1.10.15'
__version__ = '1.10.55'
class NullHandler(logging.Handler):
@ -29,7 +29,6 @@ log.addHandler(NullHandler())
_first_cap_regex = re.compile('(.)([A-Z][a-z]+)')
_number_cap_regex = re.compile('([a-z])([0-9]+)')
_end_cap_regex = re.compile('([a-z0-9])([A-Z])')
# The regex below handles the special case where some acryonym
# name is pluralized, e.g GatewayARNs, ListWebACLs, SomeCNAMEs.
@ -52,10 +51,6 @@ _xform_cache = {
# services which might have a matching argument or operation. This way a
# common mis-translation can be fixed without having to call out each
# individual case.
_partial_renames = {
'ipv-6': 'ipv6',
'ipv_6': 'ipv6',
}
ScalarTypes = ('string', 'integer', 'boolean', 'timestamp', 'float', 'double')
BOTOCORE_ROOT = os.path.dirname(os.path.abspath(__file__))
@ -73,8 +68,7 @@ class UNSIGNED(object):
UNSIGNED = UNSIGNED()
def xform_name(name, sep='_', _xform_cache=_xform_cache,
partial_renames=_partial_renames):
def xform_name(name, sep='_', _xform_cache=_xform_cache):
"""Convert camel case to a "pythonic" name.
If the name contains the ``sep`` character, then it is
@ -93,12 +87,6 @@ def xform_name(name, sep='_', _xform_cache=_xform_cache,
# Replace something like ARNs, ACLs with _arns, _acls.
name = name[:-len(matched)] + sep + matched.lower()
s1 = _first_cap_regex.sub(r'\1' + sep + r'\2', name)
s2 = _number_cap_regex.sub(r'\1' + sep + r'\2', s1)
transformed = _end_cap_regex.sub(r'\1' + sep + r'\2', s2).lower()
# Do partial renames
for old, new in partial_renames.items():
if old in transformed:
transformed = transformed.replace(old, new)
transformed = _end_cap_regex.sub(r'\1' + sep + r'\2', s1).lower()
_xform_cache[key] = transformed
return _xform_cache[key]

3
botocore/credentials.py
View file

@ -69,7 +69,8 @@ def create_credential_resolver(session, cache=None):
instance_metadata_provider = InstanceMetadataProvider(
iam_role_fetcher=InstanceMetadataFetcher(
timeout=metadata_timeout,
num_attempts=num_attempts)
num_attempts=num_attempts,
user_agent=session.user_agent())
)
assume_role_provider = AssumeRoleProvider(
load_config=lambda: session.full_config,

14
botocore/data/_retry.json
View file

@ -102,6 +102,20 @@
"too_many_requests": {"$ref": "too_many_requests"}
}
},
"organizations": {
"__default__": {
"policies": {
"too_many_requests": {
"applies_when": {
"response": {
"service_error_code": "TooManyRequestsException",
"http_status_code": 400
}
}
}
}
}
},
"dynamodb": {
"__default__": {
"max_attempts": 10,

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

@ -26,7 +26,7 @@
{"shape":"InvalidPolicyException"},
{"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 function returns the Amazon Resource Name (ARN) of the CA.</p>",
"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>",
"idempotent":true
},
"CreateCertificateAuthorityAuditReport":{
@ -45,7 +45,7 @@
{"shape":"InvalidArgsException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a>IssueCertificate</a> and <a>RevokeCertificate</a> functions use the private key. You can generate a new report every 30 minutes.</p>",
"documentation":"<p>Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a>IssueCertificate</a> and <a>RevokeCertificate</a> operations use the private key. You can generate a new report every 30 minutes.</p>",
"idempotent":true
},
"DeleteCertificateAuthority":{
@ -61,7 +61,7 @@
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Deletes the private certificate authority (CA) that you created or started to create by calling the <a>CreateCertificateAuthority</a> function. This action requires that you enter an ARN (Amazon Resource Name) for the private CA that you want to delete. You can find the ARN by calling the <a>ListCertificateAuthorities</a> function. You can delete the CA if you are waiting for it to be created (the <b>Status</b> field of the <a>CertificateAuthority</a> is <code>CREATING</code>) or if the CA has been created but you haven't yet imported the signed certificate (the <b>Status</b> is <code>PENDING_CERTIFICATE</code>) into ACM PCA. If you've already imported the certificate, you cannot delete the CA unless it has been disabled for more than 30 days. To disable a CA, call the <a>UpdateCertificateAuthority</a> function and set the <b>CertificateAuthorityStatus</b> argument to <code>DISABLED</code>. </p>"
"documentation":"<p>Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA that you want to delete. You can find the ARN by calling the <a>ListCertificateAuthorities</a> operation. Before you can delete a CA, you must disable it. Call the <a>UpdateCertificateAuthority</a> operation and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>. </p> <p>Additionally, you can delete a CA if you are waiting for it to be created (the <b>Status</b> field of the <a>CertificateAuthority</a> is <code>CREATING</code>). You can also delete it if the CA has been created but you haven't yet imported the signed certificate (the <b>Status</b> is <code>PENDING_CERTIFICATE</code>) into ACM PCA. </p> <p>If the CA is in one of the aforementioned states and you call <a>DeleteCertificateAuthority</a>, the CA's status changes to <code>DELETED</code>. However, the CA won't be permentantly deleted until the restoration period has passed. By default, if you do not set the <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The <a>DescribeCertificateAuthority</a> operation returns the time remaining in the restoration window of a Private CA in the <code>DELETED</code> state. To restore an eligable CA, call the <a>RestoreCertificateAuthority</a> operation.</p>"
},
"DescribeCertificateAuthority":{
"name":"DescribeCertificateAuthority",
@ -75,7 +75,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <b>CREATING:</b> ACM PCA is creating your private certificate authority.</p> </li> <li> <p> <b>PENDING_CERTIFICATE:</b> The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <b>ACTIVE:</b> Your private CA is active.</p> </li> <li> <p> <b>DISABLED:</b> Your private CA has been disabled.</p> </li> <li> <p> <b>EXPIRED:</b> Your private CA certificate has expired.</p> </li> <li> <p> <b>FAILED:</b> Your private CA has failed. Your CA can fail for problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> </ul>"
"documentation":"<p>Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <code>CREATING</code> - ACM PCA is creating your private certificate authority.</p> </li> <li> <p> <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p> </li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> <li> <p> <code>DELETED</code> - Your private CA is within the restoration period, after which it will be permanently deleted. The length of time remaining in the CA's restoration period will also be included in this operation's output.</p> </li> </ul>"
},
"DescribeCertificateAuthorityAuditReport":{
"name":"DescribeCertificateAuthorityAuditReport",
@ -87,9 +87,10 @@
"output":{"shape":"DescribeCertificateAuthorityAuditReportResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidArgsException"}
],
"documentation":"<p>Lists information about a specific audit report created by calling the <a>CreateCertificateAuthorityAuditReport</a> function. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a>IssueCertificate</a> function or the <a>RevokeCertificate</a> function. </p>"
"documentation":"<p>Lists information about a specific audit report created by calling the <a>CreateCertificateAuthorityAuditReport</a> operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a>IssueCertificate</a> operation or the <a>RevokeCertificate</a> operation. </p>"
},
"GetCertificate":{
"name":"GetCertificate",
@ -106,7 +107,7 @@
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the <a>IssueCertificate</a> function. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> function. You can retrieve the certificate if it is in the <b>ISSUED</b> state. You can call the <a>CreateCertificateAuthorityAuditReport</a> function to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>"
"documentation":"<p>Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the <a>IssueCertificate</a> operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> operation. You can retrieve the certificate if it is in the <b>ISSUED</b> state. You can call the <a>CreateCertificateAuthorityAuditReport</a> operation to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>"
},
"GetCertificateAuthorityCertificate":{
"name":"GetCertificateAuthorityCertificate",
@ -135,9 +136,10 @@
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the <a>CreateCertificateAuthority</a> function. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the <a>ImportCertificateAuthorityCertificate</a> function. The CSR is returned as a base64 PEM-encoded string. </p>"
"documentation":"<p>Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the <a>CreateCertificateAuthority</a> operation. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the <a>ImportCertificateAuthorityCertificate</a> operation. The CSR is returned as a base64 PEM-encoded string. </p>"
},
"ImportCertificateAuthorityCertificate":{
"name":"ImportCertificateAuthorityCertificate",
@ -152,10 +154,11 @@
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"MalformedCertificateException"},
{"shape":"CertificateMismatchException"}
],
"documentation":"<p>Imports your signed private CA certificate into ACM PCA. Before you can call this function, you must create the private certificate authority by calling the <a>CreateCertificateAuthority</a> function. You must then generate a certificate signing request (CSR) by calling the <a>GetCertificateAuthorityCsr</a> function. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. </p> <note> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </note> <note> <p>Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </note> <note> <p>The chain must be PEM-encoded.</p> </note>"
"documentation":"<p>Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the <a>CreateCertificateAuthority</a> operation. You must then generate a certificate signing request (CSR) by calling the <a>GetCertificateAuthorityCsr</a> operation. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. </p> <note> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </note> <note> <p>Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </note> <note> <p>The chain must be PEM-encoded.</p> </note>"
},
"IssueCertificate":{
"name":"IssueCertificate",
@ -173,7 +176,7 @@
{"shape":"InvalidArgsException"},
{"shape":"MalformedCSRException"}
],
"documentation":"<p>Uses your private certificate authority (CA) to issue a client certificate. This function returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the <a>GetCertificate</a> function and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> function to retrieve the ARNs of the certificates that you issue by using ACM PCA.</p> </note>",
"documentation":"<p>Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the <a>GetCertificate</a> operation and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> operation to retrieve the ARNs of the certificates that you issue by using ACM PCA.</p> </note>",
"idempotent":true
},
"ListCertificateAuthorities":{
@ -187,7 +190,7 @@
"errors":[
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the private certificate authorities that you created by using the <a>CreateCertificateAuthority</a> function.</p>"
"documentation":"<p>Lists the private certificate authorities that you created by using the <a>CreateCertificateAuthority</a> operation.</p>"
},
"ListTags":{
"name":"ListTags",
@ -201,7 +204,21 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the <a>TagCertificateAuthority</a> function to add one or more tags to your CA. Call the <a>UntagCertificateAuthority</a> function to remove tags. </p>"
"documentation":"<p>Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the <a>TagCertificateAuthority</a> operation to add one or more tags to your CA. Call the <a>UntagCertificateAuthority</a> operation to remove tags. </p>"
},
"RestoreCertificateAuthority":{
"name":"RestoreCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreCertificateAuthorityRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b> parameter of the <a>DeleteCertificateAuthority</a> operation. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b> value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the <code>DELETED</code> state by calling the <a>DescribeCertificateAuthority</a> or <a>ListCertificateAuthorities</a> operations. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b> operation returns. To change its status to <code>ACTIVE</code>, call the <a>UpdateCertificateAuthority</a> operation. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion, you must use the <a>ImportCertificateAuthorityCertificate</a> operation to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.</p>"
},
"RevokeCertificate":{
"name":"RevokeCertificate",
@ -219,7 +236,7 @@
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"}
],
"documentation":"<p>Revokes a certificate that you issued by calling the <a>IssueCertificate</a> function. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the <a>CrlConfiguration</a> structure. ACM PCA also writes revocation information to the audit report. For more information, see <a>CreateCertificateAuthorityAuditReport</a>. </p>"
"documentation":"<p>Revokes a certificate that you issued by calling the <a>IssueCertificate</a> operation. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the <a>CrlConfiguration</a> structure. ACM PCA also writes revocation information to the audit report. For more information, see <a>CreateCertificateAuthorityAuditReport</a>. </p>"
},
"TagCertificateAuthority":{
"name":"TagCertificateAuthority",
@ -231,10 +248,11 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a>UntagCertificateAuthority</a> function. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>"
"documentation":"<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a>UntagCertificateAuthority</a> operation. Call the <a>ListTags</a> operation to see what tags are associated with your CA. </p>"
},
"UntagCertificateAuthority":{
"name":"UntagCertificateAuthority",
@ -246,9 +264,10 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidTagException"}
],
"documentation":"<p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a>TagCertificateAuthority</a>. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>"
"documentation":"<p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this operation, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a>TagCertificateAuthority</a>. Call the <a>ListTags</a> operation to see what tags are associated with your CA. </p>"
},
"UpdateCertificateAuthority":{
"name":"UpdateCertificateAuthority",
@ -265,7 +284,7 @@
{"shape":"InvalidStateException"},
{"shape":"InvalidPolicyException"}
],
"documentation":"<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <b> <code>ACTIVE</code> </b> or <b> <code>DISABLED</code> </b> state before you can update it. You can disable a private CA that is in the <b> <code>ACTIVE</code> </b> state or make a CA that is in the <b> <code>DISABLED</code> </b> state active again.</p>"
"documentation":"<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or make a CA that is in the <code>DISABLED</code> state active again.</p>"
}
},
"shapes":{
@ -274,7 +293,7 @@
"members":{
"Country":{
"shape":"CountryCodeString",
"documentation":"<p>Two digit code that specifies the country in which the certificate subject located.</p>"
"documentation":"<p>Two-digit code that specifies the country in which the certificate subject located.</p>"
},
"Organization":{
"shape":"String64",
@ -306,11 +325,11 @@
},
"Title":{
"shape":"String64",
"documentation":"<p>A title such as Mr. or Ms. which is pre-pended to the name to refer formally to the certificate subject.</p>"
"documentation":"<p>A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.</p>"
},
"Surname":{
"shape":"String40",
"documentation":"<p>Family name. In the US and the UK for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.</p>"
"documentation":"<p>Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.</p>"
},
"GivenName":{
"shape":"String16",
@ -329,7 +348,7 @@
"documentation":"<p>Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.</p>"
}
},
"documentation":"<p>Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The <b>Subject</b> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <b>Subject</b> must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. </p>"
"documentation":"<p>Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The <b>Subject</b> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <b>Subject</b> must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. </p>"
},
"Arn":{
"type":"string",
@ -409,9 +428,13 @@
"RevocationConfiguration":{
"shape":"RevocationConfiguration",
"documentation":"<p>Information about the certificate revocation list (CRL) created and maintained by your private CA. </p>"
},
"RestorableUntil":{
"shape":"TStamp",
"documentation":"<p>The period during which a deleted CA can be restored. For more information, see the <code>PermanentDeletionTimeInDays</code> parameter of the <a>DeleteCertificateAuthorityRequest</a> operation. </p>"
}
},
"documentation":"<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a>CreateCertificateAuthority</a> function to create your private CA. You must then call the <a>GetCertificateAuthorityCertificate</a> function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the <a>ImportCertificateAuthorityCertificate</a> function to import the signed certificate into AWS Certificate Manager (ACM). </p>"
"documentation":"<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a>CreateCertificateAuthority</a> operation to create your private CA. You must then call the <a>GetCertificateAuthorityCertificate</a> operation to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the <a>ImportCertificateAuthorityCertificate</a> operation to import the signed certificate into AWS Certificate Manager (ACM). </p>"
},
"CertificateAuthorityConfiguration":{
"type":"structure",
@ -434,7 +457,7 @@
"documentation":"<p>Structure that contains X.500 distinguished name information for your private CA.</p>"
}
},
"documentation":"<p>Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a>CreateCertificateAuthority</a> function. </p>"
"documentation":"<p>Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a>CreateCertificateAuthority</a> operation. </p>"
},
"CertificateAuthorityStatus":{
"type":"string",
@ -442,6 +465,7 @@
"CREATING",
"PENDING_CERTIFICATE",
"ACTIVE",
"DELETED",
"DISABLED",
"EXPIRED",
"FAILED"
@ -493,7 +517,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>"
"documentation":"<p>Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>"
},
"S3BucketName":{
"shape":"String",
@ -539,7 +563,7 @@
},
"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 and will issue only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.</p>"
"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>"
}
}
},
@ -548,7 +572,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
"documentation":"<p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
}
}
},
@ -558,7 +582,7 @@
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the <a>CreateCertificateAuthority</a> function or for an existing CA when you call the <a>UpdateCertificateAuthority</a> function. </p>",
"documentation":"<p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the <a>CreateCertificateAuthority</a> operation or for an existing CA when you call the <a>UpdateCertificateAuthority</a> operation. </p>",
"box":true
},
"ExpirationInDays":{
@ -572,7 +596,7 @@
},
"S3BucketName":{
"shape":"String3To255",
"documentation":"<p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a>UpdateCertificateAuthority</a> function. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.</p>"
"documentation":"<p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a>UpdateCertificateAuthority</a> operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.</p>"
}
},
"documentation":"<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA. </p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. </p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p>"
@ -589,7 +613,11 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must have the following form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
},
"PermanentDeletionTimeInDays":{
"shape":"PermanentDeletionTimeInDays",
"documentation":"<p>The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.</p>"
}
}
},
@ -602,11 +630,11 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
},
"AuditReportId":{
"shape":"AuditReportId",
"documentation":"<p>The report ID returned by calling the <a>CreateCertificateAuthorityAuditReport</a> function.</p>"
"documentation":"<p>The report ID returned by calling the <a>CreateCertificateAuthorityAuditReport</a> operation.</p>"
}
}
},
@ -637,7 +665,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
}
}
},
@ -670,7 +698,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
}
}
},
@ -693,7 +721,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> operation. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
}
}
},
@ -715,11 +743,11 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>"
},
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>"
"documentation":"<p>The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>"
}
}
},
@ -752,7 +780,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"Certificate":{
"shape":"CertificateBodyBlob",
@ -828,7 +856,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"Csr":{
"shape":"CsrBlob",
@ -844,7 +872,7 @@
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
"documentation":"<p>Custom string that can be used to distinguish between calls to the <b>IssueCertificate</b> function. Idempotency tokens time out after one hour. Therefore, if you call <b>IssueCertificate</b> multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.</p>"
"documentation":"<p>Custom string that can be used to distinguish between calls to the <b>IssueCertificate</b> operation. Idempotency tokens time out after one hour. Therefore, if you call <b>IssueCertificate</b> multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.</p>"
}
}
},
@ -853,7 +881,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>"
}
}
},
@ -906,7 +934,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> operation. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"NextToken":{
"shape":"NextToken",
@ -957,6 +985,11 @@
"max":500,
"min":1
},
"PermanentDeletionTimeInDays":{
"type":"integer",
"max":30,
"min":7
},
"PositiveLong":{
"type":"long",
"min":1
@ -993,6 +1026,16 @@
"documentation":"<p>A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.</p>",
"exception":true
},
"RestoreCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> operation. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
}
}
},
"RevocationConfiguration":{
"type":"structure",
"members":{
@ -1001,7 +1044,7 @@
"documentation":"<p>Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.</p>"
}
},
"documentation":"<p>Certificate revocation information used by the <a>CreateCertificateAuthority</a> and <a>UpdateCertificateAuthority</a> functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see <a>RevokeCertificate</a>.</p>"
"documentation":"<p>Certificate revocation information used by the <a>CreateCertificateAuthority</a> and <a>UpdateCertificateAuthority</a> operations. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see <a>RevokeCertificate</a>.</p>"
},
"RevocationReason":{
"type":"string",
@ -1026,11 +1069,11 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"CertificateSerial":{
"shape":"String128",
"documentation":"<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a>GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> function retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"http://docs.aws.amazon.comacm/latest/APIReferenceAPI_DescribeCertificate.html\">DescribeCertificate</a> function in the <i>AWS Certificate Manager API Reference</i>. </p>"
"documentation":"<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a>GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> operation retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html\">DescribeCertificate</a> operation in the <i>AWS Certificate Manager API Reference</i>. </p>"
},
"RevocationReason":{
"shape":"RevocationReason",
@ -1104,7 +1147,7 @@
"documentation":"<p>Value of the tag.</p>"
}
},
"documentation":"<p>Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the <a>TagCertificateAuthority</a> function. To remove a tag, call the <a>UntagCertificateAuthority</a> function. </p>"
"documentation":"<p>Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the <a>TagCertificateAuthority</a> operation. To remove a tag, call the <a>UntagCertificateAuthority</a> operation. </p>"
},
"TagCertificateAuthorityRequest":{
"type":"structure",
@ -1115,7 +1158,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"Tags":{
"shape":"TagList",
@ -1158,7 +1201,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"Tags":{
"shape":"TagList",
@ -1172,7 +1215,7 @@
"members":{
"CertificateAuthorityArn":{
"shape":"Arn",
"documentation":"<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
"documentation":"<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
},
"RevocationConfiguration":{
"shape":"RevocationConfiguration",
@ -1201,7 +1244,7 @@
"documentation":"<p>Specifies whether the <code>Value</code> parameter represents days, months, or years.</p>"
}
},
"documentation":"<p>Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the <a>IssueCertificate</a> function.</p>"
"documentation":"<p>Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the <a>IssueCertificate</a> operation.</p>"
},
"ValidityPeriodType":{
"type":"string",
@ -1214,5 +1257,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> function. If successful, the function returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the <a>GetCertificateAuthorityCsr</a> function 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> function to issue a certificate. Call the <a>RevokeCertificate</a> function 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> function. 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> function 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 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>"
}

35
botocore/data/acm/2015-12-08/waiters-2.json Normal file
View file

@ -0,0 +1,35 @@
{
"version": 2,
"waiters": {
"CertificateValidated": {
"delay": 60,
"maxAttempts": 40,
"operation": "DescribeCertificate",
"acceptors": [
{
"matcher": "pathAll",
"expected": "SUCCESS",
"argument": "Certificate.DomainValidationOptions[].ValidationStatus",
"state": "success"
},
{
"matcher": "pathAny",
"expected": "PENDING_VALIDATION",
"argument": "Certificate.DomainValidationOptions[].ValidationStatus",
"state": "retry"
},
{
"matcher": "path",
"expected": "FAILED",
"argument": "Certificate.Status",
"state": "failure"
},
{
"matcher": "error",
"expected": "ResourceNotFoundException",
"state": "failure"
}
]
}
}
}

20
botocore/data/alexaforbusiness/2017-11-09/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Alexa For Business",
"serviceId":"Alexa For Business",
"signatureVersion":"v4",
"targetPrefix":"AlexaForBusiness",
"uid":"alexaforbusiness-2017-11-09"
@ -33,7 +34,8 @@
"input":{"shape":"AssociateDeviceWithRoomRequest"},
"output":{"shape":"AssociateDeviceWithRoomResponse"},
"errors":[
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"DeviceNotRegisteredException"}
],
"documentation":"<p>Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required. </p>"
},
@ -237,6 +239,9 @@
},
"input":{"shape":"DisassociateDeviceFromRoomRequest"},
"output":{"shape":"DisassociateDeviceFromRoomResponse"},
"errors":[
{"shape":"DeviceNotRegisteredException"}
],
"documentation":"<p>Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.</p>"
},
"DisassociateSkillGroupFromRoom":{
@ -504,6 +509,9 @@
},
"input":{"shape":"StartDeviceSyncRequest"},
"output":{"shape":"StartDeviceSyncResponse"},
"errors":[
{"shape":"DeviceNotRegisteredException"}
],
"documentation":"<p>Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.</p>"
},
"TagResource":{
@ -568,7 +576,8 @@
"input":{"shape":"UpdateDeviceRequest"},
"output":{"shape":"UpdateDeviceResponse"},
"errors":[
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"DeviceNotRegisteredException"}
],
"documentation":"<p>Updates the device name by device ARN.</p>"
},
@ -1303,6 +1312,13 @@
"min":2,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
},
"DeviceNotRegisteredException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"DeviceSerialNumber":{
"type":"string",
"pattern":"[a-zA-Z0-9]{1,200}"

13
botocore/data/apigateway/2015-07-09/service-2.json
View file

@ -3533,17 +3533,18 @@
"members":{
"types":{
"shape":"ListOfEndpointType",
"documentation":"<p>A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>.</p>"
"documentation":"<p>A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>"
}
},
"documentation":"<p>The endpoint configuration to indicate the types of endpoints an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>) has. </p>"
},
"EndpointType":{
"type":"string",
"documentation":"<p>The endpoint type. The valid value is <code>EDGE</code> for edge-optimized API setup, most suitable for mobile applications, <code>REGIONAL</code> for regional API endpoint setup, most suitable for calling from AWS Region</p>",
"documentation":"<p>The endpoint type. The valid values are <code>EDGE</code> for edge-optimized API setup, most suitable for mobile applications; <code>REGIONAL</code> for regional API endpoint setup, most suitable for calling from AWS Region; and <code>PRIVATE</code> for private APIs.</p>",
"enum":[
"REGIONAL",
"EDGE"
"EDGE",
"PRIVATE"
]
},
"ExportResponse":{
@ -4102,7 +4103,7 @@
},
"parameters":{
"shape":"MapOfStringToString",
"documentation":"<p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>swagger</code>, any combination of the following parameters are supported: <code>integrations</code> will export the API with x-amazon-apigateway-integration extensions. <code>authorizers</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>",
"documentation":"<p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>",
"location":"querystring"
},
"accepts":{
@ -4874,7 +4875,7 @@
},
"parameters":{
"shape":"MapOfStringToString",
"documentation":"<p>A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.</p> <p> To exclude <a>DocumentationParts</a> from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</p> <p> To configure the endpoint type, set <code>parameters</code> as <code>endpointConfigurationTypes=EDGE</code> or<code>endpointConfigurationTypes=REGIONAL</code>. The default endpoint type is <code>EDGE</code>.</p> <p> To handle imported <code>basePath</code>, set <code>parameters</code> as <code>basePath=ignore</code>, <code>basePath=prepend</code> or <code>basePath=split</code>.</p> <p>For example, the AWS CLI command to exclude documentation from the imported API is:</p> <pre><code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json</code></pre> <p>The AWS CLI command to set the regional endpoint on the imported API is:</p> <pre><code>aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json</code></pre>",
"documentation":"<p>A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.</p> <p> To exclude <a>DocumentationParts</a> from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</p> <p> To configure the endpoint type, set <code>parameters</code> as <code>endpointConfigurationTypes=EDGE</code>, <code>endpointConfigurationTypes=REGIONAL</code>, or <code>endpointConfigurationTypes=PRIVATE</code>. The default endpoint type is <code>EDGE</code>.</p> <p> To handle imported <code>basePath</code>, set <code>parameters</code> as <code>basePath=ignore</code>, <code>basePath=prepend</code> or <code>basePath=split</code>.</p> <p>For example, the AWS CLI command to exclude documentation from the imported API is:</p> <pre><code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code></pre> <p>The AWS CLI command to set the regional endpoint on the imported API is:</p> <pre><code>aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'</code></pre>",
"location":"querystring"
},
"body":{
@ -5691,7 +5692,7 @@
},
"parameters":{
"shape":"MapOfStringToString",
"documentation":"<p>Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json</code>.</p>",
"documentation":"<p>Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.</p>",
"location":"querystring"
},
"body":{

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

@ -264,15 +264,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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>"
}
}
},
@ -291,7 +291,7 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"ScheduledActionName":{
"shape":"ResourceIdMaxLen1600",
@ -299,11 +299,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> </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.</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> </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.</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>"
}
}
},
@ -322,15 +322,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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>"
}
}
},
@ -345,15 +345,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -384,15 +384,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -427,15 +427,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -470,15 +470,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -652,15 +652,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -700,11 +700,11 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"Schedule":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</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=\"http://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 +712,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> </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.</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> </ul>"
"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>"
},
"StartTime":{
"shape":"TimestampType",
@ -747,15 +747,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -767,7 +767,7 @@
},
"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/ApplicationAutoScaling/latest/APIReference/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=\"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>"
}
}
},
@ -808,7 +808,8 @@
"dynamodb:index:ReadCapacityUnits",
"dynamodb:index:WriteCapacityUnits",
"rds:cluster:ReadReplicaCount",
"sagemaker:variant:DesiredInstanceCount"
"sagemaker:variant:DesiredInstanceCount",
"custom-resource:ResourceType:Property"
]
},
"ScalableTarget":{
@ -825,15 +826,15 @@
"members":{
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -895,15 +896,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -974,15 +975,15 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"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> </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.</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> </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.</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",
@ -1028,19 +1029,19 @@
},
"ServiceNamespace":{
"shape":"ServiceNamespace",
"documentation":"<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"Schedule":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</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=\"http://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> </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.</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> </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.</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",
@ -1080,7 +1081,8 @@
"appstream",
"dynamodb",
"rds",
"sagemaker"
"sagemaker",
"custom-resource"
]
},
"StepAdjustment":{
@ -1177,5 +1179,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 AWS resources. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>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 AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon 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 endpoints. 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> </ul> <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 <a href=\"http://aws.amazon.com/autoscaling\">AWS Auto Scaling</a>.</p> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>"
"documentation":"<p>With Application Auto Scaling, you can 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>"
}

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

@ -62,7 +62,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"}
],
"documentation":"<p>Creates a directory configuration.</p>"
"documentation":"<p>Creates a Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.</p>"
},
"CreateFleet":{
"name":"CreateFleet",
@ -83,7 +83,7 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"IncompatibleImageException"}
],
"documentation":"<p>Creates a fleet.</p>"
"documentation":"<p>Creates a fleet. A fleet consists of streaming instances that run a specified image.</p>"
},
"CreateImageBuilder":{
"name":"CreateImageBuilder",
@ -104,7 +104,7 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"IncompatibleImageException"}
],
"documentation":"<p>Creates an image builder.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>"
"documentation":"<p>Creates an image builder. An image builder is a virtual machine that is used to create an image.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>"
},
"CreateImageBuilderStreamingURL":{
"name":"CreateImageBuilderStreamingURL",
@ -137,7 +137,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Creates a stack.</p>"
"documentation":"<p>Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. </p>"
},
"CreateStreamingURL":{
"name":"CreateStreamingURL",
@ -153,7 +153,7 @@
{"shape":"OperationNotPermittedException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Creates a URL to start a streaming session for the specified user.</p>"
"documentation":"<p>Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. </p>"
},
"DeleteDirectoryConfig":{
"name":"DeleteDirectoryConfig",
@ -167,7 +167,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the specified directory configuration.</p>"
"documentation":"<p>Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.</p>"
},
"DeleteFleet":{
"name":"DeleteFleet",
@ -198,7 +198,7 @@
{"shape":"OperationNotPermittedException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Deletes the specified image. You cannot delete an image that is currently in use. After you delete an image, you cannot provision new capacity using the image.</p>"
"documentation":"<p>Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.</p>"
},
"DeleteImageBuilder":{
"name":"DeleteImageBuilder",
@ -228,7 +228,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are released.</p>"
"documentation":"<p>Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.</p>"
},
"DescribeDirectoryConfigs":{
"name":"DescribeDirectoryConfigs",
@ -241,7 +241,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response. </p>"
"documentation":"<p>Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the information required to join streaming instances to an Active Directory domain. </p> <p>Although the response syntax in this topic includes the account password, this password is not returned in the actual response.</p>"
},
"DescribeFleets":{
"name":"DescribeFleets",
@ -254,7 +254,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified fleets or all fleets in the account.</p>"
"documentation":"<p>Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.</p>"
},
"DescribeImageBuilders":{
"name":"DescribeImageBuilders",
@ -267,7 +267,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified image builders or all image builders in the account.</p>"
"documentation":"<p>Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.</p>"
},
"DescribeImages":{
"name":"DescribeImages",
@ -280,7 +280,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified images or all images in the account.</p>"
"documentation":"<p>Retrieves a list that describes one or more specified images, if the image names are provided. Otherwise, all images in the account are described.</p>"
},
"DescribeSessions":{
"name":"DescribeSessions",
@ -293,7 +293,7 @@
"errors":[
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. 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 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>"
},
"DescribeStacks":{
"name":"DescribeStacks",
@ -306,7 +306,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified stacks or all stacks in the account.</p>"
"documentation":"<p>Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.</p>"
},
"DisassociateFleet":{
"name":"DisassociateFleet",
@ -331,7 +331,7 @@
},
"input":{"shape":"ExpireSessionRequest"},
"output":{"shape":"ExpireSessionResult"},
"documentation":"<p>Stops the specified streaming session.</p>"
"documentation":"<p>Immediately stops the specified streaming session.</p>"
},
"ListAssociatedFleets":{
"name":"ListAssociatedFleets",
@ -341,7 +341,7 @@
},
"input":{"shape":"ListAssociatedFleetsRequest"},
"output":{"shape":"ListAssociatedFleetsResult"},
"documentation":"<p>Lists the fleets associated with the specified stack.</p>"
"documentation":"<p>Retrieves the name of the fleet that is associated with the specified stack.</p>"
},
"ListAssociatedStacks":{
"name":"ListAssociatedStacks",
@ -351,7 +351,7 @@
},
"input":{"shape":"ListAssociatedStacksRequest"},
"output":{"shape":"ListAssociatedStacksResult"},
"documentation":"<p>Lists the stacks associated with the specified fleet.</p>"
"documentation":"<p>Retrieves the name of the stack with which the specified fleet is associated.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -364,7 +364,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the 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=\"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>"
},
"StartFleet":{
"name":"StartFleet",
@ -455,7 +455,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disassociates the 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=\"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>"
},
"UpdateDirectoryConfig":{
"name":"UpdateDirectoryConfig",
@ -470,7 +470,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Updates the specified directory configuration.</p>"
"documentation":"<p>Updates the specified Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.</p>"
},
"UpdateFleet":{
"name":"UpdateFleet",
@ -509,9 +509,10 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"IncompatibleImageException"}
{"shape":"IncompatibleImageException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Updates the specified stack.</p>"
"documentation":"<p>Updates the specified fields for the specified stack.</p>"
}
},
"shapes":{
@ -526,6 +527,16 @@
"min":1,
"sensitive":true
},
"Action":{
"type":"string",
"enum":[
"CLIPBOARD_COPY_FROM_LOCAL_DEVICE",
"CLIPBOARD_COPY_TO_LOCAL_DEVICE",
"FILE_UPLOAD",
"FILE_DOWNLOAD",
"PRINTING_TO_LOCAL_DEVICE"
]
},
"Application":{
"type":"structure",
"members":{
@ -868,7 +879,7 @@
"required":["Name"],
"members":{
"Name":{
"shape":"String",
"shape":"Name",
"documentation":"<p>The name of the stack.</p>"
},
"Description":{
@ -890,6 +901,10 @@
"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>"
},
"UserSettings":{
"shape":"UserSettingList",
"documentation":"<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </p>"
}
}
},
@ -1118,12 +1133,26 @@
}
}
},
"DescribeImagesMaxResults":{
"type":"integer",
"box":true,
"max":25,
"min":0
},
"DescribeImagesRequest":{
"type":"structure",
"members":{
"Names":{
"shape":"StringList",
"documentation":"<p>The names of the images to describe.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.</p>"
},
"MaxResults":{
"shape":"DescribeImagesMaxResults",
"documentation":"<p>The maximum size of each results page.</p>"
}
}
},
@ -1133,6 +1162,10 @@
"Images":{
"shape":"ImageList",
"documentation":"<p>Information about the images.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token used to retrieve the next page of results. If this value is empty, only the first page is retrieved.</p>"
}
}
},
@ -1270,6 +1303,11 @@
"type":"string",
"max":100
},
"Domain":{
"type":"string",
"documentation":"GSuite domain for GDrive integration.",
"max":64
},
"DomainJoinInfo":{
"type":"structure",
"members":{
@ -1284,6 +1322,11 @@
},
"documentation":"<p>Contains the information needed to join a Microsoft Active Directory domain.</p>"
},
"DomainList":{
"type":"list",
"member":{"shape":"Domain"},
"max":10
},
"ErrorMessage":{
"type":"string",
"documentation":"<p>The error message in the exception.</p>"
@ -1734,7 +1777,7 @@
"members":{
"Names":{
"shape":"StringList",
"documentation":"<p>The names of the fleets.</p>"
"documentation":"<p>The name of the fleet.</p>"
},
"NextToken":{
"shape":"String",
@ -1761,7 +1804,7 @@
"members":{
"Names":{
"shape":"StringList",
"documentation":"<p>The names of the stacks.</p>"
"documentation":"<p>The name of the stack.</p>"
},
"NextToken":{
"shape":"String",
@ -1798,6 +1841,20 @@
"type":"string",
"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$"
},
"NetworkAccessConfiguration":{
"type":"structure",
"members":{
"EniPrivateIpAddress":{
"shape":"String",
"documentation":"<p>The private IP address of the elastic network interface that is attached to instances in your VPC.</p>"
},
"EniId":{
"shape":"String",
"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>"
},
"OperationNotPermittedException":{
"type":"structure",
"members":{
@ -1814,6 +1871,13 @@
"type":"list",
"member":{"shape":"OrganizationalUnitDistinguishedName"}
},
"Permission":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"PlatformType":{
"type":"string",
"enum":["WINDOWS"]
@ -1943,6 +2007,10 @@
"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>"
},
"NetworkAccessConfiguration":{
"shape":"NetworkAccessConfiguration",
"documentation":"<p>The network details for the streaming session.</p>"
}
},
"documentation":"<p>Describes a streaming session.</p>"
@ -2000,6 +2068,10 @@
"StackErrors":{
"shape":"StackErrors",
"documentation":"<p>The errors for the stack.</p>"
},
"UserSettings":{
"shape":"UserSettingList",
"documentation":"<p>The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.</p>"
}
},
"documentation":"<p>Describes a stack.</p>"
@ -2008,9 +2080,13 @@
"type":"string",
"enum":[
"STORAGE_CONNECTORS",
"STORAGE_CONNECTOR_HOMEFOLDERS",
"STORAGE_CONNECTOR_GOOGLE_DRIVE",
"STORAGE_CONNECTOR_ONE_DRIVE",
"REDIRECT_URL",
"FEEDBACK_URL",
"THEME_NAME"
"THEME_NAME",
"USER_SETTINGS"
]
},
"StackAttributes":{
@ -2131,9 +2207,13 @@
"ResourceIdentifier":{
"shape":"ResourceIdentifier",
"documentation":"<p>The ARN of the storage connector.</p>"
},
"Domains":{
"shape":"DomainList",
"documentation":"<p>The names of the domains for the G Suite account.</p>"
}
},
"documentation":"<p>Describes a storage connector.</p>"
"documentation":"<p>Describes a connector to enable persistent storage for users.</p>"
},
"StorageConnectorList":{
"type":"list",
@ -2143,7 +2223,11 @@
"StorageConnectorType":{
"type":"string",
"documentation":"<p>The type of storage connector.</p>",
"enum":["HOMEFOLDERS"]
"enum":[
"HOMEFOLDERS",
"GOOGLE_DRIVE",
"ONE_DRIVE"
]
},
"StreamingUrlUserId":{
"type":"string",
@ -2240,7 +2324,7 @@
"members":{
"DirectoryName":{
"shape":"DirectoryName",
"documentation":"<p>The name of the directory configuration.</p>"
"documentation":"<p>The name of the Directory Config object.</p>"
},
"OrganizationalUnitDistinguishedNames":{
"shape":"OrganizationalUnitDistinguishedNamesList",
@ -2257,7 +2341,7 @@
"members":{
"DirectoryConfig":{
"shape":"DirectoryConfig",
"documentation":"<p>Information about the directory configuration.</p>"
"documentation":"<p>Information about the Directory Config object.</p>"
}
}
},
@ -2365,6 +2449,10 @@
"AttributesToDelete":{
"shape":"StackAttributes",
"documentation":"<p>The stack attributes to delete.</p>"
},
"UserSettings":{
"shape":"UserSettingList",
"documentation":"<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.</p>"
}
}
},
@ -2382,6 +2470,29 @@
"max":32,
"min":2
},
"UserSetting":{
"type":"structure",
"required":[
"Action",
"Permission"
],
"members":{
"Action":{
"shape":"Action",
"documentation":"<p>The action that is enabled or disabled.</p>"
},
"Permission":{
"shape":"Permission",
"documentation":"<p>Indicates whether the action is enabled or disabled.</p>"
}
},
"documentation":"<p>Describes an action and whether the action is enabled or disabled for users during their streaming sessions.</p>"
},
"UserSettingList":{
"type":"list",
"member":{"shape":"UserSetting"},
"min":1
},
"VisibilityType":{
"type":"string",
"enum":[

1
botocore/data/appsync/2017-07-25/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"rest-json",
"serviceAbbreviation":"AWSAppSync",
"serviceFullName":"AWS AppSync",
"serviceId":"AppSync",
"signatureVersion":"v4",
"signingName":"appsync",
"uid":"appsync-2017-07-25"

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

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Athena",
"serviceId":"Athena",
"signatureVersion":"v4",
"targetPrefix":"AmazonAthena",
"uid":"athena-2017-05-18"

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

@ -5,6 +5,7 @@
"endpointPrefix":"autoscaling",
"protocol":"query",
"serviceFullName":"Auto Scaling",
"serviceId":"Auto Scaling",
"signatureVersion":"v4",
"uid":"autoscaling-2011-01-01",
"xmlNamespace":"http://autoscaling.amazonaws.com/doc/2011-01-01/"

135
botocore/data/budgets/2016-10-20/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"AWSBudgets",
"serviceFullName":"AWS Budgets",
"serviceId":"Budgets",
"signatureVersion":"v4",
"targetPrefix":"AWSBudgetServiceGateway",
"uid":"budgets-2016-10-20"
@ -75,7 +76,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Deletes a budget. You can delete your budget at any time.</p> <important> <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p> </important>"
"documentation":"<p>Deletes a budget. You can delete your budget at any time.</p> <p> <b>Deleting a budget also deletes the notifications and subscribers associated with that budget.</b> </p>"
},
"DeleteNotification":{
"name":"DeleteNotification",
@ -90,7 +91,7 @@
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Deletes a notification.</p> <important> <p>Deleting a notification also deletes the subscribers that are associated with the notification.</p> </important>"
"documentation":"<p>Deletes a notification.</p> <p> <b>Deleting a notification also deletes the subscribers associated with the notification.</b> </p>"
},
"DeleteSubscriber":{
"name":"DeleteSubscriber",
@ -105,7 +106,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Deletes a subscriber.</p> <important> <p>Deleting the last subscriber to a notification also deletes the notification.</p> </important>"
"documentation":"<p>Deletes a subscriber.</p> <p> <b>Deleting the last subscriber to a notification also deletes the notification.</b> </p>"
},
"DescribeBudget":{
"name":"DescribeBudget",
@ -137,7 +138,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"<p>Lists the budgets that are associated with an account.</p>"
"documentation":"<p>Lists the budgets associated with an account.</p>"
},
"DescribeNotificationsForBudget":{
"name":"DescribeNotificationsForBudget",
@ -154,7 +155,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"<p>Lists the notifications that are associated with a budget.</p>"
"documentation":"<p>Lists the notifications associated with a budget.</p>"
},
"DescribeSubscribersForNotification":{
"name":"DescribeSubscribersForNotification",
@ -171,7 +172,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"<p>Lists the subscribers that are associated with a notification.</p>"
"documentation":"<p>Lists the subscribers associated with a notification.</p>"
},
"UpdateBudget":{
"name":"UpdateBudget",
@ -186,7 +187,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p>"
"documentation":"<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When a budget is modified, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p>"
},
"UpdateNotification":{
"name":"UpdateNotification",
@ -224,7 +225,7 @@
"shapes":{
"AccountId":{
"type":"string",
"documentation":"<p>The account ID of the user. It should be a 12-digit number.</p>",
"documentation":"<p>The account ID of the customer. It should be a 12 digit number.</p>",
"max":12,
"min":12
},
@ -238,48 +239,48 @@
"members":{
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of a budget. The name must be unique within accounts. The <code>:</code> and <code>\\</code> characters are not allowed in <code>BudgetName</code>.</p>"
"documentation":"<p>The name of a budget. Unique within accounts. <code>:</code> and <code>\\</code> characters are not allowed in the <code>BudgetName</code>.</p>"
},
"BudgetLimit":{
"shape":"Spend",
"documentation":"<p>The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to <code>100</code>, which is the only valid value for RI utilization or coverage budgets.</p>"
"documentation":"<p>The total amount of cost, usage, or RI utilization that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is <code>100</code>.</p>"
},
"CostFilters":{
"shape":"CostFilters",
"documentation":"<p>The cost filters, such as service or region, that are applied to a budget.</p>"
"documentation":"<p>The cost filters applied to a budget, such as service or region.</p>"
},
"CostTypes":{
"shape":"CostTypes",
"documentation":"<p>The types of costs that are included in this <code>COST</code> budget.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, and <code>RI_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>"
"documentation":"<p>The types of costs included in this budget.</p>"
},
"TimeUnit":{
"shape":"TimeUnit",
"documentation":"<p>The length of time until a budget resets the actual and forecasted spend. <code>DAILY</code> is available only for <code>RI_UTILIZATION</code> and <code>RI_COVERAGE</code> budgets.</p>"
"documentation":"<p>The length of time until a budget resets the actual and forecasted spend.</p>"
},
"TimePeriod":{
"shape":"TimePeriod",
"documentation":"<p>The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before <code>06/15/87 00:00 UTC</code>. </p> <p>If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers.</p>"
"documentation":"<p>The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p> <p>If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers.</p>"
},
"CalculatedSpend":{
"shape":"CalculatedSpend",
"documentation":"<p>The actual and forecasted cost or usage that the budget tracks.</p>"
"documentation":"<p>The actual and forecasted cost or usage being tracked by a budget.</p>"
},
"BudgetType":{
"shape":"BudgetType",
"documentation":"<p>Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.</p>"
"documentation":"<p>Whether this budget tracks monetary costs, usage, or RI utilization.</p>"
}
},
"documentation":"<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p> <p>This is the ARN pattern for a budget: </p> <p> <code>arn:aws:budgetservice::AccountId:budget/budgetName</code> </p>"
"documentation":"<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code>.</p> <p>The ARN pattern for a budget is: <code>arn:aws:budgetservice::AccountId:budget/budgetName</code> </p>"
},
"BudgetName":{
"type":"string",
"documentation":"<p> A string that represents the budget name. The \":\" and \"\\\" characters are not allowed.</p>",
"documentation":"<p> A string represents the budget name. No \":\" and \"\\\" character is allowed.</p>",
"max":100,
"pattern":"[^:\\\\]+"
},
"BudgetType":{
"type":"string",
"documentation":"<p> The type of a budget. It must be one of the following types: </p> <p> <code>COST</code>, <code>USAGE</code>, <code>RI_UTILIZATION</code>, or <code>RI_COVERAGE</code>.</p>",
"documentation":"<p> The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.</p>",
"enum":[
"USAGE",
"COST",
@ -290,7 +291,7 @@
"Budgets":{
"type":"list",
"member":{"shape":"Budget"},
"documentation":"<p> A list of budgets.</p>"
"documentation":"<p> A list of budgets</p>"
},
"CalculatedSpend":{
"type":"structure",
@ -305,11 +306,11 @@
"documentation":"<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>"
}
},
"documentation":"<p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, or RI units, and the <code>forecastedSpend</code> tracks how much you are predicted to spend if your current usage remains steady.</p> <p>For example, if it is the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>"
"documentation":"<p>The spend objects associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, or RI units, and the <code>forecastedSpend</code> tracks how much you are predicted to spend if your current usage remains steady.</p> <p>For example, if it is the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>"
},
"ComparisonOperator":{
"type":"string",
"documentation":"<p> The comparison operator of a notification. Currently the service supports the following operators:</p> <p> <code>GREATER_THAN</code>, <code>LESS_THAN</code>, <code>EQUAL_TO</code> </p>",
"documentation":"<p> The comparison operator of a notification. Currently we support less than, equal to and greater than.</p>",
"enum":[
"GREATER_THAN",
"LESS_THAN",
@ -320,7 +321,7 @@
"type":"map",
"key":{"shape":"GenericString"},
"value":{"shape":"DimensionValues"},
"documentation":"<p> A map that represents the cost filters that are applied to the budget.</p>"
"documentation":"<p> A map that represents the cost filters applied to the budget.</p>"
},
"CostTypes":{
"type":"structure",
@ -335,7 +336,7 @@
},
"UseBlended":{
"shape":"NullableBoolean",
"documentation":"<p>Specifies whether a budget uses a blended rate.</p> <p>The default value is <code>false</code>.</p>"
"documentation":"<p>Specifies whether a budget uses blended rate.</p> <p>The default value is <code>false</code>.</p>"
},
"IncludeRefund":{
"shape":"NullableBoolean",
@ -370,7 +371,7 @@
"documentation":"<p>Specifies whether a budget uses the amortized rate.</p> <p>The default value is <code>false</code>.</p>"
}
},
"documentation":"<p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, and <code>RI_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>"
"documentation":"<p>The types of cost included in a budget, such as tax and subscriptions.</p>"
},
"CreateBudgetRequest":{
"type":"structure",
@ -389,7 +390,7 @@
},
"NotificationsWithSubscribers":{
"shape":"NotificationWithSubscribersList",
"documentation":"<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</p>"
"documentation":"<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to ten email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</p>"
}
},
"documentation":"<p> Request of CreateBudget </p>"
@ -415,7 +416,7 @@
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.</p>"
"documentation":"<p>The name of the budget that you want AWS to notified you about. Budget names must be unique within an account.</p>"
},
"Notification":{
"shape":"Notification",
@ -423,7 +424,7 @@
},
"Subscribers":{
"shape":"Subscribers",
"documentation":"<p>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.</p>"
"documentation":"<p>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to ten email subscribers.</p>"
}
},
"documentation":"<p> Request of CreateNotification </p>"
@ -445,7 +446,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget that you want to create a subscriber for.</p>"
"documentation":"<p>The <code>accountId</code> associated with the budget that you want to create a subscriber for.</p>"
},
"BudgetName":{
"shape":"BudgetName",
@ -601,11 +602,11 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in a response.</p>"
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>"
"documentation":"<p>The pagination token that indicates the next set of results to retrieve.</p>"
}
},
"documentation":"<p> Request of DescribeBudgets </p>"
@ -619,7 +620,7 @@
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>"
"documentation":"<p>The pagination token that indicates the next set of results that you can retrieve.</p>"
}
},
"documentation":"<p> Response of DescribeBudgets </p>"
@ -641,11 +642,11 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in a response.</p>"
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>"
"documentation":"<p>The pagination token that indicates the next set of results to retrieve.</p>"
}
},
"documentation":"<p> Request of DescribeNotificationsForBudget </p>"
@ -655,11 +656,11 @@
"members":{
"Notifications":{
"shape":"Notifications",
"documentation":"<p>A list of notifications that are associated with a budget.</p>"
"documentation":"<p>A list of notifications associated with a budget.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>"
"documentation":"<p>The pagination token that indicates the next set of results that you can retrieve.</p>"
}
},
"documentation":"<p> Response of GetNotificationsForBudget </p>"
@ -686,11 +687,11 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in a response.</p>"
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>"
"documentation":"<p>The pagination token that indicates the next set of results to retrieve.</p>"
}
},
"documentation":"<p> Request of DescribeSubscribersForNotification </p>"
@ -700,11 +701,11 @@
"members":{
"Subscribers":{
"shape":"Subscribers",
"documentation":"<p>A list of subscribers that are associated with a notification.</p>"
"documentation":"<p>A list of subscribers associated with a notification.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>"
"documentation":"<p>The pagination token that indicates the next set of results that you can retrieve.</p>"
}
},
"documentation":"<p> Response of DescribeSubscribersForNotification </p>"
@ -731,11 +732,11 @@
},
"GenericString":{
"type":"string",
"documentation":"<p> A generic string.</p>"
"documentation":"<p> A generic String.</p>"
},
"GenericTimestamp":{
"type":"timestamp",
"documentation":"<p> A generic time stamp. In Java, it is transformed to a <code>Date</code> object.</p>"
"documentation":"<p> A generic timestamp. In Java it is transformed to a Date object.</p>"
},
"InternalErrorException":{
"type":"structure",
@ -763,7 +764,7 @@
},
"MaxResults":{
"type":"integer",
"documentation":"<p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
"documentation":"<p> An integer to represent how many entries a paginated response contains. Maximum is set to 100.</p>",
"box":true,
"max":100,
"min":1
@ -790,28 +791,28 @@
},
"ComparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"<p>The comparison that is used for this notification.</p>"
"documentation":"<p>The comparison used for this notification.</p>"
},
"Threshold":{
"shape":"NotificationThreshold",
"documentation":"<p>The threshold that is associated with a notification. Thresholds are always a percentage.</p>"
"documentation":"<p>The threshold associated with a notification. Thresholds are always a percentage.</p>"
},
"ThresholdType":{
"shape":"ThresholdType",
"documentation":"<p>The type of threshold for a notification. For <code>ACTUAL</code> thresholds, AWS notifies you when you go over the threshold. For <code>FORECASTED</code> thresholds, AWS notifies you when you are forecasted to go over the threshold.</p>"
"documentation":"<p>The type of threshold for a notification. For <code>ACTUAL</code> thresholds, AWS notifies you when you go over the threshold, and for <code>FORECASTED</code> thresholds AWS notifies you when you are forecasted to go over the threshold.</p>"
}
},
"documentation":"<p>A notification that is associated with a budget. A budget can have up to five notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A <code>notificationType</code> of <code>ACTUAL</code> </p> </li> <li> <p>A <code>comparisonOperator</code> of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification threshold of <code>80</code> </p> </li> </ul>"
"documentation":"<p>A notification associated with a budget. A budget can have up to five notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A comparisonOperator of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification threshold of <code>80</code> </p> </li> </ul>"
},
"NotificationThreshold":{
"type":"double",
"documentation":"<p> The threshold of a notification. It must be a number between 0 and 1,000,000,000.</p>",
"documentation":"<p> The threshold of a notification. It should be a number between 0 and 1,000,000,000.</p>",
"max":1000000000,
"min":0.1
},
"NotificationType":{
"type":"string",
"documentation":"<p> The type of a notification. It must be ACTUAL or FORECASTED.</p>",
"documentation":"<p> The type of a notification. It should be ACTUAL or FORECASTED.</p>",
"enum":[
"ACTUAL",
"FORECASTED"
@ -826,19 +827,19 @@
"members":{
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification that is associated with a budget.</p>"
"documentation":"<p>The notification associated with a budget.</p>"
},
"Subscribers":{
"shape":"Subscribers",
"documentation":"<p>A list of subscribers who are subscribed to this notification.</p>"
}
},
"documentation":"<p>A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p>"
"documentation":"<p>A notification with subscribers. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.</p>"
},
"NotificationWithSubscribersList":{
"type":"list",
"member":{"shape":"NotificationWithSubscribers"},
"documentation":"<p> A list of notifications, each with a list of subscribers.</p>",
"documentation":"<p> A list of Notifications, each with a list of subscribers.</p>",
"max":5
},
"Notifications":{
@ -852,8 +853,8 @@
},
"NumericValue":{
"type":"string",
"documentation":"<p> A string that represents a numeric value.</p>",
"pattern":"[0-9]*(\\.)?[0-9]+"
"documentation":"<p> A string to represent NumericValue.</p>",
"pattern":"([0-9]*\\.)?[0-9]+"
},
"Spend":{
"type":"structure",
@ -864,14 +865,14 @@
"members":{
"Amount":{
"shape":"NumericValue",
"documentation":"<p>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</p>"
"documentation":"<p>The cost or usage amount associated with a budget forecast, actual spend, or budget threshold.</p>"
},
"Unit":{
"shape":"UnitValue",
"documentation":"<p>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
"documentation":"<p>The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
}
},
"documentation":"<p>The amount of cost or usage that is measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>"
"documentation":"<p>The amount of cost or usage being measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>"
},
"Subscriber":{
"type":"structure",
@ -889,11 +890,11 @@
"documentation":"<p>The address that AWS sends budget notifications to, either an SNS topic or an email.</p>"
}
},
"documentation":"<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p> <p>For example, an email subscriber would have the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>"
"documentation":"<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon Simple Notification Service topic or an email address.</p> <p>For example, an email subscriber would have the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>"
},
"SubscriberAddress":{
"type":"string",
"documentation":"<p> A string that contains an email address or SNS topic for the subscriber's address.</p>",
"documentation":"<p> String containing email or sns topic for the subscriber address.</p>",
"min":1
},
"Subscribers":{
@ -924,18 +925,18 @@
"members":{
"Start":{
"shape":"GenericTimestamp",
"documentation":"<p>The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>"
"documentation":"<p>The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>"
},
"End":{
"shape":"GenericTimestamp",
"documentation":"<p>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</p>"
}
},
"documentation":"<p>The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>"
"documentation":"<p>The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>"
},
"TimeUnit":{
"type":"string",
"documentation":"<p> The time unit of the budget, such as MONTHLY or QUARTERLY.</p>",
"documentation":"<p> The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.</p>",
"enum":[
"DAILY",
"MONTHLY",
@ -945,7 +946,7 @@
},
"UnitValue":{
"type":"string",
"documentation":"<p> A string that represents the spend unit of a budget. It can't be null or empty.</p>",
"documentation":"<p> A string to represent budget spend unit. It should be not null and not empty.</p>",
"min":1
},
"UpdateBudgetRequest":{
@ -991,7 +992,7 @@
},
"OldNotification":{
"shape":"Notification",
"documentation":"<p>The previous notification that is associated with a budget.</p>"
"documentation":"<p>The previous notification associated with a budget.</p>"
},
"NewNotification":{
"shape":"Notification",
@ -1030,11 +1031,11 @@
},
"OldSubscriber":{
"shape":"Subscriber",
"documentation":"<p>The previous subscriber that is associated with a budget notification.</p>"
"documentation":"<p>The previous subscriber associated with a budget notification.</p>"
},
"NewSubscriber":{
"shape":"Subscriber",
"documentation":"<p>The updated subscriber that is associated with a budget notification.</p>"
"documentation":"<p>The updated subscriber associated with a budget notification.</p>"
}
},
"documentation":"<p> Request of UpdateSubscriber </p>"
@ -1050,5 +1051,5 @@
"documentation":"<p>The error message the exception carries.</p>"
}
},
"documentation":"<p>The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets. </p> <p>Budgets provide you with a way to see the following information:</p> <ul> <li> <p>How close your plan is to your budgeted amount or to the free tier limits</p> </li> <li> <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p> </li> <li> <p>Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month</p> </li> <li> <p>How much of your budget has been used</p> </li> </ul> <p>AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p> <ul> <li> <p> <b>Cost budgets</b> - Plan how much you want to spend on a service.</p> </li> <li> <p> <b>Usage budgets</b> - Plan how much you want to use one or more services.</p> </li> <li> <p> <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p> </li> <li> <p> <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p> </li> </ul> <p>Service Endpoint</p> <p>The AWS Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.amazonaws.com</p> </li> </ul> <p>For information about costs that are associated with the AWS Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>"
"documentation":"<p>Budgets enable you to plan your service usage, service costs, and your RI utilization. You can also track how close your plan is to your budgeted amount or to the free tier limits. Budgets provide you with a quick way to see your usage-to-date and current estimated charges from AWS and to see how much your predicted usage accrues in charges by the end of the month. Budgets also compare current estimates and charges to the amount that you indicated you want to use or spend and lets you see how much of your budget has been used. AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, and refunds. You can create the following types of budgets:</p> <ul> <li> <p>Cost budgets allow you to say how much you want to spend on a service.</p> </li> <li> <p>Usage budgets allow you to say how many hours you want to use for one or more services.</p> </li> <li> <p>RI utilization budgets allow you to define a utilization threshold and receive alerts when RIs are tracking below that threshold.</p> </li> </ul> <p>You can create up to 20,000 budgets per AWS master account. Your first two budgets are free of charge. Each additional budget costs $0.02 per day. You can set up optional notifications that warn you if you exceed, or are forecasted to exceed, your budgeted amount. You can have notifications sent to an Amazon SNS topic, to an email address, or to both. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-sns-policy.html\">Creating an Amazon SNS Topic for Budget Notifications</a>. AWS Free Tier usage alerts via AWS Budgets are provided for you, and do not count toward your budget limits.</p> <p>Service Endpoint</p> <p>The AWS Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.amazonaws.com</p> </li> </ul> <p>For information about costs associated with the AWS Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>"
}

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

@ -114,8 +114,13 @@
"shapes":{
"AccountScope":{
"type":"string",
"enum":["PAYER"]
"enum":[
"PAYER",
"LINKED"
]
},
"AmortizedRecurringFee":{"type":"string"},
"AmortizedUpfrontFee":{"type":"string"},
"AttributeType":{"type":"string"},
"AttributeValue":{"type":"string"},
"Attributes":{
@ -351,7 +356,7 @@
"documentation":"<p>The specific <code>Tag</code> to use for <code>Expression</code>.</p>"
}
},
"documentation":"<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tag\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>"
"documentation":"<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>"
},
"Expressions":{
"type":"list",
@ -376,7 +381,7 @@
},
"Metrics":{
"shape":"MetricNames",
"documentation":"<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
"documentation":"<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
},
"GroupBy":{
"shape":"GroupDefinitions",
@ -478,7 +483,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> 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>"
"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 <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> 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>"
},
"NextPageToken":{
"shape":"NextPageToken",
@ -519,7 +524,7 @@
},
"AccountScope":{
"shape":"AccountScope",
"documentation":"<p>The account scope that you want recommendations for. The only valid value is <code>Payer</code>. This means that AWS includes the master account and any member accounts when it calculates its recommendations.</p>"
"documentation":"<p>The account scope that you want recommendations for. <code>PAYER</code> means that AWS includes the master account and any member accounts when it calculates its recommendations. <code>LINKED</code> means that AWS includes only member accounts when it calculates its recommendations.</p> <p>Valid values are <code>PAYER</code> and <code>LINKED</code>.</p>"
},
"LookbackPeriodInDays":{
"shape":"LookbackPeriodInDays",
@ -776,6 +781,7 @@
"key":{"shape":"MetricName"},
"value":{"shape":"MetricValue"}
},
"NetRISavings":{"type":"string"},
"NextPageToken":{"type":"string"},
"NonNegativeInteger":{
"type":"integer",
@ -788,6 +794,7 @@
"CONVERTIBLE"
]
},
"OnDemandCostOfRIHoursUsed":{"type":"string"},
"OnDemandHours":{"type":"string"},
"PageSize":{"type":"integer"},
"PaymentOption":{
@ -818,9 +825,13 @@
"shape":"GenericString",
"documentation":"<p>The database engine that the recommended reservation supports.</p>"
},
"DatabaseEdition":{
"shape":"GenericString",
"documentation":"<p>The database edition that the recommended reservation supports.</p>"
},
"DeploymentOption":{
"shape":"GenericString",
"documentation":"<p>Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.</p>"
"documentation":"<p>Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.</p>"
},
"LicenseModel":{
"shape":"GenericString",
@ -863,9 +874,33 @@
"UnusedHours":{
"shape":"UnusedHours",
"documentation":"<p>The number of RI hours that you didn't use.</p>"
},
"OnDemandCostOfRIHoursUsed":{
"shape":"OnDemandCostOfRIHoursUsed",
"documentation":"<p>How much your RIs would cost if charged On-Demand rates.</p>"
},
"NetRISavings":{
"shape":"NetRISavings",
"documentation":"<p>How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting <code>TotalAmortizedFee</code> from <code>OnDemandCostOfRIHoursUsed</code>.</p>"
},
"TotalPotentialRISavings":{
"shape":"TotalPotentialRISavings",
"documentation":"<p>How much you could save if you use your entire reservation.</p>"
},
"AmortizedUpfrontFee":{
"shape":"AmortizedUpfrontFee",
"documentation":"<p>The upfront cost of your RI, amortized over the RI period.</p>"
},
"AmortizedRecurringFee":{
"shape":"AmortizedRecurringFee",
"documentation":"<p>The monthly cost of your RI, amortized over the RI period.</p>"
},
"TotalAmortizedFee":{
"shape":"TotalAmortizedFee",
"documentation":"<p>The total cost of your RI, amortized over the RI period.</p>"
}
},
"documentation":"<p>The aggregated numbers for your RI usage.</p>"
"documentation":"<p>The aggregated numbers for your Reserved Instance (RI) usage.</p>"
},
"ReservationCoverageGroup":{
"type":"structure",
@ -896,7 +931,7 @@
},
"LookbackPeriodInDays":{
"shape":"LookbackPeriodInDays",
"documentation":"<p>How many days of previous usage that AWS takes into consideration when making this recommendation.</p>"
"documentation":"<p>How many days of previous usage that AWS considers when making this recommendation.</p>"
},
"TermInYears":{
"shape":"TermInYears",
@ -1033,7 +1068,7 @@
"documentation":"<p>The currency code used for this recommendation.</p>"
}
},
"documentation":"<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates you could save, and the total amount of reservation to purchase.</p>"
"documentation":"<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates that you could save, and the total amount of reservation to purchase.</p>"
},
"ReservationPurchaseRecommendations":{
"type":"list",
@ -1059,7 +1094,7 @@
"documentation":"<p>How much you used this group of RIs.</p>"
}
},
"documentation":"<p>A group of RIs that share a set of attributes.</p>"
"documentation":"<p>A group of Reserved Instances (RIs) that share a set of attributes.</p>"
},
"ReservationUtilizationGroups":{
"type":"list",
@ -1130,6 +1165,8 @@
]
},
"TotalActualHours":{"type":"string"},
"TotalAmortizedFee":{"type":"string"},
"TotalPotentialRISavings":{"type":"string"},
"TotalRunningHours":{"type":"string"},
"UnusedHours":{"type":"string"},
"UtilizationByTime":{

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

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Cloud9",
"serviceId":"Cloud9",
"signatureVersion":"v4",
"targetPrefix":"AWSCloud9WorkspaceManagementService",
"uid":"cloud9-2017-09-23"

212
botocore/data/clouddirectory/2016-05-10/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"clouddirectory",
"protocol":"rest-json",
"serviceFullName":"Amazon CloudDirectory",
"serviceId":"CloudDirectory",
"signatureVersion":"v4",
"signingName":"clouddirectory",
"uid":"clouddirectory-2016-05-10"
@ -624,6 +625,28 @@
],
"documentation":"<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>"
},
"GetLinkAttributes":{
"name":"GetLinkAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/get",
"responseCode":200
},
"input":{"shape":"GetLinkAttributesRequest"},
"output":{"shape":"GetLinkAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Retrieves attributes that are associated with a typed link.</p>"
},
"GetObjectAttributes":{
"name":"GetObjectAttributes",
"http":{
@ -1278,6 +1301,28 @@
],
"documentation":"<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>"
},
"UpdateLinkAttributes":{
"name":"UpdateLinkAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/update",
"responseCode":200
},
"input":{"shape":"UpdateLinkAttributesRequest"},
"output":{"shape":"UpdateLinkAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>.</p>"
},
"UpdateObjectAttributes":{
"name":"UpdateObjectAttributes",
"http":{
@ -1296,6 +1341,7 @@
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Updates a given object's attributes.</p>"
@ -2042,6 +2088,34 @@
},
"documentation":"<p>Represents the output of a <a>DetachTypedLink</a> response operation.</p>"
},
"BatchGetLinkAttributes":{
"type":"structure",
"required":[
"TypedLinkSpecifier",
"AttributeNames"
],
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>A list of attribute names whose values will be retrieved.</p>"
}
},
"documentation":"<p>Retrieves attributes that are associated with a typed link inside a <a>BatchRead</a> operation. For more information, see <a>GetLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetLinkAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetLinkAttributes</a> response operation.</p>"
},
"BatchGetObjectAttributes":{
"type":"structure",
"required":[
@ -2537,6 +2611,10 @@
"ListIncomingTypedLinks":{
"shape":"BatchListIncomingTypedLinks",
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"GetLinkAttributes":{
"shape":"BatchGetLinkAttributes",
"documentation":"<p>Retrieves attributes that are associated with a typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchRead</code> operation.</p>"
@ -2647,6 +2725,10 @@
"ListIncomingTypedLinks":{
"shape":"BatchListIncomingTypedLinksResponse",
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"GetLinkAttributes":{
"shape":"BatchGetLinkAttributesResponse",
"documentation":"<p>The list of attributes to retrieve from the typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchRead</code> success response operation.</p>"
@ -2676,6 +2758,30 @@
},
"documentation":"<p>An empty result that represents success.</p>"
},
"BatchUpdateLinkAttributes":{
"type":"structure",
"required":[
"TypedLinkSpecifier",
"AttributeUpdates"
],
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeUpdates":{
"shape":"LinkAttributeUpdateList",
"documentation":"<p>The attributes update structure.</p>"
}
},
"documentation":"<p>Updates a given typed link’s attributes inside a <a>BatchRead</a> operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>. For more information, see <a>UpdateLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchUpdateLinkAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>UpdateLinkAttributes</a> response operation.</p>"
},
"BatchUpdateObjectAttributes":{
"type":"structure",
"required":[
@ -2795,6 +2901,10 @@
"DetachTypedLink":{
"shape":"BatchDetachTypedLink",
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"UpdateLinkAttributes":{
"shape":"BatchUpdateLinkAttributes",
"documentation":"<p>Updates a given object's attributes.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchWrite</code> operation. </p>"
@ -2861,6 +2971,10 @@
"DetachTypedLink":{
"shape":"BatchDetachTypedLinkResponse",
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"UpdateLinkAttributes":{
"shape":"BatchUpdateLinkAttributesResponse",
"documentation":"<p>Represents the output of a <code>BatchWrite</code> response operation.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchWrite</code> response operation.</p>"
@ -3697,6 +3811,43 @@
}
}
},
"GetLinkAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TypedLinkSpecifier",
"AttributeNames"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see <a>arns</a> or <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>A list of attribute names whose values will be retrieved.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level at which to retrieve the attributes on a typed link.</p>"
}
}
},
"GetLinkAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the typed link.</p>"
}
}
},
"GetObjectAttributesRequest":{
"type":"structure",
"required":[
@ -3949,6 +4100,38 @@
"error":{"httpStatusCode":400},
"exception":true
},
"LinkAttributeAction":{
"type":"structure",
"members":{
"AttributeActionType":{
"shape":"UpdateActionType",
"documentation":"<p>A type that can be either <code>UPDATE_OR_CREATE</code> or <code>DELETE</code>.</p>"
},
"AttributeUpdateValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value that you want to update to.</p>"
}
},
"documentation":"<p>The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.</p>"
},
"LinkAttributeUpdate":{
"type":"structure",
"members":{
"AttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute being updated.</p>"
},
"AttributeAction":{
"shape":"LinkAttributeAction",
"documentation":"<p>The action to perform as part of the attribute update.</p>"
}
},
"documentation":"<p>Structure that contains attribute update information.</p>"
},
"LinkAttributeUpdateList":{
"type":"list",
"member":{"shape":"LinkAttributeUpdate"}
},
"LinkName":{
"type":"string",
"max":64,
@ -5528,6 +5711,35 @@
"members":{
}
},
"UpdateLinkAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TypedLinkSpecifier",
"AttributeUpdates"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see <a>arns</a> or <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeUpdates":{
"shape":"LinkAttributeUpdateList",
"documentation":"<p>The attributes update structure.</p>"
}
}
},
"UpdateLinkAttributesResponse":{
"type":"structure",
"members":{
}
},
"UpdateObjectAttributesRequest":{
"type":"structure",
"required":[

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

@ -0,0 +1,100 @@
{
"pagination": {
"ListObjectParentPaths": {
"result_key": "PathToObjectIdentifiersList",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListFacetNames": {
"result_key": "FacetNames",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListPublishedSchemaArns": {
"result_key": "SchemaArns",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListDirectories": {
"result_key": "Directories",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListDevelopmentSchemaArns": {
"result_key": "SchemaArns",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTypedLinkFacetNames": {
"result_key": "FacetNames",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListIndex": {
"result_key": "IndexAttachments",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListFacetAttributes": {
"result_key": "Attributes",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectPolicies": {
"result_key": "AttachedPolicyIds",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTagsForResource": {
"result_key": "Tags",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListAttachedIndices": {
"result_key": "IndexAttachments",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"LookupPolicy": {
"result_key": "PolicyToPathList",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListPolicyAttachments": {
"result_key": "ObjectIdentifiers",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectAttributes": {
"result_key": "Attributes",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListAppliedSchemaArns": {
"result_key": "SchemaArns",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTypedLinkFacetAttributes": {
"result_key": "Attributes",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

5991
botocore/data/clouddirectory/2017-01-11/service-2.json Normal file
View file

@ -0,0 +1,5991 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-01-11",
"endpointPrefix":"clouddirectory",
"protocol":"rest-json",
"serviceFullName":"Amazon CloudDirectory",
"serviceId":"CloudDirectory",
"signatureVersion":"v4",
"signingName":"clouddirectory",
"uid":"clouddirectory-2017-01-11"
},
"operations":{
"AddFacetToObject":{
"name":"AddFacetToObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/facets",
"responseCode":200
},
"input":{"shape":"AddFacetToObjectRequest"},
"output":{"shape":"AddFacetToObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it.</p>"
},
"ApplySchema":{
"name":"ApplySchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/apply",
"responseCode":200
},
"input":{"shape":"ApplySchemaRequest"},
"output":{"shape":"ApplySchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"SchemaAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"}
],
"documentation":"<p>Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema.</p>"
},
"AttachObject":{
"name":"AttachObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/attach",
"responseCode":200
},
"input":{"shape":"AttachObjectRequest"},
"output":{"shape":"AttachObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"InvalidAttachmentException"},
{"shape":"ValidationException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIdentifier</code> </p> </li> </ol>"
},
"AttachPolicy":{
"name":"AttachPolicy",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/attach",
"responseCode":200
},
"input":{"shape":"AttachPolicyRequest"},
"output":{"shape":"AttachPolicyResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
],
"documentation":"<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
},
"AttachToIndex":{
"name":"AttachToIndex",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/index/attach",
"responseCode":200
},
"input":{"shape":"AttachToIndexRequest"},
"output":{"shape":"AttachToIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidAttachmentException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"IndexedAttributeMissingException"},
{"shape":"NotIndexException"}
],
"documentation":"<p>Attaches the specified object to the specified index.</p>"
},
"AttachTypedLink":{
"name":"AttachTypedLink",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attach",
"responseCode":200
},
"input":{"shape":"AttachTypedLinkRequest"},
"output":{"shape":"AttachTypedLinkResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"},
{"shape":"ValidationException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"BatchRead":{
"name":"BatchRead",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/batchread",
"responseCode":200
},
"input":{"shape":"BatchReadRequest"},
"output":{"shape":"BatchReadResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"}
],
"documentation":"<p>Performs all the read operations in a batch. </p>"
},
"BatchWrite":{
"name":"BatchWrite",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/batchwrite",
"responseCode":200
},
"input":{"shape":"BatchWriteRequest"},
"output":{"shape":"BatchWriteResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"BatchWriteException"}
],
"documentation":"<p>Performs all the write operations in a batch. Either all the operations succeed or none.</p>"
},
"CreateDirectory":{
"name":"CreateDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/create",
"responseCode":200
},
"input":{"shape":"CreateDirectoryRequest"},
"output":{"shape":"CreateDirectoryResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryAlreadyExistsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p>"
},
"CreateFacet":{
"name":"CreateFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/create",
"responseCode":200
},
"input":{"shape":"CreateFacetRequest"},
"output":{"shape":"CreateFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetAlreadyExistsException"},
{"shape":"InvalidRuleException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.</p>"
},
"CreateIndex":{
"name":"CreateIndex",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/index",
"responseCode":200
},
"input":{"shape":"CreateIndexRequest"},
"output":{"shape":"CreateIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"UnsupportedIndexTypeException"}
],
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
},
"CreateObject":{
"name":"CreateObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object",
"responseCode":200
},
"input":{"shape":"CreateObjectRequest"},
"output":{"shape":"CreateObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"UnsupportedIndexTypeException"}
],
"documentation":"<p>Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <code>LinkName</code> is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. </p>"
},
"CreateSchema":{
"name":"CreateSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/create",
"responseCode":200
},
"input":{"shape":"CreateSchemaRequest"},
"output":{"shape":"CreateSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"SchemaAlreadyExistsException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a new schema in a development state. A schema can exist in three phases:</p> <ul> <li> <p> <i>Development:</i> This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.</p> </li> <li> <p> <i>Published:</i> Published schemas are immutable and have a version associated with them.</p> </li> <li> <p> <i>Applied:</i> Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. </p> </li> </ul>"
},
"CreateTypedLinkFacet":{
"name":"CreateTypedLinkFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/create",
"responseCode":200
},
"input":{"shape":"CreateTypedLinkFacetRequest"},
"output":{"shape":"CreateTypedLinkFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetAlreadyExistsException"},
{"shape":"InvalidRuleException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Creates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DeleteDirectory":{
"name":"DeleteDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory",
"responseCode":200
},
"input":{"shape":"DeleteDirectoryRequest"},
"output":{"shape":"DeleteDirectoryResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DirectoryNotDisabledException"},
{"shape":"InternalServiceException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryDeletedException"},
{"shape":"RetryableConflictException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.</p>"
},
"DeleteFacet":{
"name":"DeleteFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/delete",
"responseCode":200
},
"input":{"shape":"DeleteFacetRequest"},
"output":{"shape":"DeleteFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"FacetInUseException"}
],
"documentation":"<p>Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s that are associated with the facet will be deleted. Only development schema facets are allowed deletion.</p>"
},
"DeleteObject":{
"name":"DeleteObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/delete",
"responseCode":200
},
"input":{"shape":"DeleteObjectRequest"},
"output":{"shape":"DeleteObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ObjectNotDetachedException"}
],
"documentation":"<p>Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.</p>"
},
"DeleteSchema":{
"name":"DeleteSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema",
"responseCode":200
},
"input":{"shape":"DeleteSchemaRequest"},
"output":{"shape":"DeleteSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"StillContainsLinksException"}
],
"documentation":"<p>Deletes a given schema. Schemas in a development and published state can only be deleted. </p>"
},
"DeleteTypedLinkFacet":{
"name":"DeleteTypedLinkFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/delete",
"responseCode":200
},
"input":{"shape":"DeleteTypedLinkFacetRequest"},
"output":{"shape":"DeleteTypedLinkFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"}
],
"documentation":"<p>Deletes a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DetachFromIndex":{
"name":"DetachFromIndex",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/index/detach",
"responseCode":200
},
"input":{"shape":"DetachFromIndexRequest"},
"output":{"shape":"DetachFromIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ObjectAlreadyDetachedException"},
{"shape":"NotIndexException"}
],
"documentation":"<p>Detaches the specified object from the specified index.</p>"
},
"DetachObject":{
"name":"DetachObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/detach",
"responseCode":200
},
"input":{"shape":"DetachObjectRequest"},
"output":{"shape":"DetachObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotNodeException"}
],
"documentation":"<p>Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.</p>"
},
"DetachPolicy":{
"name":"DetachPolicy",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/detach",
"responseCode":200
},
"input":{"shape":"DetachPolicyRequest"},
"output":{"shape":"DetachPolicyResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
],
"documentation":"<p>Detaches a policy from an object.</p>"
},
"DetachTypedLink":{
"name":"DetachTypedLink",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/detach",
"responseCode":200
},
"input":{"shape":"DetachTypedLinkRequest"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DisableDirectory":{
"name":"DisableDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/disable",
"responseCode":200
},
"input":{"shape":"DisableDirectoryRequest"},
"output":{"shape":"DisableDirectoryResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DirectoryDeletedException"},
{"shape":"InternalServiceException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"RetryableConflictException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>"
},
"EnableDirectory":{
"name":"EnableDirectory",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/enable",
"responseCode":200
},
"input":{"shape":"EnableDirectoryRequest"},
"output":{"shape":"EnableDirectoryResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DirectoryDeletedException"},
{"shape":"InternalServiceException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"RetryableConflictException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>"
},
"GetAppliedSchemaVersion":{
"name":"GetAppliedSchemaVersion",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/getappliedschema",
"responseCode":200
},
"input":{"shape":"GetAppliedSchemaVersionRequest"},
"output":{"shape":"GetAppliedSchemaVersionResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns current applied schema version ARN, including the minor version in use.</p>"
},
"GetDirectory":{
"name":"GetDirectory",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/get",
"responseCode":200
},
"input":{"shape":"GetDirectoryRequest"},
"output":{"shape":"GetDirectoryResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves metadata about a directory.</p>"
},
"GetFacet":{
"name":"GetFacet",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/facet",
"responseCode":200
},
"input":{"shape":"GetFacetRequest"},
"output":{"shape":"GetFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"}
],
"documentation":"<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>"
},
"GetLinkAttributes":{
"name":"GetLinkAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/get",
"responseCode":200
},
"input":{"shape":"GetLinkAttributesRequest"},
"output":{"shape":"GetLinkAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Retrieves attributes that are associated with a typed link.</p>"
},
"GetObjectAttributes":{
"name":"GetObjectAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/attributes/get",
"responseCode":200
},
"input":{"shape":"GetObjectAttributesRequest"},
"output":{"shape":"GetObjectAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Retrieves attributes within a facet that are associated with an object.</p>"
},
"GetObjectInformation":{
"name":"GetObjectInformation",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/information",
"responseCode":200
},
"input":{"shape":"GetObjectInformationRequest"},
"output":{"shape":"GetObjectInformationResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves metadata about an object.</p>"
},
"GetSchemaAsJson":{
"name":"GetSchemaAsJson",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/json",
"responseCode":200
},
"input":{"shape":"GetSchemaAsJsonRequest"},
"output":{"shape":"GetSchemaAsJsonResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
},
"GetTypedLinkFacetInformation":{
"name":"GetTypedLinkFacetInformation",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/get",
"responseCode":200
},
"input":{"shape":"GetTypedLinkFacetInformationRequest"},
"output":{"shape":"GetTypedLinkFacetInformationResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetNotFoundException"}
],
"documentation":"<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListAppliedSchemaArns":{
"name":"ListAppliedSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/applied",
"responseCode":200
},
"input":{"shape":"ListAppliedSchemaArnsRequest"},
"output":{"shape":"ListAppliedSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists schema major versions applied to a directory. If <code>SchemaArn</code> is provided, lists the minor version.</p>"
},
"ListAttachedIndices":{
"name":"ListAttachedIndices",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/indices",
"responseCode":200
},
"input":{"shape":"ListAttachedIndicesRequest"},
"output":{"shape":"ListAttachedIndicesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists indices attached to the specified object.</p>"
},
"ListDevelopmentSchemaArns":{
"name":"ListDevelopmentSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/development",
"responseCode":200
},
"input":{"shape":"ListDevelopmentSchemaArnsRequest"},
"output":{"shape":"ListDevelopmentSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves each Amazon Resource Name (ARN) of schemas in the development state.</p>"
},
"ListDirectories":{
"name":"ListDirectories",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/directory/list",
"responseCode":200
},
"input":{"shape":"ListDirectoriesRequest"},
"output":{"shape":"ListDirectoriesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists directories created within an account.</p>"
},
"ListFacetAttributes":{
"name":"ListFacetAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/attributes",
"responseCode":200
},
"input":{"shape":"ListFacetAttributesRequest"},
"output":{"shape":"ListFacetAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves attributes attached to the facet.</p>"
},
"ListFacetNames":{
"name":"ListFacetNames",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/facet/list",
"responseCode":200
},
"input":{"shape":"ListFacetNamesRequest"},
"output":{"shape":"ListFacetNamesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves the names of facets that exist in a schema.</p>"
},
"ListIncomingTypedLinks":{
"name":"ListIncomingTypedLinks",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/incoming",
"responseCode":200
},
"input":{"shape":"ListIncomingTypedLinksRequest"},
"output":{"shape":"ListIncomingTypedLinksResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListIndex":{
"name":"ListIndex",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/index/targets",
"responseCode":200
},
"input":{"shape":"ListIndexRequest"},
"output":{"shape":"ListIndexResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"FacetValidationException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotIndexException"}
],
"documentation":"<p>Lists objects attached to the specified index.</p>"
},
"ListManagedSchemaArns":{
"name":"ListManagedSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/managed",
"responseCode":200
},
"input":{"shape":"ListManagedSchemaArnsRequest"},
"output":{"shape":"ListManagedSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.</p>"
},
"ListObjectAttributes":{
"name":"ListObjectAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/attributes",
"responseCode":200
},
"input":{"shape":"ListObjectAttributesRequest"},
"output":{"shape":"ListObjectAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Lists all attributes that are associated with an object. </p>"
},
"ListObjectChildren":{
"name":"ListObjectChildren",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/children",
"responseCode":200
},
"input":{"shape":"ListObjectChildrenRequest"},
"output":{"shape":"ListObjectChildrenResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"NotNodeException"}
],
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
},
"ListObjectParentPaths":{
"name":"ListObjectParentPaths",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/parentpaths",
"responseCode":200
},
"input":{"shape":"ListObjectParentPathsRequest"},
"output":{"shape":"ListObjectParentPathsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p> <p>Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined <code>MaxResults</code>, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.</p>"
},
"ListObjectParents":{
"name":"ListObjectParents",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/parent",
"responseCode":200
},
"input":{"shape":"ListObjectParentsRequest"},
"output":{"shape":"ListObjectParentsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"CannotListParentOfRootException"}
],
"documentation":"<p>Lists parent objects that are associated with a given object in pagination fashion.</p>"
},
"ListObjectPolicies":{
"name":"ListObjectPolicies",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/policy",
"responseCode":200
},
"input":{"shape":"ListObjectPoliciesRequest"},
"output":{"shape":"ListObjectPoliciesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
},
"ListOutgoingTypedLinks":{
"name":"ListOutgoingTypedLinks",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/outgoing",
"responseCode":200
},
"input":{"shape":"ListOutgoingTypedLinksRequest"},
"output":{"shape":"ListOutgoingTypedLinksResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListPolicyAttachments":{
"name":"ListPolicyAttachments",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/attachment",
"responseCode":200
},
"input":{"shape":"ListPolicyAttachmentsRequest"},
"output":{"shape":"ListPolicyAttachmentsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
],
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
},
"ListPublishedSchemaArns":{
"name":"ListPublishedSchemaArns",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/published",
"responseCode":200
},
"input":{"shape":"ListPublishedSchemaArnsRequest"},
"output":{"shape":"ListPublishedSchemaArnsResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that family are listed instead.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/tags",
"responseCode":200
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidTaggingRequestException"}
],
"documentation":"<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>"
},
"ListTypedLinkFacetAttributes":{
"name":"ListTypedLinkFacetAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/attributes",
"responseCode":200
},
"input":{"shape":"ListTypedLinkFacetAttributesRequest"},
"output":{"shape":"ListTypedLinkFacetAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListTypedLinkFacetNames":{
"name":"ListTypedLinkFacetNames",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/list",
"responseCode":200
},
"input":{"shape":"ListTypedLinkFacetNamesRequest"},
"output":{"shape":"ListTypedLinkFacetNamesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"LookupPolicy":{
"name":"LookupPolicy",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/policy/lookup",
"responseCode":200
},
"input":{"shape":"LookupPolicyRequest"},
"output":{"shape":"LookupPolicyResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"PublishSchema":{
"name":"PublishSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/publish",
"responseCode":200
},
"input":{"shape":"PublishSchemaRequest"},
"output":{"shape":"PublishSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"SchemaAlreadyPublishedException"}
],
"documentation":"<p>Publishes a development schema with a major version and a recommended minor version.</p>"
},
"PutSchemaFromJson":{
"name":"PutSchemaFromJson",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/json",
"responseCode":200
},
"input":{"shape":"PutSchemaFromJsonRequest"},
"output":{"shape":"PutSchemaFromJsonResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidSchemaDocException"},
{"shape":"InvalidRuleException"}
],
"documentation":"<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
},
"RemoveFacetFromObject":{
"name":"RemoveFacetFromObject",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/facets/delete",
"responseCode":200
},
"input":{"shape":"RemoveFacetFromObjectRequest"},
"output":{"shape":"RemoveFacetFromObjectResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Removes the specified facet from the specified object.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/tags/add",
"responseCode":200
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidTaggingRequestException"}
],
"documentation":"<p>An API operation for adding tags to a resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/tags/remove",
"responseCode":200
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidTaggingRequestException"}
],
"documentation":"<p>An API operation for removing tags from a resource.</p>"
},
"UpdateFacet":{
"name":"UpdateFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/facet",
"responseCode":200
},
"input":{"shape":"UpdateFacetRequest"},
"output":{"shape":"UpdateFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidFacetUpdateException"},
{"shape":"FacetValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"InvalidRuleException"}
],
"documentation":"<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>"
},
"UpdateLinkAttributes":{
"name":"UpdateLinkAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/update",
"responseCode":200
},
"input":{"shape":"UpdateLinkAttributesRequest"},
"output":{"shape":"UpdateLinkAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>.</p>"
},
"UpdateObjectAttributes":{
"name":"UpdateObjectAttributes",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/object/update",
"responseCode":200
},
"input":{"shape":"UpdateObjectAttributesRequest"},
"output":{"shape":"UpdateObjectAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"FacetValidationException"}
],
"documentation":"<p>Updates a given object's attributes.</p>"
},
"UpdateSchema":{
"name":"UpdateSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/update",
"responseCode":200
},
"input":{"shape":"UpdateSchemaRequest"},
"output":{"shape":"UpdateSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the schema name with a new name. Only development schema names can be updated.</p>"
},
"UpdateTypedLinkFacet":{
"name":"UpdateTypedLinkFacet",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet",
"responseCode":200
},
"input":{"shape":"UpdateTypedLinkFacetRequest"},
"output":{"shape":"UpdateTypedLinkFacetResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"FacetValidationException"},
{"shape":"InvalidFacetUpdateException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetNotFoundException"},
{"shape":"InvalidRuleException"}
],
"documentation":"<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"UpgradeAppliedSchema":{
"name":"UpgradeAppliedSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradeapplied",
"responseCode":200
},
"input":{"shape":"UpgradeAppliedSchemaRequest"},
"output":{"shape":"UpgradeAppliedSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"IncompatibleSchemaException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"},
{"shape":"SchemaAlreadyExistsException"}
],
"documentation":"<p>Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.</p>"
},
"UpgradePublishedSchema":{
"name":"UpgradePublishedSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradepublished",
"responseCode":200
},
"input":{"shape":"UpgradePublishedSchemaRequest"},
"output":{"shape":"UpgradePublishedSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"IncompatibleSchemaException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Upgrades a published schema under a new minor version revision using the current contents of <code>DevelopmentSchemaArn</code>.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Access denied. Check your permissions.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"AddFacetToObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SchemaFacet",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Identifiers for the facet that you are adding to the object. See <a>SchemaFacet</a> for details.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attributes on the facet that you are adding to the object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object you are adding the specified facet to.</p>"
}
}
},
"AddFacetToObjectResponse":{
"type":"structure",
"members":{
}
},
"ApplySchemaRequest":{
"type":"structure",
"required":[
"PublishedSchemaArn",
"DirectoryArn"
],
"members":{
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see <a>arns</a>.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"ApplySchemaResponse":{
"type":"structure",
"members":{
"AppliedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The applied schema ARN that is associated with the copied schema in the <a>Directory</a>. You can use this ARN to describe the schema information applied on this directory. For more information, see <a>arns</a>.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
}
}
},
"Arn":{"type":"string"},
"Arns":{
"type":"list",
"member":{"shape":"Arn"}
},
"AttachObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ParentReference",
"ChildReference",
"LinkName"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>The parent object reference.</p>"
},
"ChildReference":{
"shape":"ObjectReference",
"documentation":"<p>The child object reference to be attached to the object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The link name with which the child object is attached to the parent.</p>"
}
}
},
"AttachObjectResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The attached <code>ObjectIdentifier</code>, which is the child <code>ObjectIdentifier</code>.</p>"
}
}
},
"AttachPolicyRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"PolicyReference",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that is associated with the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object to which the policy will be attached.</p>"
}
}
},
"AttachPolicyResponse":{
"type":"structure",
"members":{
}
},
"AttachToIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"IndexReference",
"TargetReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where the object and index exist.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index that you are attaching the object to.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that you are attaching to the index.</p>"
}
}
},
"AttachToIndexResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>"
}
}
},
"AttachTypedLinkRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SourceObjectReference",
"TargetObjectReference",
"TypedLinkFacet",
"Attributes"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SourceObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
},
"TargetObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
},
"TypedLinkFacet":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
},
"Attributes":{
"shape":"AttributeNameAndValueList",
"documentation":"<p>A set of attributes that are associated with the typed link.</p>"
}
}
},
"AttachTypedLinkResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Returns a typed link specifier as output.</p>"
}
}
},
"AttributeKey":{
"type":"structure",
"required":[
"SchemaArn",
"FacetName",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.</p>"
},
"FacetName":{
"shape":"FacetName",
"documentation":"<p>The name of the facet that the attribute exists within.</p>"
},
"Name":{
"shape":"AttributeName",
"documentation":"<p>The name of the attribute.</p>"
}
},
"documentation":"<p>A unique identifier for an attribute.</p>"
},
"AttributeKeyAndValue":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute.</p>"
},
"Value":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value of the attribute.</p>"
}
},
"documentation":"<p>The combination of an attribute key and an attribute value.</p>"
},
"AttributeKeyAndValueList":{
"type":"list",
"member":{"shape":"AttributeKeyAndValue"}
},
"AttributeKeyList":{
"type":"list",
"member":{"shape":"AttributeKey"}
},
"AttributeName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"AttributeNameAndValue":{
"type":"structure",
"required":[
"AttributeName",
"Value"
],
"members":{
"AttributeName":{
"shape":"AttributeName",
"documentation":"<p>The attribute name of the typed link.</p>"
},
"Value":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value for the typed link.</p>"
}
},
"documentation":"<p>Identifies the attribute name and value for a typed link.</p>"
},
"AttributeNameAndValueList":{
"type":"list",
"member":{"shape":"AttributeNameAndValue"}
},
"AttributeNameList":{
"type":"list",
"member":{"shape":"AttributeName"}
},
"BatchAddFacetToObject":{
"type":"structure",
"required":[
"SchemaFacet",
"ObjectAttributeList",
"ObjectReference"
],
"members":{
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Represents the facet being added to the object.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes to set on the object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object being mutated.</p>"
}
},
"documentation":"<p>Represents the output of a batch add facet to object operation.</p>"
},
"BatchAddFacetToObjectResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>The result of a batch add facet to object operation.</p>"
},
"BatchAttachObject":{
"type":"structure",
"required":[
"ParentReference",
"ChildReference",
"LinkName"
],
"members":{
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>The parent object reference.</p>"
},
"ChildReference":{
"shape":"ObjectReference",
"documentation":"<p>The child object reference that is to be attached to the object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
}
},
"documentation":"<p>Represents the output of an <a>AttachObject</a> operation.</p>"
},
"BatchAttachObjectResponse":{
"type":"structure",
"members":{
"attachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that has been attached.</p>"
}
},
"documentation":"<p>Represents the output batch <a>AttachObject</a> response operation.</p>"
},
"BatchAttachPolicy":{
"type":"structure",
"required":[
"PolicyReference",
"ObjectReference"
],
"members":{
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that is associated with the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object to which the policy will be attached.</p>"
}
},
"documentation":"<p>Attaches a policy object to a regular object inside a <a>BatchRead</a> operation. For more information, see <a>AttachPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchAttachPolicyResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of an <a>AttachPolicy</a> response operation.</p>"
},
"BatchAttachToIndex":{
"type":"structure",
"required":[
"IndexReference",
"TargetReference"
],
"members":{
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index that you are attaching the object to.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that you are attaching to the index.</p>"
}
},
"documentation":"<p>Attaches the specified object to the specified index inside a <a>BatchRead</a> operation. For more information, see <a>AttachToIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchAttachToIndexResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>"
}
},
"documentation":"<p>Represents the output of a <a>AttachToIndex</a> response operation.</p>"
},
"BatchAttachTypedLink":{
"type":"structure",
"required":[
"SourceObjectReference",
"TargetObjectReference",
"TypedLinkFacet",
"Attributes"
],
"members":{
"SourceObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
},
"TargetObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
},
"TypedLinkFacet":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
},
"Attributes":{
"shape":"AttributeNameAndValueList",
"documentation":"<p>A set of attributes that are associated with the typed link.</p>"
}
},
"documentation":"<p>Attaches a typed link to a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>AttachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchAttachTypedLinkResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Returns a typed link specifier as output.</p>"
}
},
"documentation":"<p>Represents the output of a <a>AttachTypedLink</a> response operation.</p>"
},
"BatchCreateIndex":{
"type":"structure",
"required":[
"OrderedIndexedAttributeList",
"IsUnique"
],
"members":{
"OrderedIndexedAttributeList":{
"shape":"AttributeKeyList",
"documentation":"<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>"
},
"IsUnique":{
"shape":"Bool",
"documentation":"<p>Indicates whether the attribute that is being indexed has unique values or not.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the parent object that contains the index object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link between the parent object and the index object.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
},
"documentation":"<p>Creates an index object inside of a <a>BatchRead</a> operation. For more information, see <a>CreateIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchCreateIndexResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>"
}
},
"documentation":"<p>Represents the output of a <a>CreateIndex</a> response operation.</p>"
},
"BatchCreateObject":{
"type":"structure",
"required":[
"SchemaFacet",
"ObjectAttributeList"
],
"members":{
"SchemaFacet":{
"shape":"SchemaFacetList",
"documentation":"<p>A list of <code>FacetArns</code> that will be associated with the object. For more information, see <a>arns</a>.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>An attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>If specified, the parent reference to which this object will be attached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
},
"documentation":"<p>Represents the output of a <a>CreateObject</a> operation.</p>"
},
"BatchCreateObjectResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ID that is associated with the object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>CreateObject</a> response operation.</p>"
},
"BatchDeleteObject":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>DeleteObject</a> operation.</p>"
},
"BatchDeleteObjectResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>DeleteObject</a> response operation.</p>"
},
"BatchDetachFromIndex":{
"type":"structure",
"required":[
"IndexReference",
"TargetReference"
],
"members":{
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index object.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object being detached from the index.</p>"
}
},
"documentation":"<p>Detaches the specified object from the specified index inside a <a>BatchRead</a> operation. For more information, see <a>DetachFromIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchDetachFromIndexResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>"
}
},
"documentation":"<p>Represents the output of a <a>DetachFromIndex</a> response operation.</p>"
},
"BatchDetachObject":{
"type":"structure",
"required":[
"ParentReference",
"LinkName"
],
"members":{
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>Parent reference from which the object with the specified link name is detached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link.</p>"
},
"BatchReferenceName":{
"shape":"BatchReferenceName",
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
},
"documentation":"<p>Represents the output of a <a>DetachObject</a> operation.</p>"
},
"BatchDetachObjectResponse":{
"type":"structure",
"members":{
"detachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the detached object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>DetachObject</a> response operation.</p>"
},
"BatchDetachPolicy":{
"type":"structure",
"required":[
"PolicyReference",
"ObjectReference"
],
"members":{
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policy object will be detached.</p>"
}
},
"documentation":"<p>Detaches the specified policy from the specified directory inside a <a>BatchWrite</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchWriteRequest$Operations</a>.</p>"
},
"BatchDetachPolicyResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>DetachPolicy</a> response operation.</p>"
},
"BatchDetachTypedLink":{
"type":"structure",
"required":["TypedLinkSpecifier"],
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Used to accept a typed link specifier as input.</p>"
}
},
"documentation":"<p>Detaches a typed link from a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>DetachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchDetachTypedLinkResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>DetachTypedLink</a> response operation.</p>"
},
"BatchGetLinkAttributes":{
"type":"structure",
"required":[
"TypedLinkSpecifier",
"AttributeNames"
],
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>A list of attribute names whose values will be retrieved.</p>"
}
},
"documentation":"<p>Retrieves attributes that are associated with a typed link inside a <a>BatchRead</a> operation. For more information, see <a>GetLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetLinkAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetLinkAttributes</a> response operation.</p>"
},
"BatchGetObjectAttributes":{
"type":"structure",
"required":[
"ObjectReference",
"SchemaFacet",
"AttributeNames"
],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose attributes will be retrieved.</p>"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>List of attribute names whose values will be retrieved.</p>"
}
},
"documentation":"<p>Retrieves attributes within a facet that are associated with an object inside an <a>BatchRead</a> operation. For more information, see <a>GetObjectAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attribute values that are associated with an object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetObjectAttributes</a> response operation.</p>"
},
"BatchGetObjectInformation":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object.</p>"
}
},
"documentation":"<p>Retrieves metadata about an object inside a <a>BatchRead</a> operation. For more information, see <a>GetObjectInformation</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchGetObjectInformationResponse":{
"type":"structure",
"members":{
"SchemaFacets":{
"shape":"SchemaFacetList",
"documentation":"<p>The facets attached to the specified object.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the specified object.</p>"
}
},
"documentation":"<p>Represents the output of a <a>GetObjectInformation</a> response operation.</p>"
},
"BatchListAttachedIndices":{
"type":"structure",
"required":["TargetReference"],
"members":{
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that has indices attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Lists indices attached to an object inside a <a>BatchRead</a> operation. For more information, see <a>ListAttachedIndices</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListAttachedIndicesResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The indices attached to the specified object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListAttachedIndices</a> response operation.</p>"
},
"BatchListIncomingTypedLinks":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListIncomingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListIncomingTypedLinksResponse":{
"type":"structure",
"members":{
"LinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns one or more typed link specifiers as output.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListIncomingTypedLinks</a> response operation.</p>"
},
"BatchListIndex":{
"type":"structure",
"required":["IndexReference"],
"members":{
"RangesOnIndexedValues":{
"shape":"ObjectAttributeRangeList",
"documentation":"<p>Specifies the ranges of indexed values that you want to query.</p>"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference to the index to list.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Lists objects attached to the specified index inside a <a>BatchRead</a> operation. For more information, see <a>ListIndex</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListIndexResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The objects and indexed values attached to the index.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListIndex</a> response operation.</p>"
},
"BatchListObjectAttributes":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference of the object whose attributes need to be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"FacetFilter":{
"shape":"SchemaFacet",
"documentation":"<p>Used to filter the list of object attributes that are associated with a certain facet.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectAttributes</a> operation.</p>"
},
"BatchListObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes map that is associated with the object. <code>AttributeArn</code> is the key; attribute value is the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectAttributes</a> response operation.</p>"
},
"BatchListObjectChildren":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference of the object for which child objects are being listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectChildren</a> operation.</p>"
},
"BatchListObjectChildrenResponse":{
"type":"structure",
"members":{
"Children":{
"shape":"LinkNameToObjectIdentifierMap",
"documentation":"<p>The children structure, which is a map with the key as the <code>LinkName</code> and <code>ObjectIdentifier</code> as the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectChildren</a> response operation.</p>"
},
"BatchListObjectParentPaths":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectParentPaths</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListObjectParentPathsResponse":{
"type":"structure",
"members":{
"PathToObjectIdentifiersList":{
"shape":"PathToObjectIdentifiersList",
"documentation":"<p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectParentPaths</a> response operation.</p>"
},
"BatchListObjectPolicies":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns policies attached to an object in pagination fashion inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectPolicies</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListObjectPoliciesResponse":{
"type":"structure",
"members":{
"AttachedPolicyIds":{
"shape":"ObjectIdentifierList",
"documentation":"<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListObjectPolicies</a> response operation.</p>"
},
"BatchListOutgoingTypedLinks":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListOutgoingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListOutgoingTypedLinksResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns a typed link specifier as output.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListOutgoingTypedLinks</a> response operation.</p>"
},
"BatchListPolicyAttachments":{
"type":"structure",
"required":["PolicyReference"],
"members":{
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the policy object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached inside a <a>BatchRead</a> operation. For more information, see <a>ListPolicyAttachments</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchListPolicyAttachmentsResponse":{
"type":"structure",
"members":{
"ObjectIdentifiers":{
"shape":"ObjectIdentifierList",
"documentation":"<p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>ListPolicyAttachments</a> response operation.</p>"
},
"BatchLookupPolicy":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policies will be looked up.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
},
"documentation":"<p>Lists all policies from the root of the Directory to the object specified inside a <a>BatchRead</a> operation. For more information, see <a>LookupPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchLookupPolicyResponse":{
"type":"structure",
"members":{
"PolicyToPathList":{
"shape":"PolicyToPathList",
"documentation":"<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
},
"documentation":"<p>Represents the output of a <a>LookupPolicy</a> response operation.</p>"
},
"BatchOperationIndex":{"type":"integer"},
"BatchReadException":{
"type":"structure",
"members":{
"Type":{
"shape":"BatchReadExceptionType",
"documentation":"<p>A type of exception, such as <code>InvalidArnException</code>.</p>"
},
"Message":{
"shape":"ExceptionMessage",
"documentation":"<p>An exception message that is associated with the failure.</p>"
}
},
"documentation":"<p>The batch read exception structure, which contains the exception type and message.</p>"
},
"BatchReadExceptionType":{
"type":"string",
"enum":[
"ValidationException",
"InvalidArnException",
"ResourceNotFoundException",
"InvalidNextTokenException",
"AccessDeniedException",
"NotNodeException",
"FacetValidationException",
"CannotListParentOfRootException",
"NotIndexException",
"NotPolicyException",
"DirectoryNotEnabledException",
"LimitExceededException",
"InternalServiceException"
]
},
"BatchReadOperation":{
"type":"structure",
"members":{
"ListObjectAttributes":{
"shape":"BatchListObjectAttributes",
"documentation":"<p>Lists all attributes that are associated with an object.</p>"
},
"ListObjectChildren":{
"shape":"BatchListObjectChildren",
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
},
"ListAttachedIndices":{
"shape":"BatchListAttachedIndices",
"documentation":"<p>Lists indices attached to an object.</p>"
},
"ListObjectParentPaths":{
"shape":"BatchListObjectParentPaths",
"documentation":"<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
},
"GetObjectInformation":{
"shape":"BatchGetObjectInformation",
"documentation":"<p>Retrieves metadata about an object.</p>"
},
"GetObjectAttributes":{
"shape":"BatchGetObjectAttributes",
"documentation":"<p>Retrieves attributes within a facet that are associated with an object.</p>"
},
"ListObjectPolicies":{
"shape":"BatchListObjectPolicies",
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
},
"ListPolicyAttachments":{
"shape":"BatchListPolicyAttachments",
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
},
"LookupPolicy":{
"shape":"BatchLookupPolicy",
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"ListIndex":{
"shape":"BatchListIndex",
"documentation":"<p>Lists objects attached to the specified index.</p>"
},
"ListOutgoingTypedLinks":{
"shape":"BatchListOutgoingTypedLinks",
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListIncomingTypedLinks":{
"shape":"BatchListIncomingTypedLinks",
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"GetLinkAttributes":{
"shape":"BatchGetLinkAttributes",
"documentation":"<p>Retrieves attributes that are associated with a typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchRead</code> operation.</p>"
},
"BatchReadOperationList":{
"type":"list",
"member":{"shape":"BatchReadOperation"}
},
"BatchReadOperationResponse":{
"type":"structure",
"members":{
"SuccessfulResponse":{
"shape":"BatchReadSuccessfulResponse",
"documentation":"<p>Identifies which operation in a batch has succeeded.</p>"
},
"ExceptionResponse":{
"shape":"BatchReadException",
"documentation":"<p>Identifies which operation in a batch has failed.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchRead</code> response operation.</p>"
},
"BatchReadOperationResponseList":{
"type":"list",
"member":{"shape":"BatchReadOperationResponse"}
},
"BatchReadRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"Operations"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Operations":{
"shape":"BatchReadOperationList",
"documentation":"<p>A list of operations that are part of the batch.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"BatchReadResponse":{
"type":"structure",
"members":{
"Responses":{
"shape":"BatchReadOperationResponseList",
"documentation":"<p>A list of all the responses for each batch read.</p>"
}
}
},
"BatchReadSuccessfulResponse":{
"type":"structure",
"members":{
"ListObjectAttributes":{
"shape":"BatchListObjectAttributesResponse",
"documentation":"<p>Lists all attributes that are associated with an object.</p>"
},
"ListObjectChildren":{
"shape":"BatchListObjectChildrenResponse",
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
},
"GetObjectInformation":{
"shape":"BatchGetObjectInformationResponse",
"documentation":"<p>Retrieves metadata about an object.</p>"
},
"GetObjectAttributes":{
"shape":"BatchGetObjectAttributesResponse",
"documentation":"<p>Retrieves attributes within a facet that are associated with an object.</p>"
},
"ListAttachedIndices":{
"shape":"BatchListAttachedIndicesResponse",
"documentation":"<p>Lists indices attached to an object.</p>"
},
"ListObjectParentPaths":{
"shape":"BatchListObjectParentPathsResponse",
"documentation":"<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
},
"ListObjectPolicies":{
"shape":"BatchListObjectPoliciesResponse",
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
},
"ListPolicyAttachments":{
"shape":"BatchListPolicyAttachmentsResponse",
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
},
"LookupPolicy":{
"shape":"BatchLookupPolicyResponse",
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"ListIndex":{
"shape":"BatchListIndexResponse",
"documentation":"<p>Lists objects attached to the specified index.</p>"
},
"ListOutgoingTypedLinks":{
"shape":"BatchListOutgoingTypedLinksResponse",
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"ListIncomingTypedLinks":{
"shape":"BatchListIncomingTypedLinksResponse",
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"GetLinkAttributes":{
"shape":"BatchGetLinkAttributesResponse",
"documentation":"<p>The list of attributes to retrieve from the typed link.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchRead</code> success response operation.</p>"
},
"BatchReferenceName":{"type":"string"},
"BatchRemoveFacetFromObject":{
"type":"structure",
"required":[
"SchemaFacet",
"ObjectReference"
],
"members":{
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>The facet to remove from the object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object whose facet will be removed.</p>"
}
},
"documentation":"<p>A batch operation to remove a facet from an object.</p>"
},
"BatchRemoveFacetFromObjectResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>An empty result that represents success.</p>"
},
"BatchUpdateLinkAttributes":{
"type":"structure",
"required":[
"TypedLinkSpecifier",
"AttributeUpdates"
],
"members":{
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeUpdates":{
"shape":"LinkAttributeUpdateList",
"documentation":"<p>The attributes update structure.</p>"
}
},
"documentation":"<p>Updates a given typed link’s attributes inside a <a>BatchRead</a> operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>. For more information, see <a>UpdateLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>"
},
"BatchUpdateLinkAttributesResponse":{
"type":"structure",
"members":{
},
"documentation":"<p>Represents the output of a <a>UpdateLinkAttributes</a> response operation.</p>"
},
"BatchUpdateObjectAttributes":{
"type":"structure",
"required":[
"ObjectReference",
"AttributeUpdates"
],
"members":{
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object.</p>"
},
"AttributeUpdates":{
"shape":"ObjectAttributeUpdateList",
"documentation":"<p>Attributes update structure.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchUpdate</code> operation. </p>"
},
"BatchUpdateObjectAttributesResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>ID that is associated with the object.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchUpdate</code> response operation.</p>"
},
"BatchWriteException":{
"type":"structure",
"members":{
"Index":{"shape":"BatchOperationIndex"},
"Type":{"shape":"BatchWriteExceptionType"},
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>A <code>BatchWrite</code> exception has occurred.</p>",
"exception":true
},
"BatchWriteExceptionType":{
"type":"string",
"enum":[
"InternalServiceException",
"ValidationException",
"InvalidArnException",
"LinkNameAlreadyInUseException",
"StillContainsLinksException",
"FacetValidationException",
"ObjectNotDetachedException",
"ResourceNotFoundException",
"AccessDeniedException",
"InvalidAttachmentException",
"NotIndexException",
"NotNodeException",
"IndexedAttributeMissingException",
"ObjectAlreadyDetachedException",
"NotPolicyException",
"DirectoryNotEnabledException",
"LimitExceededException",
"UnsupportedIndexTypeException"
]
},
"BatchWriteOperation":{
"type":"structure",
"members":{
"CreateObject":{
"shape":"BatchCreateObject",
"documentation":"<p>Creates an object.</p>"
},
"AttachObject":{
"shape":"BatchAttachObject",
"documentation":"<p>Attaches an object to a <a>Directory</a>.</p>"
},
"DetachObject":{
"shape":"BatchDetachObject",
"documentation":"<p>Detaches an object from a <a>Directory</a>.</p>"
},
"UpdateObjectAttributes":{
"shape":"BatchUpdateObjectAttributes",
"documentation":"<p>Updates a given object's attributes.</p>"
},
"DeleteObject":{
"shape":"BatchDeleteObject",
"documentation":"<p>Deletes an object in a <a>Directory</a>.</p>"
},
"AddFacetToObject":{
"shape":"BatchAddFacetToObject",
"documentation":"<p>A batch operation that adds a facet to an object.</p>"
},
"RemoveFacetFromObject":{
"shape":"BatchRemoveFacetFromObject",
"documentation":"<p>A batch operation that removes a facet from an object.</p>"
},
"AttachPolicy":{
"shape":"BatchAttachPolicy",
"documentation":"<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
},
"DetachPolicy":{
"shape":"BatchDetachPolicy",
"documentation":"<p>Detaches a policy from a <a>Directory</a>.</p>"
},
"CreateIndex":{
"shape":"BatchCreateIndex",
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
},
"AttachToIndex":{
"shape":"BatchAttachToIndex",
"documentation":"<p>Attaches the specified object to the specified index.</p>"
},
"DetachFromIndex":{
"shape":"BatchDetachFromIndex",
"documentation":"<p>Detaches the specified object from the specified index.</p>"
},
"AttachTypedLink":{
"shape":"BatchAttachTypedLink",
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DetachTypedLink":{
"shape":"BatchDetachTypedLink",
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"UpdateLinkAttributes":{
"shape":"BatchUpdateLinkAttributes",
"documentation":"<p>Updates a given object's attributes.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchWrite</code> operation. </p>"
},
"BatchWriteOperationList":{
"type":"list",
"member":{"shape":"BatchWriteOperation"}
},
"BatchWriteOperationResponse":{
"type":"structure",
"members":{
"CreateObject":{
"shape":"BatchCreateObjectResponse",
"documentation":"<p>Creates an object in a <a>Directory</a>.</p>"
},
"AttachObject":{
"shape":"BatchAttachObjectResponse",
"documentation":"<p>Attaches an object to a <a>Directory</a>.</p>"
},
"DetachObject":{
"shape":"BatchDetachObjectResponse",
"documentation":"<p>Detaches an object from a <a>Directory</a>.</p>"
},
"UpdateObjectAttributes":{
"shape":"BatchUpdateObjectAttributesResponse",
"documentation":"<p>Updates a given object’s attributes.</p>"
},
"DeleteObject":{
"shape":"BatchDeleteObjectResponse",
"documentation":"<p>Deletes an object in a <a>Directory</a>.</p>"
},
"AddFacetToObject":{
"shape":"BatchAddFacetToObjectResponse",
"documentation":"<p>The result of an add facet to object batch operation.</p>"
},
"RemoveFacetFromObject":{
"shape":"BatchRemoveFacetFromObjectResponse",
"documentation":"<p>The result of a batch remove facet from object operation.</p>"
},
"AttachPolicy":{
"shape":"BatchAttachPolicyResponse",
"documentation":"<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
},
"DetachPolicy":{
"shape":"BatchDetachPolicyResponse",
"documentation":"<p>Detaches a policy from a <a>Directory</a>.</p>"
},
"CreateIndex":{
"shape":"BatchCreateIndexResponse",
"documentation":"<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
},
"AttachToIndex":{
"shape":"BatchAttachToIndexResponse",
"documentation":"<p>Attaches the specified object to the specified index.</p>"
},
"DetachFromIndex":{
"shape":"BatchDetachFromIndexResponse",
"documentation":"<p>Detaches the specified object from the specified index.</p>"
},
"AttachTypedLink":{
"shape":"BatchAttachTypedLinkResponse",
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"DetachTypedLink":{
"shape":"BatchDetachTypedLinkResponse",
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
},
"UpdateLinkAttributes":{
"shape":"BatchUpdateLinkAttributesResponse",
"documentation":"<p>Represents the output of a <code>BatchWrite</code> response operation.</p>"
}
},
"documentation":"<p>Represents the output of a <code>BatchWrite</code> response operation.</p>"
},
"BatchWriteOperationResponseList":{
"type":"list",
"member":{"shape":"BatchWriteOperationResponse"}
},
"BatchWriteRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"Operations"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Operations":{
"shape":"BatchWriteOperationList",
"documentation":"<p>A list of operations that are part of the batch.</p>"
}
}
},
"BatchWriteResponse":{
"type":"structure",
"members":{
"Responses":{
"shape":"BatchWriteOperationResponseList",
"documentation":"<p>A list of all the responses for each batch write.</p>"
}
}
},
"BinaryAttributeValue":{"type":"blob"},
"Bool":{"type":"boolean"},
"BooleanAttributeValue":{"type":"boolean"},
"CannotListParentOfRootException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Cannot list the parents of a <a>Directory</a> root.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ConsistencyLevel":{
"type":"string",
"enum":[
"SERIALIZABLE",
"EVENTUAL"
]
},
"CreateDirectoryRequest":{
"type":"structure",
"required":[
"Name",
"SchemaArn"
],
"members":{
"Name":{
"shape":"DirectoryName",
"documentation":"<p>The name of the <a>Directory</a>. Should be unique per account, per region.</p>"
},
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"CreateDirectoryResponse":{
"type":"structure",
"required":[
"DirectoryArn",
"Name",
"ObjectIdentifier",
"AppliedSchemaArn"
],
"members":{
"DirectoryArn":{
"shape":"DirectoryArn",
"documentation":"<p>The ARN that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
},
"Name":{
"shape":"DirectoryName",
"documentation":"<p>The name of the <a>Directory</a>.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The root object node of the created directory.</p>"
},
"AppliedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the published schema in the <a>Directory</a>. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see <a>arns</a>.</p>"
}
}
},
"CreateFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the <a>Facet</a>, which is unique for a given schema.</p>"
},
"Attributes":{
"shape":"FacetAttributeList",
"documentation":"<p>The attributes that are associated with the <a>Facet</a>.</p>"
},
"ObjectType":{
"shape":"ObjectType",
"documentation":"<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>"
},
"FacetStyle":{
"shape":"FacetStyle",
"documentation":"<p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>"
}
}
},
"CreateFacetResponse":{
"type":"structure",
"members":{
}
},
"CreateIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"OrderedIndexedAttributeList",
"IsUnique"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory where the index should be created.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"OrderedIndexedAttributeList":{
"shape":"AttributeKeyList",
"documentation":"<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>"
},
"IsUnique":{
"shape":"Bool",
"documentation":"<p>Indicates whether the attribute that is being indexed has unique values or not.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the parent object that contains the index object.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of the link between the parent object and the index object.</p>"
}
}
},
"CreateIndexResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>"
}
}
},
"CreateObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SchemaFacets"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> in which the object will be created. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SchemaFacets":{
"shape":"SchemaFacetList",
"documentation":"<p>A list of schema facets to be associated with the object. Do not provide minor version components. See <a>SchemaFacet</a> for details.</p>"
},
"ObjectAttributeList":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attribute map whose attribute ARN contains the key and attribute value as the map value.</p>"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>If specified, the parent reference to which this object will be attached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The name of link that is used to attach this object to a parent.</p>"
}
}
},
"CreateObjectResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The identifier that is associated with the object.</p>"
}
}
},
"CreateSchemaRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"SchemaName",
"documentation":"<p>The name that is associated with the schema. This is unique to each account and in each region.</p>"
}
}
},
"CreateSchemaResponse":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
}
}
},
"CreateTypedLinkFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Facet"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Facet":{
"shape":"TypedLinkFacet",
"documentation":"<p> <a>Facet</a> structure that is associated with the typed link facet.</p>"
}
}
},
"CreateTypedLinkFacetResponse":{
"type":"structure",
"members":{
}
},
"Date":{"type":"timestamp"},
"DatetimeAttributeValue":{"type":"timestamp"},
"DeleteDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to delete.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"DeleteDirectoryResponse":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the deleted directory.</p>"
}
}
},
"DeleteFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet to delete.</p>"
}
}
},
"DeleteFacetResponse":{
"type":"structure",
"members":{
}
},
"DeleteObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference that identifies the object.</p>"
}
}
},
"DeleteObjectResponse":{
"type":"structure",
"members":{
}
},
"DeleteSchemaRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"DeleteSchemaResponse":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The input ARN that is returned as part of the response. For more information, see <a>arns</a>.</p>"
}
}
},
"DeleteTypedLinkFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
}
}
},
"DeleteTypedLinkFacetResponse":{
"type":"structure",
"members":{
}
},
"DetachFromIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"IndexReference",
"TargetReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory the index and object exist in.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the index object.</p>"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object being detached from the index.</p>"
}
}
},
"DetachFromIndexResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>"
}
}
},
"DetachObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ParentReference",
"LinkName"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ParentReference":{
"shape":"ObjectReference",
"documentation":"<p>The parent reference from which the object with the specified link name is detached.</p>"
},
"LinkName":{
"shape":"LinkName",
"documentation":"<p>The link name associated with the object that needs to be detached.</p>"
}
}
},
"DetachObjectResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> that was detached from the object.</p>"
}
}
},
"DetachPolicyRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"PolicyReference",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the policy object.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policy object will be detached.</p>"
}
}
},
"DetachPolicyResponse":{
"type":"structure",
"members":{
}
},
"DetachTypedLinkRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TypedLinkSpecifier"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Used to accept a typed link specifier as input.</p>"
}
}
},
"Directory":{
"type":"structure",
"members":{
"Name":{
"shape":"DirectoryName",
"documentation":"<p>The name of the directory.</p>"
},
"DirectoryArn":{
"shape":"DirectoryArn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the directory. For more information, see <a>arns</a>.</p>"
},
"State":{
"shape":"DirectoryState",
"documentation":"<p>The state of the directory. Can be either <code>Enabled</code>, <code>Disabled</code>, or <code>Deleted</code>.</p>"
},
"CreationDateTime":{
"shape":"Date",
"documentation":"<p>The date and time when the directory was created.</p>"
}
},
"documentation":"<p>Directory structure that includes the directory name and directory ARN.</p>"
},
"DirectoryAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a <a>Directory</a> could not be created due to a naming conflict. Choose a different name and try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryArn":{"type":"string"},
"DirectoryDeletedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryList":{
"type":"list",
"member":{"shape":"Directory"}
},
"DirectoryName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"DirectoryNotDisabledException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An operation can only operate on a disabled directory.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryNotEnabledException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Operations are only permitted on enabled directories.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"DirectoryState":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED",
"DELETED"
]
},
"DisableDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to disable.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"DisableDirectoryResponse":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory that has been disabled.</p>"
}
}
},
"EnableDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to enable.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"EnableDirectoryResponse":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the enabled directory.</p>"
}
}
},
"ExceptionMessage":{"type":"string"},
"Facet":{
"type":"structure",
"members":{
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the <a>Facet</a>.</p>"
},
"ObjectType":{
"shape":"ObjectType",
"documentation":"<p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
},
"FacetStyle":{
"shape":"FacetStyle",
"documentation":"<p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>"
}
},
"documentation":"<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <code> <a>Rule</a>s</code>, and <code>ObjectTypes</code>. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/whatarefacets.html\">Facets</a> for more information.</p>"
},
"FacetAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>A facet with the same name already exists.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetAttribute":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"AttributeName",
"documentation":"<p>The name of the facet attribute.</p>"
},
"AttributeDefinition":{
"shape":"FacetAttributeDefinition",
"documentation":"<p>A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"AttributeReference":{
"shape":"FacetAttributeReference",
"documentation":"<p>An attribute reference that is associated with the attribute. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"RequiredBehavior":{
"shape":"RequiredAttributeBehavior",
"documentation":"<p>The required behavior of the <code>FacetAttribute</code>.</p>"
}
},
"documentation":"<p>An attribute that is associated with the <a>Facet</a>.</p>"
},
"FacetAttributeDefinition":{
"type":"structure",
"required":["Type"],
"members":{
"Type":{
"shape":"FacetAttributeType",
"documentation":"<p>The type of the attribute.</p>"
},
"DefaultValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The default value of the attribute (if configured).</p>"
},
"IsImmutable":{
"shape":"Bool",
"documentation":"<p>Whether the attribute is mutable or not.</p>"
},
"Rules":{
"shape":"RuleMap",
"documentation":"<p>Validation rules attached to the attribute definition.</p>"
}
},
"documentation":"<p>A facet attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"FacetAttributeList":{
"type":"list",
"member":{"shape":"FacetAttribute"}
},
"FacetAttributeReference":{
"type":"structure",
"required":[
"TargetFacetName",
"TargetAttributeName"
],
"members":{
"TargetFacetName":{
"shape":"FacetName",
"documentation":"<p>The target facet name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
},
"TargetAttributeName":{
"shape":"AttributeName",
"documentation":"<p>The target attribute name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
}
},
"documentation":"<p>The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.</p>"
},
"FacetAttributeType":{
"type":"string",
"enum":[
"STRING",
"BINARY",
"BOOLEAN",
"NUMBER",
"DATETIME",
"VARIANT"
]
},
"FacetAttributeUpdate":{
"type":"structure",
"members":{
"Attribute":{
"shape":"FacetAttribute",
"documentation":"<p>The attribute to update.</p>"
},
"Action":{
"shape":"UpdateActionType",
"documentation":"<p>The action to perform when updating the attribute.</p>"
}
},
"documentation":"<p>A structure that contains information used to update an attribute.</p>"
},
"FacetAttributeUpdateList":{
"type":"list",
"member":{"shape":"FacetAttributeUpdate"}
},
"FacetInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"FacetNameList":{
"type":"list",
"member":{"shape":"FacetName"}
},
"FacetNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified <a>Facet</a> could not be found.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FacetStyle":{
"type":"string",
"enum":[
"STATIC",
"DYNAMIC"
]
},
"FacetValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The <a>Facet</a> that you provided was not well formed or could not be validated with the schema.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"GetAppliedSchemaVersionRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the applied schema.</p>"
}
}
},
"GetAppliedSchemaVersionResponse":{
"type":"structure",
"members":{
"AppliedSchemaArn":{
"shape":"Arn",
"documentation":"<p>Current applied schema ARN, including the minor version in use if one was provided.</p>"
}
}
},
"GetDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"DirectoryArn",
"documentation":"<p>The ARN of the directory.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"GetDirectoryResponse":{
"type":"structure",
"required":["Directory"],
"members":{
"Directory":{
"shape":"Directory",
"documentation":"<p>Metadata about the directory.</p>"
}
}
},
"GetFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet to retrieve.</p>"
}
}
},
"GetFacetResponse":{
"type":"structure",
"members":{
"Facet":{
"shape":"Facet",
"documentation":"<p>The <a>Facet</a> structure that is associated with the facet.</p>"
}
}
},
"GetLinkAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TypedLinkSpecifier",
"AttributeNames"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see <a>arns</a> or <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>A list of attribute names whose values will be retrieved.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level at which to retrieve the attributes on a typed link.</p>"
}
}
},
"GetLinkAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the typed link.</p>"
}
}
},
"GetObjectAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference",
"SchemaFacet",
"AttributeNames"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose attributes will be retrieved.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level at which to retrieve the attributes on an object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>"
},
"AttributeNames":{
"shape":"AttributeNameList",
"documentation":"<p>List of attribute names whose values will be retrieved.</p>"
}
}
},
"GetObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The attributes that are associated with the object.</p>"
}
}
},
"GetObjectInformationRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory being retrieved.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level at which to retrieve the object information.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"GetObjectInformationResponse":{
"type":"structure",
"members":{
"SchemaFacets":{
"shape":"SchemaFacetList",
"documentation":"<p>The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See <a>GetAppliedSchemaVersion</a> for details.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the specified object.</p>"
}
}
},
"GetSchemaAsJsonRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema to retrieve.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
}
}
},
"GetSchemaAsJsonResponse":{
"type":"structure",
"members":{
"Name":{
"shape":"SchemaName",
"documentation":"<p>The name of the retrieved schema.</p>"
},
"Document":{
"shape":"SchemaJsonDocument",
"documentation":"<p>The JSON representation of the schema document.</p>"
}
}
},
"GetTypedLinkFacetInformationRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
}
}
},
"GetTypedLinkFacetInformationResponse":{
"type":"structure",
"members":{
"IdentityAttributeOrder":{
"shape":"AttributeNameList",
"documentation":"<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
}
},
"IncompatibleSchemaException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"IndexAttachment":{
"type":"structure",
"members":{
"IndexedAttributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>The indexed attribute values.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>In response to <a>ListIndex</a>, the <code>ObjectIdentifier</code> of the object attached to the index. In response to <a>ListAttachedIndices</a>, the <code>ObjectIdentifier</code> of the index attached to the object. This field will always contain the <code>ObjectIdentifier</code> of the object on the opposite side of the attachment specified in the query.</p>"
}
},
"documentation":"<p>Represents an index and an attached object.</p>"
},
"IndexAttachmentList":{
"type":"list",
"member":{"shape":"IndexAttachment"}
},
"IndexedAttributeMissingException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An object has been attempted to be attached to an object that does not have the appropriate attribute value.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href=\"http://status.aws.amazon.com/\">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidArnException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the provided ARN value is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidAttachmentException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidFacetUpdateException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An attempt to modify a <a>Facet</a> resulted in an invalid schema exception.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the <code>NextToken</code> value is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidRuleException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when any of the rule parameter keys or values are invalid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidSchemaDocException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the provided <code>SchemaDoc</code> value is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidTaggingRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that limits are exceeded. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html\">Limits</a> for more information.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LinkAttributeAction":{
"type":"structure",
"members":{
"AttributeActionType":{
"shape":"UpdateActionType",
"documentation":"<p>A type that can be either <code>UPDATE_OR_CREATE</code> or <code>DELETE</code>.</p>"
},
"AttributeUpdateValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value that you want to update to.</p>"
}
},
"documentation":"<p>The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.</p>"
},
"LinkAttributeUpdate":{
"type":"structure",
"members":{
"AttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute being updated.</p>"
},
"AttributeAction":{
"shape":"LinkAttributeAction",
"documentation":"<p>The action to perform as part of the attribute update.</p>"
}
},
"documentation":"<p>Structure that contains attribute update information.</p>"
},
"LinkAttributeUpdateList":{
"type":"list",
"member":{"shape":"LinkAttributeUpdate"}
},
"LinkName":{
"type":"string",
"max":64,
"min":1,
"pattern":"[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+"
},
"LinkNameAlreadyInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LinkNameToObjectIdentifierMap":{
"type":"map",
"key":{"shape":"LinkName"},
"value":{"shape":"ObjectIdentifier"}
},
"ListAppliedSchemaArnsRequest":{
"type":"structure",
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory you are listing.</p>"
},
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The response for <code>ListAppliedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListAppliedSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs of schemas that are applied to the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListAttachedIndicesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TargetReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TargetReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object that has indices attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to use for this operation.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListAttachedIndicesResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The indices attached to the specified object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListDevelopmentSchemaArnsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListDevelopmentSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs of retrieved development schemas.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListDirectoriesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"state":{
"shape":"DirectoryState",
"documentation":"<p>The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.</p>"
}
}
},
"ListDirectoriesResponse":{
"type":"structure",
"required":["Directories"],
"members":{
"Directories":{
"shape":"DirectoryList",
"documentation":"<p>Lists all directories that are associated with your account in pagination fashion.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListFacetAttributesRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema where the facet resides.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet whose attributes will be retrieved.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListFacetAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"FacetAttributeList",
"documentation":"<p>The attributes attached to the facet.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListFacetNamesRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) to retrieve facet names from.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListFacetNamesResponse":{
"type":"structure",
"members":{
"FacetNames":{
"shape":"FacetNameList",
"documentation":"<p>The names of facets that exist within the schema.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListIncomingTypedLinksRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to execute the request at.</p>"
}
}
},
"ListIncomingTypedLinksResponse":{
"type":"structure",
"members":{
"LinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns one or more typed link specifiers as output.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListIndexRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"IndexReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory that the index exists in.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"RangesOnIndexedValues":{
"shape":"ObjectAttributeRangeList",
"documentation":"<p>Specifies the ranges of indexed values that you want to query.</p>"
},
"IndexReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference to the index to list.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html#limits_cd\">AWS Directory Service Limits</a>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to execute the request at.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListIndexResponse":{
"type":"structure",
"members":{
"IndexAttachments":{
"shape":"IndexAttachmentList",
"documentation":"<p>The objects and indexed values attached to the index.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListManagedSchemaArnsRequest":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListManagedSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs for all AWS managed schemas.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListObjectAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
},
"FacetFilter":{
"shape":"SchemaFacet",
"documentation":"<p>Used to filter the list of object attributes that are associated with a certain facet.</p>"
}
}
},
"ListObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"AttributeKeyAndValueList",
"documentation":"<p>Attributes map that is associated with the object. <code>AttributeArn</code> is the key, and attribute value is the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListObjectChildrenRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object for which child objects are being listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectChildrenResponse":{
"type":"structure",
"members":{
"Children":{
"shape":"LinkNameToObjectIdentifierMap",
"documentation":"<p>Children structure, which is a map with key as the <code>LinkName</code> and <code>ObjectIdentifier</code> as the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListObjectParentPathsRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory to which the parent path applies.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object whose parent paths are listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
}
}
},
"ListObjectParentPathsResponse":{
"type":"structure",
"members":{
"PathToObjectIdentifiersList":{
"shape":"PathToObjectIdentifiersList",
"documentation":"<p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListObjectParentsRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object for which parent objects are being listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectParentsResponse":{
"type":"structure",
"members":{
"Parents":{
"shape":"ObjectIdentifierToLinkNameMap",
"documentation":"<p>The parent structure, which is a map with key as the <code>ObjectIdentifier</code> and LinkName as the value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListObjectPoliciesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object for which policies will be listed.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListObjectPoliciesResponse":{
"type":"structure",
"members":{
"AttachedPolicyIds":{
"shape":"ObjectIdentifierList",
"documentation":"<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListOutgoingTypedLinksRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference that identifies the object whose attributes will be listed.</p>"
},
"FilterAttributeRanges":{
"shape":"TypedLinkAttributeRangeList",
"documentation":"<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
},
"FilterTypedLink":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>The consistency level to execute the request at.</p>"
}
}
},
"ListOutgoingTypedLinksResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifiers":{
"shape":"TypedLinkSpecifierList",
"documentation":"<p>Returns a typed link specifier as output.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListPolicyAttachmentsRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"PolicyReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"PolicyReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the policy object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"location":"header",
"locationName":"x-amz-consistency-level"
}
}
},
"ListPolicyAttachmentsResponse":{
"type":"structure",
"members":{
"ObjectIdentifiers":{
"shape":"ObjectIdentifierList",
"documentation":"<p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListPublishedSchemaArnsRequest":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The response for <code>ListPublishedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListPublishedSchemaArnsResponse":{
"type":"structure",
"members":{
"SchemaArns":{
"shape":"Arns",
"documentation":"<p>The ARNs of published schemas.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token. This is for future use. Currently pagination is not supported for tagging.</p>"
},
"MaxResults":{
"shape":"TagsNumberResults",
"documentation":"<p>The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag key value pairs that are associated with the response.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>"
}
}
},
"ListTypedLinkFacetAttributesRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListTypedLinkFacetAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{
"shape":"TypedLinkAttributeDefinitionList",
"documentation":"<p>An ordered set of attributes associate with the typed link.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"ListTypedLinkFacetNamesRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of results to retrieve.</p>"
}
}
},
"ListTypedLinkFacetNamesResponse":{
"type":"structure",
"members":{
"FacetNames":{
"shape":"TypedLinkNameList",
"documentation":"<p>The names of typed link facets that exist within the schema.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"LookupPolicyRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Reference that identifies the object whose policies will be looked up.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to request the next page of results.</p>"
},
"MaxResults":{
"shape":"NumberResults",
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
}
}
},
"LookupPolicyResponse":{
"type":"structure",
"members":{
"PolicyToPathList":{
"shape":"PolicyToPathList",
"documentation":"<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token.</p>"
}
}
},
"NextToken":{"type":"string"},
"NotIndexException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the requested operation can only operate on index objects.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NotNodeException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when any invalid operations are performed on an object that is not a node, such as calling <code>ListObjectChildren</code> for a leaf node object.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NotPolicyException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the requested operation can only operate on policy objects.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NumberAttributeValue":{"type":"string"},
"NumberResults":{
"type":"integer",
"min":1
},
"ObjectAlreadyDetachedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the object is not attached to the index.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ObjectAttributeAction":{
"type":"structure",
"members":{
"ObjectAttributeActionType":{
"shape":"UpdateActionType",
"documentation":"<p>A type that can be either <code>Update</code> or <code>Delete</code>.</p>"
},
"ObjectAttributeUpdateValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value that you want to update to.</p>"
}
},
"documentation":"<p>The action to take on the object attribute.</p>"
},
"ObjectAttributeRange":{
"type":"structure",
"members":{
"AttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute that the attribute range covers.</p>"
},
"Range":{
"shape":"TypedAttributeValueRange",
"documentation":"<p>The range of attribute values being selected.</p>"
}
},
"documentation":"<p>A range of attributes.</p>"
},
"ObjectAttributeRangeList":{
"type":"list",
"member":{"shape":"ObjectAttributeRange"}
},
"ObjectAttributeUpdate":{
"type":"structure",
"members":{
"ObjectAttributeKey":{
"shape":"AttributeKey",
"documentation":"<p>The key of the attribute being updated.</p>"
},
"ObjectAttributeAction":{
"shape":"ObjectAttributeAction",
"documentation":"<p>The action to perform as part of the attribute update.</p>"
}
},
"documentation":"<p>Structure that contains attribute update information.</p>"
},
"ObjectAttributeUpdateList":{
"type":"list",
"member":{"shape":"ObjectAttributeUpdate"}
},
"ObjectIdentifier":{"type":"string"},
"ObjectIdentifierList":{
"type":"list",
"member":{"shape":"ObjectIdentifier"}
},
"ObjectIdentifierToLinkNameMap":{
"type":"map",
"key":{"shape":"ObjectIdentifier"},
"value":{"shape":"LinkName"}
},
"ObjectNotDetachedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the requested operation cannot be completed because the object has not been detached from the tree.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ObjectReference":{
"type":"structure",
"members":{
"Selector":{
"shape":"SelectorObjectReference",
"documentation":"<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#accessingobjects\">Accessing Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
}
},
"documentation":"<p>The reference that identifies an object.</p>"
},
"ObjectType":{
"type":"string",
"enum":[
"NODE",
"LEAF_NODE",
"POLICY",
"INDEX"
]
},
"PathString":{"type":"string"},
"PathToObjectIdentifiers":{
"type":"structure",
"members":{
"Path":{
"shape":"PathString",
"documentation":"<p>The path that is used to identify the object starting from directory root.</p>"
},
"ObjectIdentifiers":{
"shape":"ObjectIdentifierList",
"documentation":"<p>Lists <code>ObjectIdentifiers</code> starting from directory root to the object in the request.</p>"
}
},
"documentation":"<p>Returns the path to the <code>ObjectIdentifiers</code> that is associated with the directory.</p>"
},
"PathToObjectIdentifiersList":{
"type":"list",
"member":{"shape":"PathToObjectIdentifiers"}
},
"PolicyAttachment":{
"type":"structure",
"members":{
"PolicyId":{
"shape":"ObjectIdentifier",
"documentation":"<p>The ID of <code>PolicyAttachment</code>.</p>"
},
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> that is associated with <code>PolicyAttachment</code>.</p>"
},
"PolicyType":{
"shape":"PolicyType",
"documentation":"<p>The type of policy that can be associated with <code>PolicyAttachment</code>.</p>"
}
},
"documentation":"<p>Contains the <code>PolicyType</code>, <code>PolicyId</code>, and the <code>ObjectIdentifier</code> to which it is attached. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
},
"PolicyAttachmentList":{
"type":"list",
"member":{"shape":"PolicyAttachment"}
},
"PolicyToPath":{
"type":"structure",
"members":{
"Path":{
"shape":"PathString",
"documentation":"<p>The path that is referenced from the root.</p>"
},
"Policies":{
"shape":"PolicyAttachmentList",
"documentation":"<p>List of policy objects.</p>"
}
},
"documentation":"<p>Used when a regular object exists in a <a>Directory</a> and you want to find all of the policies that are associated with that object and the parent to that object.</p>"
},
"PolicyToPathList":{
"type":"list",
"member":{"shape":"PolicyToPath"}
},
"PolicyType":{"type":"string"},
"PublishSchemaRequest":{
"type":"structure",
"required":[
"DevelopmentSchemaArn",
"Version"
],
"members":{
"DevelopmentSchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Version":{
"shape":"Version",
"documentation":"<p>The major version under which the schema will be published. Schemas have both a major and minor version associated with them.</p>"
},
"MinorVersion":{
"shape":"Version",
"documentation":"<p>The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.</p>"
},
"Name":{
"shape":"SchemaName",
"documentation":"<p>The new name under which the schema will be published. If this is not provided, the development schema is considered.</p>"
}
}
},
"PublishSchemaResponse":{
"type":"structure",
"members":{
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN that is associated with the published schema. For more information, see <a>arns</a>.</p>"
}
}
},
"PutSchemaFromJsonRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Document"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema to update.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Document":{
"shape":"SchemaJsonDocument",
"documentation":"<p>The replacement JSON schema.</p>"
}
}
},
"PutSchemaFromJsonResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema to update.</p>"
}
}
},
"RangeMode":{
"type":"string",
"enum":[
"FIRST",
"LAST",
"LAST_BEFORE_MISSING_VALUES",
"INCLUSIVE",
"EXCLUSIVE"
]
},
"RemoveFacetFromObjectRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"SchemaFacet",
"ObjectReference"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory in which the object resides.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"SchemaFacet":{
"shape":"SchemaFacet",
"documentation":"<p>The facet to remove. See <a>SchemaFacet</a> for details.</p>"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>A reference to the object to remove the facet from.</p>"
}
}
},
"RemoveFacetFromObjectResponse":{
"type":"structure",
"members":{
}
},
"RequiredAttributeBehavior":{
"type":"string",
"enum":[
"REQUIRED_ALWAYS",
"NOT_REQUIRED"
]
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified resource could not be found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"RetryableConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"Rule":{
"type":"structure",
"members":{
"Type":{
"shape":"RuleType",
"documentation":"<p>The type of attribute validation rule.</p>"
},
"Parameters":{
"shape":"RuleParameterMap",
"documentation":"<p>The minimum and maximum parameters that are associated with the rule.</p>"
}
},
"documentation":"<p>Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.</p>"
},
"RuleKey":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"RuleMap":{
"type":"map",
"key":{"shape":"RuleKey"},
"value":{"shape":"Rule"}
},
"RuleParameterKey":{"type":"string"},
"RuleParameterMap":{
"type":"map",
"key":{"shape":"RuleParameterKey"},
"value":{"shape":"RuleParameterValue"}
},
"RuleParameterValue":{"type":"string"},
"RuleType":{
"type":"string",
"enum":[
"BINARY_LENGTH",
"NUMBER_COMPARISON",
"STRING_FROM_SET",
"STRING_LENGTH"
]
},
"SchemaAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"SchemaAlreadyPublishedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that a schema is already published.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"SchemaFacet":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>"
},
"FacetName":{
"shape":"FacetName",
"documentation":"<p>The name of the facet.</p>"
}
},
"documentation":"<p>A facet.</p>"
},
"SchemaFacetList":{
"type":"list",
"member":{"shape":"SchemaFacet"}
},
"SchemaJsonDocument":{"type":"string"},
"SchemaName":{
"type":"string",
"max":32,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"SelectorObjectReference":{"type":"string"},
"StillContainsLinksException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The object could not be deleted because links still exist. Remove the links and then try the operation again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"StringAttributeValue":{"type":"string"},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>The key that is associated with the tag.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The value that is associated with the tag.</p>"
}
},
"documentation":"<p>The tag structure that contains a tag key and value.</p>"
},
"TagKey":{"type":"string"},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag key-value pairs.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{"type":"string"},
"TagsNumberResults":{
"type":"integer",
"min":50
},
"TypedAttributeValue":{
"type":"structure",
"members":{
"StringValue":{
"shape":"StringAttributeValue",
"documentation":"<p>A string data value.</p>"
},
"BinaryValue":{
"shape":"BinaryAttributeValue",
"documentation":"<p>A binary data value.</p>"
},
"BooleanValue":{
"shape":"BooleanAttributeValue",
"documentation":"<p>A Boolean data value.</p>"
},
"NumberValue":{
"shape":"NumberAttributeValue",
"documentation":"<p>A number data value.</p>"
},
"DatetimeValue":{
"shape":"DatetimeAttributeValue",
"documentation":"<p>A date and time value.</p>"
}
},
"documentation":"<p>Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.</p>"
},
"TypedAttributeValueRange":{
"type":"structure",
"required":[
"StartMode",
"EndMode"
],
"members":{
"StartMode":{
"shape":"RangeMode",
"documentation":"<p>The inclusive or exclusive range start.</p>"
},
"StartValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The value to start the range at.</p>"
},
"EndMode":{
"shape":"RangeMode",
"documentation":"<p>The inclusive or exclusive range end.</p>"
},
"EndValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The attribute value to terminate the range at.</p>"
}
},
"documentation":"<p>A range of attribute values. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#rangefilters\">Range Filters</a>.</p>"
},
"TypedLinkAttributeDefinition":{
"type":"structure",
"required":[
"Name",
"Type",
"RequiredBehavior"
],
"members":{
"Name":{
"shape":"AttributeName",
"documentation":"<p>The unique name of the typed link attribute.</p>"
},
"Type":{
"shape":"FacetAttributeType",
"documentation":"<p>The type of the attribute.</p>"
},
"DefaultValue":{
"shape":"TypedAttributeValue",
"documentation":"<p>The default value of the attribute (if configured).</p>"
},
"IsImmutable":{
"shape":"Bool",
"documentation":"<p>Whether the attribute is mutable or not.</p>"
},
"Rules":{
"shape":"RuleMap",
"documentation":"<p>Validation rules that are attached to the attribute definition.</p>"
},
"RequiredBehavior":{
"shape":"RequiredAttributeBehavior",
"documentation":"<p>The required behavior of the <code>TypedLinkAttributeDefinition</code>.</p>"
}
},
"documentation":"<p>A typed link attribute definition.</p>"
},
"TypedLinkAttributeDefinitionList":{
"type":"list",
"member":{"shape":"TypedLinkAttributeDefinition"}
},
"TypedLinkAttributeRange":{
"type":"structure",
"required":["Range"],
"members":{
"AttributeName":{
"shape":"AttributeName",
"documentation":"<p>The unique name of the typed link attribute.</p>"
},
"Range":{
"shape":"TypedAttributeValueRange",
"documentation":"<p>The range of attribute values that are being selected.</p>"
}
},
"documentation":"<p>Identifies the range of attributes that are used by a specified filter.</p>"
},
"TypedLinkAttributeRangeList":{
"type":"list",
"member":{"shape":"TypedLinkAttributeRange"}
},
"TypedLinkFacet":{
"type":"structure",
"required":[
"Name",
"Attributes",
"IdentityAttributeOrder"
],
"members":{
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
},
"Attributes":{
"shape":"TypedLinkAttributeDefinitionList",
"documentation":"<p>A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.</p>"
},
"IdentityAttributeOrder":{
"shape":"AttributeNameList",
"documentation":"<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>"
}
},
"documentation":"<p>Defines the typed links structure and its attributes. To create a typed link facet, use the <a>CreateTypedLinkFacet</a> API.</p>"
},
"TypedLinkFacetAttributeUpdate":{
"type":"structure",
"required":[
"Attribute",
"Action"
],
"members":{
"Attribute":{
"shape":"TypedLinkAttributeDefinition",
"documentation":"<p>The attribute to update.</p>"
},
"Action":{
"shape":"UpdateActionType",
"documentation":"<p>The action to perform when updating the attribute.</p>"
}
},
"documentation":"<p>A typed link facet attribute update.</p>"
},
"TypedLinkFacetAttributeUpdateList":{
"type":"list",
"member":{"shape":"TypedLinkFacetAttributeUpdate"}
},
"TypedLinkName":{
"type":"string",
"pattern":"^[a-zA-Z0-9._-]*$"
},
"TypedLinkNameList":{
"type":"list",
"member":{"shape":"TypedLinkName"}
},
"TypedLinkSchemaAndFacetName":{
"type":"structure",
"required":[
"SchemaArn",
"TypedLinkName"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
},
"TypedLinkName":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
}
},
"documentation":"<p>Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.</p>"
},
"TypedLinkSpecifier":{
"type":"structure",
"required":[
"TypedLinkFacet",
"SourceObjectReference",
"TargetObjectReference",
"IdentityAttributeValues"
],
"members":{
"TypedLinkFacet":{
"shape":"TypedLinkSchemaAndFacetName",
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
},
"SourceObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
},
"TargetObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
},
"IdentityAttributeValues":{
"shape":"AttributeNameAndValueList",
"documentation":"<p>Identifies the attribute value to update.</p>"
}
},
"documentation":"<p>Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The <a>AttachTypedLink</a> API returns a typed link specifier while the <a>DetachTypedLink</a> API accepts one as input. Similarly, the <a>ListIncomingTypedLinks</a> and <a>ListOutgoingTypedLinks</a> API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.</p>"
},
"TypedLinkSpecifierList":{
"type":"list",
"member":{"shape":"TypedLinkSpecifier"}
},
"UnsupportedIndexTypeException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that the requested index type is not supported.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>Keys of the tag that need to be removed from the resource.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateActionType":{
"type":"string",
"enum":[
"CREATE_OR_UPDATE",
"DELETE"
]
},
"UpdateFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"FacetName",
"documentation":"<p>The name of the facet.</p>"
},
"AttributeUpdates":{
"shape":"FacetAttributeUpdateList",
"documentation":"<p>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by <code>AttributeAction</code>, which specifies the type of update operation to perform. </p>"
},
"ObjectType":{
"shape":"ObjectType",
"documentation":"<p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
}
}
},
"UpdateFacetResponse":{
"type":"structure",
"members":{
}
},
"UpdateLinkAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"TypedLinkSpecifier",
"AttributeUpdates"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see <a>arns</a> or <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"TypedLinkSpecifier":{
"shape":"TypedLinkSpecifier",
"documentation":"<p>Allows a typed link specifier to be accepted as input.</p>"
},
"AttributeUpdates":{
"shape":"LinkAttributeUpdateList",
"documentation":"<p>The attributes update structure.</p>"
}
}
},
"UpdateLinkAttributesResponse":{
"type":"structure",
"members":{
}
},
"UpdateObjectAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference",
"AttributeUpdates"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{
"shape":"ObjectReference",
"documentation":"<p>The reference that identifies the object.</p>"
},
"AttributeUpdates":{
"shape":"ObjectAttributeUpdateList",
"documentation":"<p>The attributes update structure.</p>"
}
}
},
"UpdateObjectAttributesResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{
"shape":"ObjectIdentifier",
"documentation":"<p>The <code>ObjectIdentifier</code> of the updated object.</p>"
}
}
},
"UpdateSchemaRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"SchemaName",
"documentation":"<p>The name of the schema.</p>"
}
}
},
"UpdateSchemaResponse":{
"type":"structure",
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN that is associated with the updated schema. For more information, see <a>arns</a>.</p>"
}
}
},
"UpdateTypedLinkFacetRequest":{
"type":"structure",
"required":[
"SchemaArn",
"Name",
"AttributeUpdates",
"IdentityAttributeOrder"
],
"members":{
"SchemaArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"location":"header",
"locationName":"x-amz-data-partition"
},
"Name":{
"shape":"TypedLinkName",
"documentation":"<p>The unique name of the typed link facet.</p>"
},
"AttributeUpdates":{
"shape":"TypedLinkFacetAttributeUpdateList",
"documentation":"<p>Attributes update structure.</p>"
},
"IdentityAttributeOrder":{
"shape":"AttributeNameList",
"documentation":"<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
}
},
"UpdateTypedLinkFacetResponse":{
"type":"structure",
"members":{
}
},
"UpgradeAppliedSchemaRequest":{
"type":"structure",
"required":[
"PublishedSchemaArn",
"DirectoryArn"
],
"members":{
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The revision of the published schema to upgrade the directory to.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the directory to which the upgraded schema will be applied.</p>"
},
"DryRun":{
"shape":"Bool",
"documentation":"<p>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</p>"
}
}
},
"UpgradeAppliedSchemaResponse":{
"type":"structure",
"members":{
"UpgradedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the upgraded schema that is returned as part of the response.</p>"
},
"DirectoryArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the directory that is returned as part of the response.</p>"
}
}
},
"UpgradePublishedSchemaRequest":{
"type":"structure",
"required":[
"DevelopmentSchemaArn",
"PublishedSchemaArn",
"MinorVersion"
],
"members":{
"DevelopmentSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the development schema with the changes used for the upgrade.</p>"
},
"PublishedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the published schema to be upgraded.</p>"
},
"MinorVersion":{
"shape":"Version",
"documentation":"<p>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</p>"
},
"DryRun":{
"shape":"Bool",
"documentation":"<p>Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.</p>"
}
}
},
"UpgradePublishedSchemaResponse":{
"type":"structure",
"members":{
"UpgradedSchemaArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the upgraded schema that is returned as part of the response.</p>"
}
}
},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Indicates that your request is malformed in some manner. See the exception message.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"Version":{
"type":"string",
"max":10,
"min":1,
"pattern":"^[a-zA-Z0-9._-]*$"
}
},
"documentation":"<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>"
}

41
botocore/data/cloudformation/2010-05-15/service-2.json
View file

@ -605,9 +605,10 @@
{"shape":"OperationInProgressException"},
{"shape":"OperationIdAlreadyExistsException"},
{"shape":"StaleRequestException"},
{"shape":"InvalidOperationException"}
{"shape":"InvalidOperationException"},
{"shape":"StackInstanceNotFoundException"}
],
"documentation":"<p>Updates the stack set and <i>all</i> associated stack instances.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>"
"documentation":"<p>Updates the stack set, and associated stack instances in the specified accounts and regions.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>"
},
"UpdateTerminationProtection":{
"name":"UpdateTerminationProtection",
@ -1152,7 +1153,11 @@
},
"AdministrationRoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. </p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>"
"documentation":"<p>The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. </p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites: Granting Permissions for Stack Set Operations</a> in the <i>AWS CloudFormation User Guide</i>.</p>"
},
"ExecutionRoleName":{
"shape":"ExecutionRoleName",
"documentation":"<p>The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. </p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
@ -1657,6 +1662,12 @@
},
"documentation":"<p>The output for the <a>ExecuteChangeSet</a> action.</p>"
},
"ExecutionRoleName":{
"type":"string",
"max":64,
"min":1,
"pattern":"[a-zA-Z_0-9+=,.@-]+"
},
"ExecutionStatus":{
"type":"string",
"enum":[
@ -3045,7 +3056,11 @@
},
"AdministrationRoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>"
"documentation":"<p>The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites: Granting Permissions for Stack Set Operations</a> in the <i>AWS CloudFormation User Guide</i>.</p>"
},
"ExecutionRoleName":{
"shape":"ExecutionRoleName",
"documentation":"<p>The name of the IAM execution role used to create or update the stack set. </p> <p>Use customized execution roles to control which stack resources users and groups can include in their stack sets. </p>"
}
},
"documentation":"<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. </p>"
@ -3112,6 +3127,10 @@
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. </p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>"
},
"ExecutionRoleName":{
"shape":"ExecutionRoleName",
"documentation":"<p>The name of the IAM execution role used to create or update the stack set.</p> <p>Use customized execution roles to control which stack resources users and groups can include in their stack sets. </p>"
},
"CreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.</p>"
@ -3573,7 +3592,7 @@
],
"members":{
"StackSetName":{
"shape":"StackSetName",
"shape":"StackSetNameOrId",
"documentation":"<p>The name or unique ID of the stack set associated with the stack instances.</p>"
},
"Accounts":{
@ -3662,10 +3681,22 @@
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> If you specify a customized administrator role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized administrator role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
},
"ExecutionRoleName":{
"shape":"ExecutionRoleName",
"documentation":"<p>The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. </p> <p> If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
},
"OperationId":{
"shape":"ClientRequestToken",
"documentation":"<p>The unique ID for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, AWS CloudFormation generates one automatically.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"idempotencyToken":true
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
},
"Regions":{
"shape":"RegionList",
"documentation":"<p>The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
}
}
},

34
botocore/data/cloudfront/2017-10-30/service-2.json
View file

@ -357,21 +357,6 @@
],
"documentation":"<p>Remove a public key you previously added to CloudFront.</p>"
},
"DeleteServiceLinkedRole":{
"name":"DeleteServiceLinkedRole2017_10_30",
"http":{
"method":"DELETE",
"requestUri":"/2017-10-30/service-linked-role/{RoleName}",
"responseCode":204
},
"input":{"shape":"DeleteServiceLinkedRoleRequest"},
"errors":[
{"shape":"InvalidArgument"},
{"shape":"AccessDenied"},
{"shape":"ResourceInUse"},
{"shape":"NoSuchResource"}
]
},
"DeleteStreamingDistribution":{
"name":"DeleteStreamingDistribution2017_10_30",
"http":{
@ -1894,17 +1879,6 @@
}
}
},
"DeleteServiceLinkedRoleRequest":{
"type":"structure",
"required":["RoleName"],
"members":{
"RoleName":{
"shape":"string",
"location":"uri",
"locationName":"RoleName"
}
}
},
"DeleteStreamingDistributionRequest":{
"type":"structure",
"required":["Id"],
@ -4213,14 +4187,6 @@
"type":"string",
"pattern":"arn:aws:cloudfront::[0-9]+:.*"
},
"ResourceInUse":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"Restrictions":{
"type":"structure",
"required":["GeoRestriction"],

1
botocore/data/cloudsearch/2013-01-01/service-2.json
View file

@ -4,6 +4,7 @@
"apiVersion":"2013-01-01",
"endpointPrefix":"cloudsearch",
"serviceFullName":"Amazon CloudSearch",
"serviceId":"CloudSearch",
"signatureVersion":"v4",
"xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2013-01-01/",
"protocol":"query",

1
botocore/data/cloudsearchdomain/2013-01-01/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon CloudSearch Domain",
"serviceId":"CloudSearch Domain",
"signatureVersion":"v4",
"signingName":"cloudsearch",
"uid":"cloudsearchdomain-2013-01-01"

1
botocore/data/cloudtrail/2013-11-01/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"CloudTrail",
"serviceFullName":"AWS CloudTrail",
"serviceId":"CloudTrail",
"signatureVersion":"v4",
"targetPrefix":"com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101",
"uid":"cloudtrail-2013-11-01"

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

@ -6,6 +6,7 @@
"protocol":"query",
"serviceAbbreviation":"CloudWatch",
"serviceFullName":"Amazon CloudWatch",
"serviceId":"CloudWatch",
"signatureVersion":"v4",
"uid":"monitoring-2010-08-01",
"xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/"

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

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS CodeBuild",
"serviceId":"CodeBuild",
"signatureVersion":"v4",
"targetPrefix":"CodeBuild_20161006",
"uid":"codebuild-2016-10-06"
@ -79,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 repository, enables AWS CodeBuild to begin automatically 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 will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 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 repository, enables AWS CodeBuild to begin automatically 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 will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in 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>"
},
"DeleteProject":{
"name":"DeleteProject",
@ -387,6 +388,10 @@
"shape":"ProjectEnvironment",
"documentation":"<p>Information about the build environment for this build.</p>"
},
"serviceRole":{
"shape":"NonEmptyString",
"documentation":"<p>The name of a service role used for this build.</p>"
},
"logs":{
"shape":"LogsLocation",
"documentation":"<p>Information about the build's logs in Amazon CloudWatch Logs.</p>"
@ -705,7 +710,10 @@
},
"EnvironmentType":{
"type":"string",
"enum":["LINUX_CONTAINER"]
"enum":[
"WINDOWS_CONTAINER",
"LINUX_CONTAINER"
]
},
"EnvironmentVariable":{
"type":"structure",
@ -957,7 +965,8 @@
"enum":[
"DEBIAN",
"AMAZON_LINUX",
"UBUNTU"
"UBUNTU",
"WINDOWS_SERVER"
]
},
"Project":{
@ -1052,7 +1061,7 @@
},
"name":{
"shape":"String",
"documentation":"<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>"
"documentation":"<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), then the artifact is stored in the root of the output bucket.</p> </li> </ul> <p>For example:</p> <ul> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </p> </li> <li> <p> If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to \"<code>/</code>\", then the output artifact would be stored in the root of the output bucket. </p> </li> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to \"<code>/</code>\", then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i> </code>. </p> </li> </ul>"
},
"packaging":{
"shape":"ArtifactPackaging",
@ -1121,7 +1130,7 @@
},
"privilegedMode":{
"shape":"WrapperBoolean",
"documentation":"<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
"documentation":"<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p> <p>If the operating system's base image is Alpine Linux, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout 15 -t sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
},
"certificate":{
"shape":"String",
@ -1174,6 +1183,10 @@
"shape":"SourceAuth",
"documentation":"<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>BITBUCKET</code> or <code>GITHUB</code>).</p>"
},
"reportBuildStatus":{
"shape":"WrapperBoolean",
"documentation":"<p> Set to true to report the status of a build's start and finish to your source provider. This option is only valid when your source provider is GitHub. If this is set and you use a different source provider, an invalidInputException is thrown. </p>"
},
"insecureSsl":{
"shape":"WrapperBoolean",
"documentation":"<p>Enable this flag to ignore SSL warnings while connecting to the project source code.</p>"
@ -1261,6 +1274,18 @@
"shape":"EnvironmentVariables",
"documentation":"<p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>"
},
"sourceTypeOverride":{
"shape":"SourceType",
"documentation":"<p>A source input type for this build that overrides the source input defined in the build project</p>"
},
"sourceLocationOverride":{
"shape":"String",
"documentation":"<p>A location that overrides for this build the source location for the one defined in the build project.</p>"
},
"sourceAuthOverride":{
"shape":"SourceAuth",
"documentation":"<p>An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.</p>"
},
"gitCloneDepthOverride":{
"shape":"GitCloneDepth",
"documentation":"<p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>"
@ -1269,9 +1294,49 @@
"shape":"String",
"documentation":"<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
},
"insecureSslOverride":{
"shape":"WrapperBoolean",
"documentation":"<p>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.</p>"
},
"reportBuildStatusOverride":{
"shape":"WrapperBoolean",
"documentation":"<p> Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, an invalidInputException is thrown. </p>"
},
"environmentTypeOverride":{
"shape":"EnvironmentType",
"documentation":"<p>A container type for this build that overrides the one specified in the build project.</p>"
},
"imageOverride":{
"shape":"NonEmptyString",
"documentation":"<p>The name of an image for this build that overrides the one specified in the build project.</p>"
},
"computeTypeOverride":{
"shape":"ComputeType",
"documentation":"<p>The name of a compute type for this build that overrides the one specified in the build project.</p>"
},
"certificateOverride":{
"shape":"String",
"documentation":"<p>The name of a certificate for this build that overrides the one specified in the build project.</p>"
},
"cacheOverride":{
"shape":"ProjectCache",
"documentation":"<p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>"
},
"serviceRoleOverride":{
"shape":"NonEmptyString",
"documentation":"<p>The name of a service role for this build that overrides the one specified in the build project.</p>"
},
"privilegedModeOverride":{
"shape":"WrapperBoolean",
"documentation":"<p>Enable this flag to override privileged mode in the build project.</p>"
},
"timeoutInMinutesOverride":{
"shape":"TimeOut",
"documentation":"<p>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>"
},
"idempotencyToken":{
"shape":"String",
"documentation":"<p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. </p>"
}
}
},

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

@ -1135,7 +1135,7 @@
},
"terminationWaitTimeInMinutes":{
"shape":"Duration",
"documentation":"<p>The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.</p>"
"documentation":"<p>The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment. The maximum setting is 2880 minutes (2 days).</p>"
}
},
"documentation":"<p>Information about whether instances in the original environment are terminated when a blue/green deployment is successful.</p>"
@ -3211,11 +3211,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>"
"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>"
},
"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>"
"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>Information about the Elastic Load Balancing load balancer or target group used in a deployment.</p>"

4
botocore/data/codepipeline/2015-07-09/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"CodePipeline",
"serviceFullName":"AWS CodePipeline",
"serviceId":"CodePipeline",
"signatureVersion":"v4",
"targetPrefix":"CodePipeline_20150709",
"uid":"codepipeline-2015-07-09"
@ -481,7 +482,8 @@
{"shape":"InvalidStageDeclarationException"},
{"shape":"InvalidActionDeclarationException"},
{"shape":"InvalidBlockerDeclarationException"},
{"shape":"InvalidStructureException"}
{"shape":"InvalidStructureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.</p>"
}

1
botocore/data/codestar/2017-04-19/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"CodeStar",
"serviceFullName":"AWS CodeStar",
"serviceId":"CodeStar",
"signatureVersion":"v4",
"targetPrefix":"CodeStar_20170419",
"uid":"codestar-2017-04-19"

1
botocore/data/cognito-identity/2014-06-30/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Cognito Identity",
"serviceId":"Cognito Identity",
"signatureVersion":"v4",
"targetPrefix":"AWSCognitoIdentityService",
"uid":"cognito-identity-2014-06-30"

30
botocore/data/cognito-idp/2016-04-18/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Cognito Identity Provider",
"serviceId":"Cognito Identity Provider",
"signatureVersion":"v4",
"targetPrefix":"AWSCognitoIdentityProviderService",
"uid":"cognito-idp-2016-04-18"
@ -1863,7 +1864,7 @@
{"shape":"SoftwareTokenMFANotFoundException"},
{"shape":"CodeMismatchException"}
],
"documentation":"<p>Use this API to register a user's entered TOTP code and mark the user's software token MFA status as \"verified\" if successful,</p>"
"documentation":"<p>Use this API to register a user's entered TOTP code and mark the user's software token MFA status as \"verified\" if successful. The request takes an access token or a session string, but not both.</p>"
},
"VerifyUserAttribute":{
"name":"VerifyUserAttribute",
@ -2377,7 +2378,7 @@
"members":{
"ChallengeName":{
"shape":"ChallengeNameType",
"documentation":"<p>The name of the challenge which you are responding to with this call. This is returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge.</p> <ul> <li> <p> <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p> </li> <li> <p> <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code>: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: This is returned if you need to authenticate with <code>USERNAME</code> and <code>PASSWORD</code> directly. An app client must be enabled to use this flow.</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: For users which are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code> and any other required attributes.</p> </li> </ul>"
"documentation":"<p>The name of the challenge which you are responding to with this call. This is returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge.</p> <ul> <li> <p> <code>MFA_SETUP</code>: If MFA is required, users who do not have at least one of the MFA methods set up are presented with an <code>MFA_SETUP</code> challenge. The user must set up at least one MFA type to continue to authenticate.</p> </li> <li> <p> <code>SELECT_MFA_TYPE</code>: Selects the MFA type. Valid MFA options are <code>SMS_MFA</code> for text SMS MFA, and <code>SOFTWARE_TOKEN_MFA</code> for TOTP software token MFA.</p> </li> <li> <p> <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p> </li> <li> <p> <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code>: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: This is returned if you need to authenticate with <code>USERNAME</code> and <code>PASSWORD</code> directly. An app client must be enabled to use this flow.</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: For users which are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code> and any other required attributes.</p> </li> </ul>"
},
"Session":{
"shape":"SessionType",
@ -3041,7 +3042,7 @@
},
"ExpiresIn":{
"shape":"IntegerType",
"documentation":"<p>The expiration period of the authentication result.</p>"
"documentation":"<p>The expiration period of the authentication result in seconds.</p>"
},
"TokenType":{
"shape":"StringType",
@ -3648,7 +3649,7 @@
},
"CallbackURLs":{
"shape":"CallbackURLsListType",
"documentation":"<p>A list of allowed callback URLs for the identity providers.</p>"
"documentation":"<p>A list of allowed redirect (callback) URLs for the identity providers.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not use HTTP without TLS (i.e. use HTTPS instead of HTTP).</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href=\"https://tools.ietf.org/html/rfc6749#section-3.1.2\">OAuth 2.0 - Redirection Endpoint</a>.</p>"
},
"LogoutURLs":{
"shape":"LogoutURLsListType",
@ -3656,7 +3657,7 @@
},
"DefaultRedirectURI":{
"shape":"RedirectUrlType",
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>"
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not use HTTP without TLS (i.e. use HTTPS instead of HTTP).</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href=\"https://tools.ietf.org/html/rfc6749#section-3.1.2\">OAuth 2.0 - Redirection Endpoint</a>.</p>"
},
"AllowedOAuthFlows":{
"shape":"OAuthFlowsType",
@ -4911,7 +4912,8 @@
"SAML",
"Facebook",
"Google",
"LoginWithAmazon"
"LoginWithAmazon",
"OIDC"
]
},
"IdpIdentifierType":{
@ -6068,7 +6070,7 @@
},
"Mutable":{
"shape":"BooleanType",
"documentation":"<p>Specifies whether the attribute can be changed once it has been created.</p>",
"documentation":"<p>Specifies whether the value of the attribute can be changed.</p>",
"box":true
},
"Required":{
@ -6856,7 +6858,7 @@
},
"CallbackURLs":{
"shape":"CallbackURLsListType",
"documentation":"<p>A list of allowed callback URLs for the identity providers.</p>"
"documentation":"<p>A list of allowed redirect (callback) URLs for the identity providers.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not use HTTP without TLS (i.e. use HTTPS instead of HTTP).</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href=\"https://tools.ietf.org/html/rfc6749#section-3.1.2\">OAuth 2.0 - Redirection Endpoint</a>.</p>"
},
"LogoutURLs":{
"shape":"LogoutURLsListType",
@ -6864,7 +6866,7 @@
},
"DefaultRedirectURI":{
"shape":"RedirectUrlType",
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>"
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not use HTTP without TLS (i.e. use HTTPS instead of HTTP).</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href=\"https://tools.ietf.org/html/rfc6749#section-3.1.2\">OAuth 2.0 - Redirection Endpoint</a>.</p>"
},
"AllowedOAuthFlows":{
"shape":"OAuthFlowsType",
@ -7213,7 +7215,7 @@
},
"CallbackURLs":{
"shape":"CallbackURLsListType",
"documentation":"<p>A list of allowed callback URLs for the identity providers.</p>"
"documentation":"<p>A list of allowed redirect (callback) URLs for the identity providers.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not use HTTP without TLS (i.e. use HTTPS instead of HTTP).</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href=\"https://tools.ietf.org/html/rfc6749#section-3.1.2\">OAuth 2.0 - Redirection Endpoint</a>.</p>"
},
"LogoutURLs":{
"shape":"LogoutURLsListType",
@ -7221,7 +7223,7 @@
},
"DefaultRedirectURI":{
"shape":"RedirectUrlType",
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>"
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p> <p>A redirect URI must:</p> <ul> <li> <p>Be an absolute URI.</p> </li> <li> <p>Be registered with the authorization server.</p> </li> <li> <p>Not use HTTP without TLS (i.e. use HTTPS instead of HTTP).</p> </li> <li> <p>Not include a fragment component.</p> </li> </ul> <p>See <a href=\"https://tools.ietf.org/html/rfc6749#section-3.1.2\">OAuth 2.0 - Redirection Endpoint</a>.</p>"
},
"AllowedOAuthFlows":{
"shape":"OAuthFlowsType",
@ -7337,7 +7339,7 @@
},
"LambdaConfig":{
"shape":"LambdaConfigType",
"documentation":"<p>The AWS Lambda triggers associated with tue user pool.</p>"
"documentation":"<p>The AWS Lambda triggers associated with the user pool.</p>"
},
"Status":{
"shape":"StatusType",
@ -7430,6 +7432,10 @@
"UserPoolAddOns":{
"shape":"UserPoolAddOnsType",
"documentation":"<p>The user pool add-ons.</p>"
},
"Arn":{
"shape":"ArnType",
"documentation":"<p>The Amazon Resource Name (ARN) for the user pool.</p>"
}
},
"documentation":"<p>A container for information about the user pool.</p>"

1
botocore/data/cognito-sync/2014-06-30/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"cognito-sync",
"jsonVersion":"1.1",
"serviceFullName":"Amazon Cognito Sync",
"serviceId":"Cognito Sync",
"signatureVersion":"v4",
"protocol":"rest-json",
"uid":"cognito-sync-2014-06-30"

1031
botocore/data/comprehend/2017-11-27/service-2.json
View file

@ -44,7 +44,7 @@
{"shape":"BatchSizeLimitExceededException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Inspects the text of a batch of documents and returns information about them. For more information about entities, see <a>how-entities</a> </p>"
"documentation":"<p>Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see <a>how-entities</a> </p>"
},
"BatchDetectKeyPhrases":{
"name":"BatchDetectKeyPhrases",
@ -80,6 +80,70 @@
],
"documentation":"<p>Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one.</p>"
},
"DescribeDominantLanguageDetectionJob":{
"name":"DescribeDominantLanguageDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDominantLanguageDetectionJobRequest"},
"output":{"shape":"DescribeDominantLanguageDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.</p>"
},
"DescribeEntitiesDetectionJob":{
"name":"DescribeEntitiesDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEntitiesDetectionJobRequest"},
"output":{"shape":"DescribeEntitiesDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.</p>"
},
"DescribeKeyPhrasesDetectionJob":{
"name":"DescribeKeyPhrasesDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeKeyPhrasesDetectionJobRequest"},
"output":{"shape":"DescribeKeyPhrasesDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.</p>"
},
"DescribeSentimentDetectionJob":{
"name":"DescribeSentimentDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSentimentDetectionJobRequest"},
"output":{"shape":"DescribeSentimentDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.</p>"
},
"DescribeTopicsDetectionJob":{
"name":"DescribeTopicsDetectionJob",
"http":{
@ -125,7 +189,7 @@
{"shape":"UnsupportedLanguageException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Inspects text for entities, and returns information about them. For more information, about entities, see <a>how-entities</a>. </p>"
"documentation":"<p>Inspects text for named entities, and returns information about them. For more information, about named entities, see <a>how-entities</a>. </p>"
},
"DetectKeyPhrases":{
"name":"DetectKeyPhrases",
@ -159,6 +223,70 @@
],
"documentation":"<p>Inspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </p>"
},
"ListDominantLanguageDetectionJobs":{
"name":"ListDominantLanguageDetectionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDominantLanguageDetectionJobsRequest"},
"output":{"shape":"ListDominantLanguageDetectionJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidFilterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets a list of the dominant language detection jobs that you have submitted.</p>"
},
"ListEntitiesDetectionJobs":{
"name":"ListEntitiesDetectionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEntitiesDetectionJobsRequest"},
"output":{"shape":"ListEntitiesDetectionJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidFilterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets a list of the entity detection jobs that you have submitted.</p>"
},
"ListKeyPhrasesDetectionJobs":{
"name":"ListKeyPhrasesDetectionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListKeyPhrasesDetectionJobsRequest"},
"output":{"shape":"ListKeyPhrasesDetectionJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidFilterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Get a list of key phrase detection jobs that you have submitted.</p>"
},
"ListSentimentDetectionJobs":{
"name":"ListSentimentDetectionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListSentimentDetectionJobsRequest"},
"output":{"shape":"ListSentimentDetectionJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidFilterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets a list of sentiment detection jobs that you have submitted.</p>"
},
"ListTopicsDetectionJobs":{
"name":"ListTopicsDetectionJobs",
"http":{
@ -175,6 +303,66 @@
],
"documentation":"<p>Gets a list of the topic detection jobs that you have submitted.</p>"
},
"StartDominantLanguageDetectionJob":{
"name":"StartDominantLanguageDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartDominantLanguageDetectionJobRequest"},
"output":{"shape":"StartDominantLanguageDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.</p>"
},
"StartEntitiesDetectionJob":{
"name":"StartEntitiesDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartEntitiesDetectionJobRequest"},
"output":{"shape":"StartEntitiesDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.</p>"
},
"StartKeyPhrasesDetectionJob":{
"name":"StartKeyPhrasesDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartKeyPhrasesDetectionJobRequest"},
"output":{"shape":"StartKeyPhrasesDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.</p>"
},
"StartSentimentDetectionJob":{
"name":"StartSentimentDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartSentimentDetectionJobRequest"},
"output":{"shape":"StartSentimentDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.</p>"
},
"StartTopicsDetectionJob":{
"name":"StartTopicsDetectionJob",
"http":{
@ -189,6 +377,66 @@
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous topic detection job. Use the <code>DescribeTopicDetectionJob</code> operation to track the status of a job.</p>"
},
"StopDominantLanguageDetectionJob":{
"name":"StopDominantLanguageDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopDominantLanguageDetectionJobRequest"},
"output":{"shape":"StopDominantLanguageDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a dominant language detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
},
"StopEntitiesDetectionJob":{
"name":"StopEntitiesDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopEntitiesDetectionJobRequest"},
"output":{"shape":"StopEntitiesDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops an entities detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
},
"StopKeyPhrasesDetectionJob":{
"name":"StopKeyPhrasesDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopKeyPhrasesDetectionJobRequest"},
"output":{"shape":"StopKeyPhrasesDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a key phrases detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
},
"StopSentimentDetectionJob":{
"name":"StopSentimentDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopSentimentDetectionJobRequest"},
"output":{"shape":"StopSentimentDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
}
},
"shapes":{
@ -260,8 +508,8 @@
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>"
},
"LanguageCode":{
"shape":"String",
"documentation":"<p>The language of the input documents. All documents must be in the same language.</p>"
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
@ -308,8 +556,8 @@
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
},
"LanguageCode":{
"shape":"String",
"documentation":"<p>The language of the input documents. All documents must be in the same language.</p>"
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
@ -360,8 +608,8 @@
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
},
"LanguageCode":{
"shape":"String",
"documentation":"<p>The language of the input documents. All documents must be in the same language.</p>"
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
@ -418,6 +666,82 @@
"min":1,
"pattern":"^[a-zA-Z0-9-]+$"
},
"DescribeDominantLanguageDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</p>"
}
}
},
"DescribeDominantLanguageDetectionJobResponse":{
"type":"structure",
"members":{
"DominantLanguageDetectionJobProperties":{
"shape":"DominantLanguageDetectionJobProperties",
"documentation":"<p>An object that contains the properties associated with a dominant language detection job.</p>"
}
}
},
"DescribeEntitiesDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</p>"
}
}
},
"DescribeEntitiesDetectionJobResponse":{
"type":"structure",
"members":{
"EntitiesDetectionJobProperties":{
"shape":"EntitiesDetectionJobProperties",
"documentation":"<p>An object that contains the properties associated with an entities detection job.</p>"
}
}
},
"DescribeKeyPhrasesDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</p>"
}
}
},
"DescribeKeyPhrasesDetectionJobResponse":{
"type":"structure",
"members":{
"KeyPhrasesDetectionJobProperties":{
"shape":"KeyPhrasesDetectionJobProperties",
"documentation":"<p>An object that contains the properties associated with a key phrases detection job. </p>"
}
}
},
"DescribeSentimentDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</p>"
}
}
},
"DescribeSentimentDetectionJobResponse":{
"type":"structure",
"members":{
"SentimentDetectionJobProperties":{
"shape":"SentimentDetectionJobProperties",
"documentation":"<p>An object that contains the properties associated with a sentiment detection job.</p>"
}
}
},
"DescribeTopicsDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
@ -469,7 +793,7 @@
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The RFC 5646 language code of the input text. If the request does not specify the language code, the service detects the dominant language. If you specify a language code that the service does not support, it returns <code>UnsupportedLanguageException</code> exception. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site. </p>"
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
@ -495,7 +819,7 @@
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and <code>UnsupportedLanguageException</code>. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
@ -521,7 +845,7 @@
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and <code>UnsupportedLanguageException</code>. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
@ -543,7 +867,7 @@
"members":{
"LanguageCode":{
"shape":"String",
"documentation":"<p>The RFC 5646 language code for the dominant language. </p>"
"documentation":"<p>The RFC 5646 language code for the dominant language. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
},
"Score":{
"shape":"Float",
@ -552,6 +876,138 @@
},
"documentation":"<p>Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>"
},
"DominantLanguageDetectionJobFilter":{
"type":"structure",
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>Filters on the name of the job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Filters the list of jobs based on job status. Returns only jobs with the specified status.</p>"
},
"SubmitTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
},
"SubmitTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
}
},
"documentation":"<p>Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.</p>"
},
"DominantLanguageDetectionJobProperties":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier assigned to the dominant language detection job.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The name that you assigned to the dominant language detection job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The current status of the dominant language detection job. If the status is <code>FAILED</code>, the <code>Message</code> field shows the reason for the failure.</p>"
},
"Message":{
"shape":"AnyLengthString",
"documentation":"<p>A description for the status of a job.</p>"
},
"SubmitTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the dominant language detection job was submitted for processing.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the dominant language detection job completed.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>The input data configuration that you supplied when you created the dominant language detection job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output data configuration that you supplied when you created the dominant language detection job.</p>"
}
},
"documentation":"<p>Provides information about a dominant language detection job.</p>"
},
"DominantLanguageDetectionJobPropertiesList":{
"type":"list",
"member":{"shape":"DominantLanguageDetectionJobProperties"}
},
"EntitiesDetectionJobFilter":{
"type":"structure",
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>Filters on the name of the job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Filters the list of jobs based on job status. Returns only jobs with the specified status.</p>"
},
"SubmitTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
},
"SubmitTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
}
},
"documentation":"<p>Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.</p>"
},
"EntitiesDetectionJobProperties":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier assigned to the entities detection job.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The name that you assigned the entities detection job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The current status of the entities detection job. If the status is <code>FAILED</code>, the <code>Message</code> field shows the reason for the failure.</p>"
},
"Message":{
"shape":"AnyLengthString",
"documentation":"<p>A description of the status of a job.</p>"
},
"SubmitTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the entities detection job was submitted for processing.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the entities detection job completed</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>The input data configuration that you supplied when you created the entities detection job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output data configuration that you supplied when you created the entities detection job. </p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the input documents.</p>"
}
},
"documentation":"<p>Provides information about an entities detection job.</p>"
},
"EntitiesDetectionJobPropertiesList":{
"type":"list",
"member":{"shape":"EntitiesDetectionJobProperties"}
},
"Entity":{
"type":"structure",
"members":{
@ -670,7 +1126,9 @@
"SUBMITTED",
"IN_PROGRESS",
"COMPLETED",
"FAILED"
"FAILED",
"STOP_REQUESTED",
"STOPPED"
]
},
"KeyPhrase":{
@ -695,6 +1153,74 @@
},
"documentation":"<p>Describes a key noun phrase.</p>"
},
"KeyPhrasesDetectionJobFilter":{
"type":"structure",
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>Filters on the name of the job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Filters the list of jobs based on job status. Returns only jobs with the specified status.</p>"
},
"SubmitTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
},
"SubmitTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
}
},
"documentation":"<p>Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.</p>"
},
"KeyPhrasesDetectionJobProperties":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier assigned to the key phrases detection job.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The name that you assigned the key phrases detection job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The current status of the key phrases detection job. If the status is <code>FAILED</code>, the <code>Message</code> field shows the reason for the failure.</p>"
},
"Message":{
"shape":"AnyLengthString",
"documentation":"<p>A description of the status of a job.</p>"
},
"SubmitTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the key phrases detection job was submitted for processing.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the key phrases detection job completed.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>The input data configuration that you supplied when you created the key phrases detection job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output data configuration that you supplied when you created the key phrases detection job.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the input documents.</p>"
}
},
"documentation":"<p>Provides information about a key phrases detection job.</p>"
},
"KeyPhrasesDetectionJobPropertiesList":{
"type":"list",
"member":{"shape":"KeyPhrasesDetectionJobProperties"}
},
"LanguageCode":{
"type":"string",
"enum":[
@ -702,6 +1228,96 @@
"es"
]
},
"ListDominantLanguageDetectionJobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"DominantLanguageDetectionJobFilter",
"documentation":"<p>Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
"ListDominantLanguageDetectionJobsResponse":{
"type":"structure",
"members":{
"DominantLanguageDetectionJobPropertiesList":{
"shape":"DominantLanguageDetectionJobPropertiesList",
"documentation":"<p>A list containing the properties of each job that is returned.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
}
}
},
"ListEntitiesDetectionJobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"EntitiesDetectionJobFilter",
"documentation":"<p>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
"ListEntitiesDetectionJobsResponse":{
"type":"structure",
"members":{
"EntitiesDetectionJobPropertiesList":{
"shape":"EntitiesDetectionJobPropertiesList",
"documentation":"<p>A list containing the properties of each job that is returned.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
}
}
},
"ListKeyPhrasesDetectionJobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"KeyPhrasesDetectionJobFilter",
"documentation":"<p>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
"ListKeyPhrasesDetectionJobsResponse":{
"type":"structure",
"members":{
"KeyPhrasesDetectionJobPropertiesList":{
"shape":"KeyPhrasesDetectionJobPropertiesList",
"documentation":"<p>A list containing the properties of each job that is returned.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
}
}
},
"ListOfDetectDominantLanguageResult":{
"type":"list",
"member":{"shape":"BatchDetectDominantLanguageItemResult"}
@ -730,6 +1346,36 @@
"type":"list",
"member":{"shape":"KeyPhrase"}
},
"ListSentimentDetectionJobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"SentimentDetectionJobFilter",
"documentation":"<p>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
"ListSentimentDetectionJobsResponse":{
"type":"structure",
"members":{
"SentimentDetectionJobPropertiesList":{
"shape":"SentimentDetectionJobPropertiesList",
"documentation":"<p>A list containing the properties of each job that is returned.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
}
}
},
"ListTopicsDetectionJobsRequest":{
"type":"structure",
"members":{
@ -743,7 +1389,7 @@
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page.</p>"
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
@ -776,7 +1422,7 @@
"members":{
"S3Uri":{
"shape":"S3Uri",
"documentation":"<p>The Amazon S3 URI where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. </p> <p>The service creates an output file called <code>output.tar.gz</code>. It is a compressed archive that contains two files, <code>topic-terms.csv</code> that lists the terms associated with each topic, and <code>doc-topics.csv</code> that lists the documents associated with each topic. For more information, see <a>topic-modeling</a>.</p>"
"documentation":"<p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.</p> <p>When the topic detection job is finished, the service creates an output file in a directory specific to the job. The <code>S3Uri</code> field contains the location of the output file, called <code>output.tar.gz</code>. It is a compressed archive that contains the ouput of the operation.</p>"
}
},
"documentation":"<p>Provides configuration parameters for the output of topic detection jobs.</p> <p/>"
@ -784,7 +1430,75 @@
"S3Uri":{
"type":"string",
"max":1024,
"pattern":"s3://([^/]+)(/.*)?"
"pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?"
},
"SentimentDetectionJobFilter":{
"type":"structure",
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>Filters on the name of the job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Filters the list of jobs based on job status. Returns only jobs with the specified status.</p>"
},
"SubmitTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
},
"SubmitTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
}
},
"documentation":"<p>Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.</p>"
},
"SentimentDetectionJobProperties":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier assigned to the sentiment detection job.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The name that you assigned to the sentiment detection job</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The current status of the sentiment detection job. If the status is <code>FAILED</code>, the <code>Messages</code> field shows the reason for the failure.</p>"
},
"Message":{
"shape":"AnyLengthString",
"documentation":"<p>A description of the status of a job.</p>"
},
"SubmitTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the sentiment detection job was submitted for processing.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the sentiment detection job ended.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>The input data configuration that you supplied when you created the sentiment detection job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output data configuration that you supplied when you created the sentiment detection job.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the input documents.</p>"
}
},
"documentation":"<p>Provides information about a sentiment detection job.</p>"
},
"SentimentDetectionJobPropertiesList":{
"type":"list",
"member":{"shape":"SentimentDetectionJobProperties"}
},
"SentimentScore":{
"type":"structure",
@ -817,7 +1531,7 @@
"MIXED"
]
},
"StartTopicsDetectionJobRequest":{
"StartDominantLanguageDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
@ -833,6 +1547,197 @@
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>An identifier for the job.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"documentation":"<p>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</p>",
"idempotencyToken":true
}
}
},
"StartDominantLanguageDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of a job, use this identifier with the operation.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the operation.</p> </li> </ul>"
}
}
},
"StartEntitiesDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"LanguageCode"
],
"members":{
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and location of the input data for the job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The identifier of the job.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"documentation":"<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>",
"idempotencyToken":true
}
}
},
"StartEntitiesDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of job, use this identifier with the operation.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the operation.</p> </li> </ul>"
}
}
},
"StartKeyPhrasesDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"LanguageCode"
],
"members":{
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and location of the input data for the job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The identifier of the job.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"documentation":"<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>",
"idempotencyToken":true
}
}
},
"StartKeyPhrasesDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of a job, use this identifier with the operation.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the operation.</p> </li> </ul>"
}
}
},
"StartSentimentDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"LanguageCode"
],
"members":{
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and location of the input data for the job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files. </p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The identifier of the job.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"documentation":"<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>",
"idempotencyToken":true
}
}
},
"StartSentimentDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of a job, use this identifier with the operation.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the operation.</p> </li> </ul>"
}
}
},
"StartTopicsDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn"
],
"members":{
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and location of the input data for the job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files. The output is a compressed archive with two files, <code>topic-terms.csv</code> that lists the terms associated with each topic, and <code>doc-topics.csv</code> that lists the documents associated with each topic</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. </p>"
@ -865,6 +1770,98 @@
}
}
},
"StopDominantLanguageDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the dominant language detection job to stop.</p>"
}
}
},
"StopDominantLanguageDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the dominant language detection job to stop.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopDominantLanguageDetectionJob</code> operation.</p>"
}
}
},
"StopEntitiesDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the entities detection job to stop.</p>"
}
}
},
"StopEntitiesDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the entities detection job to stop.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopEntitiesDetectionJob</code> operation.</p>"
}
}
},
"StopKeyPhrasesDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the key phrases detection job to stop.</p>"
}
}
},
"StopKeyPhrasesDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the key phrases detection job to stop.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopKeyPhrasesDetectionJob</code> operation.</p>"
}
}
},
"StopSentimentDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the sentiment detection job to stop.</p>"
}
}
},
"StopSentimentDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the sentiment detection job to stop.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopSentimentDetectionJob</code> operation.</p>"
}
}
},
"String":{
"type":"string",
"min":1

161
botocore/data/config/2014-11-12/service-2.json
View file

@ -115,6 +115,19 @@
],
"documentation":"<p>Deletes pending authorization requests for a specified aggregator account in a specified region.</p>"
},
"DeleteRetentionConfiguration":{
"name":"DeleteRetentionConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRetentionConfigurationRequest"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"NoSuchRetentionConfigurationException"}
],
"documentation":"<p>Deletes the retention configuration.</p>"
},
"DeliverConfigSnapshot":{
"name":"DeliverConfigSnapshot",
"http":{
@ -318,6 +331,21 @@
],
"documentation":"<p>Returns a list of all pending aggregation requests.</p>"
},
"DescribeRetentionConfigurations":{
"name":"DescribeRetentionConfigurations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeRetentionConfigurationsRequest"},
"output":{"shape":"DescribeRetentionConfigurationsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"NoSuchRetentionConfigurationException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.</p> <note> <p>Currently, AWS Config supports only one retention configuration per region in your account.</p> </note>"
},
"GetAggregateComplianceDetailsByConfigRule":{
"name":"GetAggregateComplianceDetailsByConfigRule",
"http":{
@ -431,7 +459,7 @@
{"shape":"NoAvailableConfigurationRecorderException"},
{"shape":"ResourceNotDiscoveredException"}
],
"documentation":"<p>Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.</p> <p>The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter.</p> <note> <p>Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>.</p> </note>"
"documentation":"<p>Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your <code>ConfigurationItems</code> between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the <code>ConfigurationItems</code> for the specified retention period. </p> <p>The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter.</p> <note> <p>Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>.</p> </note>"
},
"ListDiscoveredResources":{
"name":"ListDiscoveredResources",
@ -544,6 +572,20 @@
],
"documentation":"<p>Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.</p>"
},
"PutRetentionConfiguration":{
"name":"PutRetentionConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutRetentionConfigurationRequest"},
"output":{"shape":"PutRetentionConfigurationResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MaxNumberOfRetentionConfigurationsExceededException"}
],
"documentation":"<p>Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the <code>RetentionConfiguration</code> object and names the object as <b>default</b>. When you have a <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the default object. </p> <note> <p>Currently, AWS Config supports only one retention configuration per region in your account.</p> </note>"
},
"StartConfigRulesEvaluation":{
"name":"StartConfigRulesEvaluation",
"http":{
@ -598,7 +640,7 @@
},
"AllAwsRegions":{
"shape":"Boolean",
"documentation":"<p>If true, aggreagate existing AWS Config regions and future regions.</p>"
"documentation":"<p>If true, aggregate existing AWS Config regions and future regions.</p>"
},
"AwsRegions":{
"shape":"AggregatorRegionList",
@ -1567,6 +1609,16 @@
}
}
},
"DeleteRetentionConfigurationRequest":{
"type":"structure",
"required":["RetentionConfigurationName"],
"members":{
"RetentionConfigurationName":{
"shape":"RetentionConfigurationName",
"documentation":"<p>The name of the retention configuration to delete.</p>"
}
}
},
"DeliverConfigSnapshotRequest":{
"type":"structure",
"required":["deliveryChannelName"],
@ -1876,7 +1928,7 @@
"members":{
"AggregatedSourceStatusList":{
"shape":"AggregatedSourceStatusList",
"documentation":"<p>Retuns an AggregatedSourceStatus object. </p>"
"documentation":"<p>Returns an AggregatedSourceStatus object. </p>"
},
"NextToken":{
"shape":"String",
@ -2025,6 +2077,32 @@
}
}
},
"DescribeRetentionConfigurationsRequest":{
"type":"structure",
"members":{
"RetentionConfigurationNames":{
"shape":"RetentionConfigurationNameList",
"documentation":"<p>A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account.</p> <note> <p>Currently, AWS Config supports only one retention configuration per region in your account.</p> </note>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"DescribeRetentionConfigurationsResponse":{
"type":"structure",
"members":{
"RetentionConfigurations":{
"shape":"RetentionConfigurationList",
"documentation":"<p>Returns a retention configuration object.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"EarlierTime":{"type":"timestamp"},
"EmptiableStringWithCharLimit256":{
"type":"string",
@ -2612,6 +2690,13 @@
"documentation":"<p>You have reached the limit of the number of delivery channels you can create.</p>",
"exception":true
},
"MaxNumberOfRetentionConfigurationsExceededException":{
"type":"structure",
"members":{
},
"documentation":"<p>Failed to add the retention configuration because a retention configuration with that name already exists.</p>",
"exception":true
},
"MaximumExecutionFrequency":{
"type":"string",
"enum":[
@ -2696,6 +2781,13 @@
"documentation":"<p>You have specified a delivery channel that does not exist.</p>",
"exception":true
},
"NoSuchRetentionConfigurationException":{
"type":"structure",
"members":{
},
"documentation":"<p>You have specified a retention configuration that does not exist.</p>",
"exception":true
},
"OrderingTimestamp":{"type":"timestamp"},
"OrganizationAccessDeniedException":{
"type":"structure",
@ -2718,7 +2810,7 @@
},
"AllAwsRegions":{
"shape":"Boolean",
"documentation":"<p>If true, aggreagate existing AWS Config regions and future regions.</p>"
"documentation":"<p>If true, aggregate existing AWS Config regions and future regions.</p>"
}
},
"documentation":"<p>This object contains regions to setup the aggregator and an IAM role to retrieve organization details.</p>"
@ -2869,6 +2961,25 @@
},
"documentation":"<p/>"
},
"PutRetentionConfigurationRequest":{
"type":"structure",
"required":["RetentionPeriodInDays"],
"members":{
"RetentionPeriodInDays":{
"shape":"RetentionPeriodInDays",
"documentation":"<p>Number of days AWS Config stores your historical information.</p> <note> <p>Currently, only applicable to the configuration item history.</p> </note>"
}
}
},
"PutRetentionConfigurationResponse":{
"type":"structure",
"members":{
"RetentionConfiguration":{
"shape":"RetentionConfiguration",
"documentation":"<p>Returns a retention configuration object.</p>"
}
}
},
"RecorderName":{
"type":"string",
"max":256,
@ -3087,7 +3198,8 @@
"AWS::ElasticBeanstalk::Application",
"AWS::ElasticBeanstalk::ApplicationVersion",
"AWS::ElasticBeanstalk::Environment",
"AWS::ElasticLoadBalancing::LoadBalancer"
"AWS::ElasticLoadBalancing::LoadBalancer",
"AWS::XRay::EncryptionConfig"
]
},
"ResourceTypeList":{
@ -3100,6 +3212,45 @@
"max":20,
"min":0
},
"RetentionConfiguration":{
"type":"structure",
"required":[
"Name",
"RetentionPeriodInDays"
],
"members":{
"Name":{
"shape":"RetentionConfigurationName",
"documentation":"<p>The name of the retention configuration object.</p>"
},
"RetentionPeriodInDays":{
"shape":"RetentionPeriodInDays",
"documentation":"<p>Number of days AWS Config stores your historical information.</p> <note> <p>Currently, only applicable to the configuration item history.</p> </note>"
}
},
"documentation":"<p>An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in AWS Config.</p>"
},
"RetentionConfigurationList":{
"type":"list",
"member":{"shape":"RetentionConfiguration"}
},
"RetentionConfigurationName":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\w\\-]+"
},
"RetentionConfigurationNameList":{
"type":"list",
"member":{"shape":"RetentionConfigurationName"},
"max":1,
"min":0
},
"RetentionPeriodInDays":{
"type":"integer",
"max":2557,
"min":30
},
"RuleLimit":{
"type":"integer",
"max":50,

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

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Cost and Usage Report Service",
"serviceId":"Cost and Usage Report Service",
"signatureVersion":"v4",
"signingName":"cur",
"targetPrefix":"AWSOrigamiServiceGatewayService",

1
botocore/data/datapipeline/2012-10-29/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"datapipeline",
"jsonVersion":"1.1",
"serviceFullName":"AWS Data Pipeline",
"serviceId":"Data Pipeline",
"signatureVersion":"v4",
"targetPrefix":"DataPipeline",
"protocol":"json",

1
botocore/data/dax/2017-04-19/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"Amazon DAX",
"serviceFullName":"Amazon DynamoDB Accelerator (DAX)",
"serviceId":"DAX",
"signatureVersion":"v4",
"targetPrefix":"AmazonDAXV3",
"uid":"dax-2017-04-19"

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

@ -1386,6 +1386,10 @@
"billingMethod":{
"shape":"BillingMethod",
"documentation":"<p>The billing method for the remote access session.</p>"
},
"vpceConfigurationArns":{
"shape":"AmazonResourceNames",
"documentation":"<p>An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.</p>"
}
},
"documentation":"<p>Configuration settings for a remote access session, including billing method.</p>"

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

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Direct Connect",
"serviceId":"Direct Connect",
"signatureVersion":"v4",
"targetPrefix":"OvertureService",
"uid":"directconnect-2012-10-25"

53
botocore/data/dms/2016-01-01/service-2.json
View file

@ -895,9 +895,13 @@
"shape":"S3Settings",
"documentation":"<p>Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
},
"DmsTransferSettings":{
"shape":"DmsTransferSettings",
"documentation":"<p> The settings in JSON format for the DMS Transfer type source endpoint. </p> <p>Attributes include:</p> <ul> <li> <p>serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p>bucketName - The name of the S3 bucket to use.</p> </li> <li> <p>compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.</p> </li> </ul> <p>Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string</p> <p>JSON syntax:</p> <p> { \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </p>"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the <b>Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the <b>Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\"> Using MongoDB as a Target for AWS Database Migration Service</a>. </p>"
}
},
"documentation":"<p/>"
@ -1110,7 +1114,7 @@
},
"CdcStartTime":{
"shape":"TStamp",
"documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p>"
"documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</p>"
},
"CdcStartPosition":{
"shape":"String",
@ -1814,6 +1818,20 @@
"verify-full"
]
},
"DmsTransferSettings":{
"type":"structure",
"members":{
"ServiceAccessRoleArn":{
"shape":"String",
"documentation":"<p> The IAM role that has permission to access the Amazon S3 bucket. </p>"
},
"BucketName":{
"shape":"String",
"documentation":"<p> The name of the S3 bucket to use. </p>"
}
},
"documentation":"<p> The settings in JSON format for the DMS Transfer type source endpoint. </p>"
},
"DynamoDbSettings":{
"type":"structure",
"required":["ServiceAccessRoleArn"],
@ -1904,6 +1922,10 @@
"shape":"S3Settings",
"documentation":"<p>The settings for the S3 target endpoint. For more information, see the <code>S3Settings</code> structure.</p>"
},
"DmsTransferSettings":{
"shape":"DmsTransferSettings",
"documentation":"<p> The settings in JSON format for the DMS Transfer type source endpoint. </p> <p>Attributes include:</p> <ul> <li> <p>serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p>bucketName - The name of the S3 bucket to use.</p> </li> <li> <p>compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.</p> </li> </ul> <p>Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string</p> <p>JSON syntax:</p> <p> { \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </p>"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
"documentation":"<p>The settings for the MongoDB source endpoint. For more information, see the <code>MongoDbSettings</code> structure.</p>"
@ -2227,6 +2249,10 @@
"shape":"S3Settings",
"documentation":"<p>Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
},
"DmsTransferSettings":{
"shape":"DmsTransferSettings",
"documentation":"<p> The settings in JSON format for the DMS Transfer type source endpoint. </p> <p>Attributes include:</p> <ul> <li> <p>serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p>BucketName - The name of the S3 bucket to use.</p> </li> <li> <p>compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.</p> </li> </ul> <p>Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string</p> <p>JSON syntax:</p> <p> { \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </p>"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the <b>Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
@ -2400,7 +2426,7 @@
},
"CdcStartTime":{
"shape":"TStamp",
"documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p>"
"documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</p>"
},
"CdcStartPosition":{
"shape":"String",
@ -2607,6 +2633,13 @@
"refreshing"
]
},
"ReloadOptionValue":{
"type":"string",
"enum":[
"data-reload",
"validate-only"
]
},
"ReloadTablesMessage":{
"type":"structure",
"required":[
@ -2616,11 +2649,15 @@
"members":{
"ReplicationTaskArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the replication task. </p>"
},
"TablesToReload":{
"shape":"TableListToReload",
"documentation":"<p>The name and schema of the table to be reloaded. </p>"
},
"ReloadOption":{
"shape":"ReloadOptionValue",
"documentation":"<p>Options for reload. Specify <code>data-reload</code> to reload the data and re-validate it if validation is enabled. Specify <code>validate-only</code> to re-validate the table. This option applies only when validation is enabled for the task. </p> <p>Valid values: data-reload, validate-only</p> <p>Default value is data-reload.</p>"
}
}
},
@ -2862,7 +2899,7 @@
"members":{
"ReplicationTaskIdentifier":{
"shape":"String",
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p>The user-assigned replication task identifier or name.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"SourceEndpointArn":{
"shape":"String",
@ -3146,7 +3183,7 @@
},
"CdcStartTime":{
"shape":"TStamp",
"documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p>"
"documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p>Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”</p>"
},
"CdcStartPosition":{
"shape":"String",
@ -3340,6 +3377,10 @@
"ValidationState":{
"shape":"String",
"documentation":"<p>The validation state of the table.</p> <p>The parameter can have the following values</p> <ul> <li> <p>Not enabled—Validation is not enabled for the table in the migration task.</p> </li> <li> <p>Pending records—Some records in the table are waiting for validation.</p> </li> <li> <p>Mismatched records—Some records in the table do not match between the source and target.</p> </li> <li> <p>Suspended records—Some records in the table could not be validated.</p> </li> <li> <p>No primary key—The table could not be validated because it had no primary key.</p> </li> <li> <p>Table error—The table was not validated because it was in an error state and some data was not migrated.</p> </li> <li> <p>Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.</p> </li> <li> <p>Error—The table could not be validated because of an unexpected error.</p> </li> </ul>"
},
"ValidationStateDetails":{
"shape":"String",
"documentation":"<p>Additional details about the state of validation.</p>"
}
},
"documentation":"<p/>"

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

@ -585,6 +585,25 @@
],
"documentation":"<p>Removes tags from a directory.</p>"
},
"ResetUserPassword":{
"name":"ResetUserPassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetUserPasswordRequest"},
"output":{"shape":"ResetUserPasswordResult"},
"errors":[
{"shape":"DirectoryUnavailableException"},
{"shape":"UserDoesNotExistException"},
{"shape":"InvalidPasswordException"},
{"shape":"UnsupportedOperationException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.</p>"
},
"RestoreFromSnapshot":{
"name":"RestoreFromSnapshot",
"http":{
@ -1204,6 +1223,12 @@
"documentation":"<p>The result of a CreateTrust request.</p>"
},
"CreatedDateTime":{"type":"timestamp"},
"CustomerUserName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^(?!.*\\\\|.*\"|.*\\/|.*\\[|.*\\]|.*:|.*;|.*\\||.*=|.*,|.*\\+|.*\\*|.*\\?|.*<|.*>|.*@).*$"
},
"DeleteAssociatedConditionalForwarder":{"type":"boolean"},
"DeleteConditionalForwarderRequest":{
"type":"structure",
@ -2114,6 +2139,15 @@
"documentation":"<p>One or more parameters are not valid.</p>",
"exception":true
},
"InvalidPasswordException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"},
"RequestId":{"shape":"RequestId"}
},
"documentation":"<p>The new password provided by the user does not meet the password complexity requirements defined in your directory.</p>",
"exception":true
},
"IpAddr":{
"type":"string",
"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
@ -2477,6 +2511,33 @@
"documentation":"<p>The AWS request identifier.</p>",
"pattern":"^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$"
},
"ResetUserPasswordRequest":{
"type":"structure",
"required":[
"DirectoryId",
"UserName",
"NewPassword"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.</p>"
},
"UserName":{
"shape":"CustomerUserName",
"documentation":"<p>The username of the user whose password will be reset.</p>"
},
"NewPassword":{
"shape":"UserPassword",
"documentation":"<p>The new password that will be reset.</p>"
}
}
},
"ResetUserPasswordResult":{
"type":"structure",
"members":{
}
},
"ResourceId":{
"type":"string",
"pattern":"^[d]-[0-9a-f]{10}$"
@ -2968,11 +3029,26 @@
},
"UpdateSecurityGroupForDirectoryControllers":{"type":"boolean"},
"UseSameUsername":{"type":"boolean"},
"UserDoesNotExistException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"},
"RequestId":{"shape":"RequestId"}
},
"documentation":"<p>The user provided a username that does not exist in your directory.</p>",
"exception":true
},
"UserName":{
"type":"string",
"min":1,
"pattern":"[a-zA-Z0-9._-]+"
},
"UserPassword":{
"type":"string",
"max":127,
"min":1,
"sensitive":true
},
"VerifyTrustRequest":{
"type":"structure",
"required":["TrustId"],

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

@ -76,7 +76,7 @@
{"shape":"GlobalTableAlreadyExistsException"},
{"shape":"TableNotFoundException"}
],
"documentation":"<p>Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided regions. </p> <p> Tables can only be added as the replicas of a global table group under the following conditions: </p> <ul> <li> <p> The tables must have the same name. </p> </li> <li> <p> The tables must contain no items. </p> </li> <li> <p> The tables must have the same hash key and sort key (if present). </p> </li> <li> <p> The tables must have DynamoDB Streams enabled (NEW_AND_OLD_IMAGES). </p> </li> <li> <p> The tables must have same provisioned and maximum write capacity units. </p> </li> </ul> <p> If global secondary indexes are specified, then the following conditions must also be met: </p> <ul> <li> <p> The global secondary indexes must have the same name. </p> </li> <li> <p> The global secondary indexes must have the same hash key and sort key (if present). </p> </li> <li> <p> The global secondary indexes must have the same provisioned and maximum write capacity units. </p> </li> </ul>"
"documentation":"<p>Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided regions. </p> <p>If you want to add a new replica table to a global table, each of the following conditions must be true:</p> <ul> <li> <p>The table must have the same primary key as all of the other replicas.</p> </li> <li> <p>The table must have the same name as all of the other replicas.</p> </li> <li> <p>The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.</p> </li> <li> <p>None of the replica tables in the global table can contain any data.</p> </li> </ul> <p> If global secondary indexes are specified, then the following conditions must also be met: </p> <ul> <li> <p> The global secondary indexes must have the same name. </p> </li> <li> <p> The global secondary indexes must have the same hash key and sort key (if present). </p> </li> </ul> <important> <p> Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes. </p> <p> If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table. </p> </important>"
},
"CreateTable":{
"name":"CreateTable",
@ -1305,7 +1305,7 @@
"members":{
"ContinuousBackupsDescription":{
"shape":"ContinuousBackupsDescription",
"documentation":"<p> <code>ContinuousBackupsDescription</code> can be one of the following : ENABLED, DISABLED. </p>"
"documentation":"<p>Represents the continuous backups and point in time recovery settings on the table.</p>"
}
}
},
@ -1826,6 +1826,7 @@
"type":"list",
"member":{"shape":"AttributeMap"}
},
"KMSMasterKeyArn":{"type":"string"},
"Key":{
"type":"map",
"key":{"shape":"AttributeName"},
@ -1914,7 +1915,7 @@
"documentation":"<p>Too many operations for a given subscriber.</p>"
}
},
"documentation":"<p>Up to 50 <code>CreateBackup</code> operations are allowed per second, per account. There is no limit to the number of daily on-demand backups that can be taken. </p> <p>Up to 10 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>",
"documentation":"<p>There is no limit to the number of daily on-demand backups that can be taken. </p> <p>Up to 10 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>",
"exception":true
},
"ListAttributeValue":{
@ -1942,7 +1943,7 @@
},
"ExclusiveStartBackupArn":{
"shape":"BackupArn",
"documentation":"<p> <code>LastEvaluatedBackupARN</code> returned by the previous ListBackups call. </p>"
"documentation":"<p> <code>LastEvaluatedBackupArn</code> is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the <code>ExclusiveStartBackupArn</code> of a new <code>ListBackups</code> operation in order to fetch the next page of results. </p>"
}
}
},
@ -1955,7 +1956,7 @@
},
"LastEvaluatedBackupArn":{
"shape":"BackupArn",
"documentation":"<p>Last evaluated BackupARN.</p>"
"documentation":"<p> The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the <code>ExclusiveStartBackupArn</code> of a new <code>ListBackups</code> operation in order to fetch the next page of results. </p> <p> If <code>LastEvaluatedBackupArn</code> is empty, then the last page of results has been processed and there are no more results to be retrieved. </p> <p> If <code>LastEvaluatedBackupArn</code> is not empty, this may or may not indicate there is more data to be returned. All results are guaranteed to have been returned if and only if no value for <code>LastEvaluatedBackupArn</code> is returned. </p>"
}
}
},
@ -2787,6 +2788,14 @@
"Status":{
"shape":"SSEStatus",
"documentation":"<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul>"
},
"SSEType":{
"shape":"SSEType",
"documentation":"<p>Server-side encryption type:</p> <ul> <li> <p> <code>AES256</code> - Server-side encryption which uses the AES256 algorithm.</p> </li> <li> <p> <code>KMS</code> - Server-side encryption which uses AWS Key Management Service.</p> </li> </ul>"
},
"KMSMasterKeyArn":{
"shape":"KMSMasterKeyArn",
"documentation":"<p>The KMS master key ARN used for the KMS encryption.</p>"
}
},
"documentation":"<p>The description of the server-side encryption status on the specified table.</p>"
@ -2812,6 +2821,13 @@
"DISABLED"
]
},
"SSEType":{
"type":"string",
"enum":[
"AES256",
"KMS"
]
},
"ScalarAttributeType":{
"type":"string",
"enum":[

1
botocore/data/dynamodbstreams/2012-08-10/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.0",
"protocol":"json",
"serviceFullName":"Amazon DynamoDB Streams",
"serviceId":"DynamoDB Streams",
"signatureVersion":"v4",
"signingName":"dynamodb",
"targetPrefix":"DynamoDBStreams_20120810",

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

File diff suppressed because one or more lines are too long

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

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"Amazon ECR",
"serviceFullName":"Amazon EC2 Container Registry",
"serviceId":"ECR",
"signatureVersion":"v4",
"targetPrefix":"AmazonEC2ContainerRegistry_V20150921",
"uid":"ecr-2015-09-21"

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

@ -46,7 +46,7 @@
{"shape":"PlatformTaskDefinitionIncompatibilityException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an <a>UpdateService</a> operation.</p> <p>The <code>minimumHealthyPercent</code> represents a lower limit on the number of your service's tasks that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>minimumHealthyPercent</code> of 50%, the scheduler can stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.</p> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of your service's tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>maximumPercent</code> value of 200%, the scheduler can start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the <code>placementStrategy</code> parameter):</p> <ul> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul>"
"documentation":"<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an <a>UpdateService</a> operation.</p> <p>The <code>minimumHealthyPercent</code> represents a lower limit on the number of your service's tasks that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>minimumHealthyPercent</code> of 50%, the scheduler can stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. The default value for a daemon service for <code>minimumHealthyPercent</code> is 0% for the AWS CLI, the AWS SDKs, and the APIs and 50% for the console.</p> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of your service's tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your replica service has a <code>desiredCount</code> of four tasks and a <code>maximumPercent</code> value of 200%, the scheduler can start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for a replica service for <code>maximumPercent</code> is 200%. If you are using a daemon service type, the <code>maximumPercent</code> should remain at 100%, which is the default value.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the <code>placementStrategy</code> parameter):</p> <ul> <li> <p>Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul>"
},
"DeleteAttributes":{
"name":"DeleteAttributes",
@ -870,7 +870,7 @@
},
"hostname":{
"shape":"String",
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The <code>hostname</code> parameter is not supported if using the <code>awsvpc</code> networkMode.</p> </note>"
},
"user":{
"shape":"String",
@ -952,7 +952,7 @@
},
"remainingResources":{
"shape":"Resources",
"documentation":"<p>For CPU and memory resource types, this parameter describes the remaining CPU and memory on the that has not already been allocated to tasks (and is therefore available for new tasks). For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the <code>host</code> or <code>bridge</code> network mode). Any port that is not specified here is available for new tasks.</p>"
"documentation":"<p>For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the <code>host</code> or <code>bridge</code> network mode). Any port that is not specified here is available for new tasks.</p>"
},
"registeredResources":{
"shape":"Resources",
@ -1094,8 +1094,7 @@
"type":"structure",
"required":[
"serviceName",
"taskDefinition",
"desiredCount"
"taskDefinition"
],
"members":{
"cluster":{
@ -1112,11 +1111,11 @@
},
"loadBalancers":{
"shape":"LoadBalancers",
"documentation":"<p>A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p>"
"documentation":"<p>A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
},
"serviceRegistries":{
"shape":"ServiceRegistries",
"documentation":"<p>The details of the service discovery registries you want to assign to this service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguideservice-discovery.html\">Service Discovery</a>.</p>"
"documentation":"<p>The details of the service discovery registries you want to assign to this service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p> <note> <p>Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a>.</p> </note>"
},
"desiredCount":{
"shape":"BoxedInteger",
@ -1124,7 +1123,7 @@
},
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>"
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>"
},
"launchType":{
"shape":"LaunchType",
@ -1157,6 +1156,10 @@
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
"documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
"documentation":"<p>The scheduling strategy to use for the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html\">Services</a>.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code>-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.</p> </li> <li> <p> <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.</p> <note> <p>Fargate tasks do not support the <code>DAEMON</code> scheduling strategy.</p> </note> </li> </ul>"
}
}
},
@ -1222,6 +1225,10 @@
"service":{
"shape":"String",
"documentation":"<p>The name of the service to delete.</p>"
},
"force":{
"shape":"BoxedBoolean",
"documentation":"<p>If <code>true</code>, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the <code>REPLICA</code> scheduling strategy.</p>"
}
}
},
@ -1384,7 +1391,7 @@
},
"containerInstances":{
"shape":"StringList",
"documentation":"<p>A list of container instance IDs or full ARN entries.</p>"
"documentation":"<p>A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.</p>"
}
}
},
@ -1698,11 +1705,11 @@
},
"sharedMemorySize":{
"shape":"BoxedInteger",
"documentation":"<p>The value for the size of the <code>/dev/shm</code> volume. This parameter maps to the <code>--shm-size</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"documentation":"<p>The value for the size (in MiB) of the <code>/dev/shm</code> volume. This parameter maps to the <code>--shm-size</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you are using tasks that use the Fargate launch type, the <code>sharedMemorySize</code> parameter is not supported.</p> </note>"
},
"tmpfs":{
"shape":"TmpfsList",
"documentation":"<p>The container path, mount options, and size of the tmpfs mount. This parameter maps to the <code>--tmpfs</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"documentation":"<p>The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the <code>--tmpfs</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you are using tasks that use the Fargate launch type, the <code>tmpfs</code> parameter is not supported.</p> </note>"
}
},
"documentation":"<p>Linux-specific options that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>"
@ -1832,6 +1839,10 @@
"launchType":{
"shape":"LaunchType",
"documentation":"<p>The launch type for services you want to list.</p>"
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
"documentation":"<p>The scheduling strategy for services to list.</p>"
}
}
},
@ -1979,7 +1990,7 @@
"members":{
"targetGroupArn":{
"shape":"String",
"documentation":"<p>The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.</p>"
"documentation":"<p>The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.</p> <important> <p>If your service's task definition uses the <code>awsvpc</code> network mode (which is required for the Fargate launch type), you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p> </important>"
},
"loadBalancerName":{
"shape":"String",
@ -1994,7 +2005,7 @@
"documentation":"<p>The port on the container to associate with the load balancer. This port must correspond to a <code>containerPort</code> in the service's task definition. Your container instances must allow ingress traffic on the <code>hostPort</code> of the port mapping.</p>"
}
},
"documentation":"<p>Details on a load balancer that is used with a service.</p>"
"documentation":"<p>Details on a load balancer that is used with a service.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
},
"LoadBalancers":{
"type":"list",
@ -2355,7 +2366,7 @@
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the resource, such as <code>cpu</code>, <code>memory</code>, <code>ports</code>, or a user-defined resource.</p>"
"documentation":"<p>The name of the resource, such as <code>CPU</code>, <code>MEMORY</code>, <code>PORTS</code>, <code>PORTS_UDP</code>, or a user-defined resource.</p>"
},
"type":{
"shape":"String",
@ -2447,6 +2458,13 @@
}
}
},
"SchedulingStrategy":{
"type":"string",
"enum":[
"REPLICA",
"DAEMON"
]
},
"ServerException":{
"type":"structure",
"members":{
@ -2473,7 +2491,7 @@
},
"loadBalancers":{
"shape":"LoadBalancers",
"documentation":"<p>A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.</p>"
"documentation":"<p>A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
},
"serviceRegistries":{
"shape":"ServiceRegistries",
@ -2542,6 +2560,10 @@
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
"documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.</p>"
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
"documentation":"<p>The scheduling strategy to use for the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html\">Services</a>.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code>-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.</p> </li> <li> <p> <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When using this strategy, do not specify a desired number of tasks or any task placement strategies.</p> <note> <p>Fargate tasks do not support the <code>DAEMON</code> scheduling strategy.</p> </note> </li> </ul>"
}
},
"documentation":"<p>Details on a service within a cluster</p>"
@ -2591,11 +2613,19 @@
"members":{
"registryArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html\">Service</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html\">Service</a>.</p>"
},
"port":{
"shape":"BoxedInteger",
"documentation":"<p>The port value used if your Service Discovery service specified an SRV record.</p>"
"documentation":"<p>The port value used if your service discovery service specified an SRV record. This field is required if both the <code>awsvpc</code> network mode and SRV records are used.</p>"
},
"containerName":{
"shape":"String",
"documentation":"<p>The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the <code>bridge</code> or <code>host</code> network mode, you must specify a <code>containerName</code> and <code>containerPort</code> combination from the task definition. If the task definition that your service task specifies uses the <code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify either a <code>containerName</code> and <code>containerPort</code> combination or a <code>port</code> value, but not both.</p>"
},
"containerPort":{
"shape":"BoxedInteger",
"documentation":"<p>The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the <code>bridge</code> or <code>host</code> network mode, you must specify a <code>containerName</code> and <code>containerPort</code> combination from the task definition. If the task definition your service task specifies uses the <code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify either a <code>containerName</code> and <code>containerPort</code> combination or a <code>port</code> value, but not both.</p>"
}
},
"documentation":"<p>Details of the service registry.</p>"
@ -3053,7 +3083,7 @@
},
"size":{
"shape":"Integer",
"documentation":"<p>The size of the tmpfs volume.</p>"
"documentation":"<p>The size (in MiB) of the tmpfs volume.</p>"
},
"mountOptions":{
"shape":"StringList",

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

@ -6,6 +6,7 @@
"protocol":"rest-json",
"serviceAbbreviation":"EFS",
"serviceFullName":"Amazon Elastic File System",
"serviceId":"EFS",
"signatureVersion":"v4",
"uid":"elasticfilesystem-2015-02-01"
},

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

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

422
botocore/data/eks/2017-11-01/service-2.json Normal file
View file

@ -0,0 +1,422 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-11-01",
"endpointPrefix":"eks",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"Amazon EKS",
"serviceFullName":"Amazon Elastic Container Service for Kubernetes",
"serviceId":"EKS",
"signatureVersion":"v4",
"signingName":"eks",
"uid":"eks-2017-11-01"
},
"operations":{
"CreateCluster":{
"name":"CreateCluster",
"http":{
"method":"POST",
"requestUri":"/clusters"
},
"input":{"shape":"CreateClusterRequest"},
"output":{"shape":"CreateClusterResponse"},
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnsupportedAvailabilityZoneException"}
],
"documentation":"<p>Creates an Amazon EKS control plane. </p> <p>The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, like <code>etcd</code> and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint.</p> <p>Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.</p> <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data flows).</p> <p>After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html\">Managing Cluster Authentication</a> and <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html\">Launching Amazon EKS Worker Nodes</a>in the <i>Amazon EKS User Guide</i>.</p>"
},
"DeleteCluster":{
"name":"DeleteCluster",
"http":{
"method":"DELETE",
"requestUri":"/clusters/{name}"
},
"input":{"shape":"DeleteClusterRequest"},
"output":{"shape":"DeleteClusterResponse"},
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes the Amazon EKS cluster control plane. </p> <note> <p>If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html\">Deleting a Cluster</a> in the <i>Amazon EKS User Guide</i>.</p> </note>"
},
"DescribeCluster":{
"name":"DescribeCluster",
"http":{
"method":"GET",
"requestUri":"/clusters/{name}"
},
"input":{"shape":"DescribeClusterRequest"},
"output":{"shape":"DescribeClusterResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns descriptive information about an Amazon EKS cluster.</p> <p>The API server endpoint and certificate authority data returned by this operation are required for <code>kubelet</code> and <code>kubectl</code> to communicate with your Kubernetes API server. For more information, see <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html\">Create a kubeconfig for Amazon EKS</a>.</p> <note> <p>The API server endpoint and certificate authority data are not available until the cluster reaches the <code>ACTIVE</code> state.</p> </note>"
},
"ListClusters":{
"name":"ListClusters",
"http":{
"method":"GET",
"requestUri":"/clusters"
},
"input":{"shape":"ListClustersRequest"},
"output":{"shape":"ListClustersResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Lists the Amazon EKS clusters in your AWS account in the specified region.</p>"
}
},
"shapes":{
"Certificate":{
"type":"structure",
"members":{
"data":{
"shape":"String",
"documentation":"<p>The base64 encoded certificate data required to communicate with your cluster. Add this to the <code>certificate-authority-data</code> section of the <code>kubeconfig</code> file for your cluster.</p>"
}
},
"documentation":"<p>An object representing the <code>certificate-authority-data</code> for your cluster.</p>"
},
"ClientException":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"message":{"shape":"String"}
},
"documentation":"<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"Cluster":{
"type":"structure",
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the cluster.</p>"
},
"arn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the cluster.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch time stamp in seconds for when the cluster was created.</p>"
},
"version":{
"shape":"String",
"documentation":"<p>The Kubernetes server version for the cluster.</p>"
},
"endpoint":{
"shape":"String",
"documentation":"<p>The endpoint for your Kubernetes API server.</p>"
},
"roleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.</p>"
},
"resourcesVpcConfig":{
"shape":"VpcConfigResponse",
"documentation":"<p>The VPC subnets and security groups used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html\">Cluster VPC Considerations</a> and <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html\">Cluster Security Group Considerations</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"status":{
"shape":"ClusterStatus",
"documentation":"<p>The current status of the cluster.</p>"
},
"certificateAuthority":{
"shape":"Certificate",
"documentation":"<p>The <code>certificate-authority-data</code> for your cluster.</p>"
},
"clientRequestToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request.</p>"
}
},
"documentation":"<p>An object representing an Amazon EKS cluster.</p>"
},
"ClusterName":{
"type":"string",
"max":255,
"min":1,
"pattern":"[A-Za-z0-9\\-_]*"
},
"ClusterStatus":{
"type":"string",
"enum":[
"CREATING",
"ACTIVE",
"DELETING",
"FAILED"
]
},
"CreateClusterRequest":{
"type":"structure",
"required":[
"name",
"roleArn",
"resourcesVpcConfig"
],
"members":{
"name":{
"shape":"ClusterName",
"documentation":"<p>The unique name to give to your cluster.</p>"
},
"version":{
"shape":"String",
"documentation":"<p>The desired Kubernetes version for your cluster. If you do not specify a value here, the latest version available in Amazon EKS is used.</p>"
},
"roleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html\">Amazon EKS Service IAM Role</a> in the <i> <i>Amazon EKS User Guide</i> </i> </p>"
},
"resourcesVpcConfig":{
"shape":"VpcConfigRequest",
"documentation":"<p>The VPC subnets and security groups used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html\">Cluster VPC Considerations</a> and <a href=\"http://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html\">Cluster Security Group Considerations</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"clientRequestToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
}
}
},
"CreateClusterResponse":{
"type":"structure",
"members":{
"cluster":{
"shape":"Cluster",
"documentation":"<p>The full description of your new cluster.</p>"
}
}
},
"DeleteClusterRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the cluster to delete.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DeleteClusterResponse":{
"type":"structure",
"members":{
"cluster":{
"shape":"Cluster",
"documentation":"<p>The full description of the cluster to delete.</p>"
}
}
},
"DescribeClusterRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of the cluster to describe.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DescribeClusterResponse":{
"type":"structure",
"members":{
"cluster":{
"shape":"Cluster",
"documentation":"<p>The full description of your specified cluster.</p>"
}
}
},
"InvalidParameterException":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"message":{"shape":"String"}
},
"documentation":"<p>The specified parameter is invalid. Review the available parameters for the API request.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ListClustersRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"ListClustersRequestMaxResults",
"documentation":"<p>The maximum number of cluster results returned by <code>ListClusters</code> in paginated output. When this parameter is used, <code>ListClusters</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListClusters</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListClusters</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListClusters</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListClustersRequestMaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListClustersResponse":{
"type":"structure",
"members":{
"clusters":{
"shape":"StringList",
"documentation":"<p>A list of all of the clusters for your account in the specified region.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListClusters</code> request. When the results of a <code>ListClusters</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ResourceInUseException":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"message":{"shape":"String"}
},
"documentation":"<p>The specified resource is in use.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceLimitExceededException":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"message":{"shape":"String"}
},
"documentation":"<p>You have encountered a service limit on the specified resource.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"message":{"shape":"String"}
},
"documentation":"<p>The specified resource could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon EKS clusters are region-specific.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"ServerException":{
"type":"structure",
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"message":{"shape":"String"}
},
"documentation":"<p>These errors are usually caused by a server-side issue.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The service is unavailable, back off and retry the operation.</p>",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true
},
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"Timestamp":{"type":"timestamp"},
"UnsupportedAvailabilityZoneException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"clusterName":{
"shape":"String",
"documentation":"<p>The Amazon EKS cluster associated with the exception.</p>"
},
"validZones":{
"shape":"StringList",
"documentation":"<p>The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.</p>"
}
},
"documentation":"<p>At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output will specify the supported Availability Zones for your account, from which you can choose subnets for your cluster.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"VpcConfigRequest":{
"type":"structure",
"required":["subnetIds"],
"members":{
"subnetIds":{
"shape":"StringList",
"documentation":"<p>Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.</p>"
},
"securityGroupIds":{
"shape":"StringList",
"documentation":"<p>Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane.</p>"
}
},
"documentation":"<p>An object representing an Amazon EKS cluster VPC configuration request.</p>"
},
"VpcConfigResponse":{
"type":"structure",
"members":{
"subnetIds":{
"shape":"StringList",
"documentation":"<p>The subnets associated with your cluster.</p>"
},
"securityGroupIds":{
"shape":"StringList",
"documentation":"<p>The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.</p>"
},
"vpcId":{
"shape":"String",
"documentation":"<p>The VPC associated with your cluster.</p>"
}
},
"documentation":"<p>An object representing an Amazon EKS cluster VPC configuration response.</p>"
}
},
"documentation":"<p>Amazon Elastic Container Service for Kubernetes (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications. </p> <p>Amazon EKS runs three Kubernetes control plane instances across three Availability Zones to ensure high availability. Amazon EKS automatically detects and replaces unhealthy control plane instances, and it provides automated version upgrades and patching for them.</p> <p>Amazon EKS is also integrated with many AWS services to provide scalability and security for your applications, including the following: </p> <ul> <li> <p>Elastic Load Balancing for load distribution</p> </li> <li> <p>IAM for authentication</p> </li> <li> <p>Amazon VPC for isolation</p> </li> </ul> <p>Amazon EKS runs up to date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.</p>"
}

1
botocore/data/elasticache/2015-02-02/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"elasticache",
"protocol":"query",
"serviceFullName":"Amazon ElastiCache",
"serviceId":"ElastiCache",
"signatureVersion":"v4",
"uid":"elasticache-2015-02-02",
"xmlNamespace":"http://elasticache.amazonaws.com/doc/2015-02-02/"

15
botocore/data/elasticbeanstalk/2010-12-01/service-2.json
View file

@ -423,7 +423,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ElasticBeanstalkServiceException"}
],
"documentation":"<p>Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html\">enhanced health reporting</a>.</p>"
"documentation":"<p>Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html\">enhanced health reporting</a>.</p>"
},
"DescribePlatformVersion":{
"name":"DescribePlatformVersion",
@ -808,7 +808,7 @@
"members":{
"ServiceRole":{
"shape":"String",
"documentation":"<p>The ARN of an IAM service role that Elastic Beanstalk has permission to assume.</p>"
"documentation":"<p>The ARN of an IAM service role that Elastic Beanstalk has permission to assume.</p> <p>The <code>ServiceRole</code> property is required the first time that you provide a <code>VersionLifecycleConfig</code> for the application in one of the supporting calls (<code>CreateApplication</code> or <code>UpdateApplicationResourceLifecycle</code>). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent <code>UpdateApplicationResourceLifecycle</code> calls. You can, however, specify it in subsequent calls to change the Service Role to another value.</p>"
},
"VersionLifecycleConfig":{
"shape":"ApplicationVersionLifecycleConfig",
@ -872,7 +872,7 @@
},
"Status":{
"shape":"ApplicationVersionStatus",
"documentation":"<p>The processing status of the application version.</p>"
"documentation":"<p>The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified <code>True</code> for the <code>Process</code> parameter of the <code>CreateApplicationVersion</code> action. The following list describes the possible values.</p> <ul> <li> <p> <code>Unprocessed</code> – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.</p> </li> <li> <p> <code>Processing</code> – Elastic Beanstalk is currently processing the application version.</p> </li> <li> <p> <code>Building</code> – Application version is currently undergoing an AWS CodeBuild build.</p> </li> <li> <p> <code>Processed</code> – Elastic Beanstalk was successfully pre-processed and validated.</p> </li> <li> <p> <code>Failed</code> – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.</p> </li> </ul>"
}
},
"documentation":"<p>Describes the properties of an application version.</p>"
@ -1400,7 +1400,7 @@
},
"Process":{
"shape":"ApplicationVersionProccess",
"documentation":"<p>Preprocesses and validates the environment manifest (<code>env.yaml</code>) and configuration files (<code>*.config</code> files in the <code>.ebextensions</code> folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.</p> <note> <p>The <code>Process</code> option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.</p> </note>"
"documentation":"<p>Pre-processes and validates the environment manifest (<code>env.yaml</code>) and configuration files (<code>*.config</code> files in the <code>.ebextensions</code> folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.</p> <p>You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.</p> <note> <p>The <code>Process</code> option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.</p> </note>"
}
},
"documentation":"<p/>"
@ -1489,7 +1489,7 @@
},
"SolutionStackName":{
"shape":"SolutionStackName",
"documentation":"<p>This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.</p>"
"documentation":"<p>This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.</p> <p>For a list of current solution stacks, see <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html\">Elastic Beanstalk Supported Platforms</a>.</p>"
},
"PlatformArn":{
"shape":"PlatformArn",
@ -2236,7 +2236,8 @@
"Info",
"Warning",
"Degraded",
"Severe"
"Severe",
"Suspended"
]
},
"EnvironmentId":{"type":"string"},
@ -2381,7 +2382,7 @@
},
"Version":{
"shape":"String",
"documentation":"<p>The version of this environment tier.</p>"
"documentation":"<p>The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.</p> <note> <p>This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.</p> </note>"
}
},
"documentation":"<p>Describes the properties of an environment tier</p>"

1
botocore/data/elastictranscoder/2012-09-25/service-2.json
View file

@ -6,6 +6,7 @@
"endpointPrefix":"elastictranscoder",
"protocol":"rest-json",
"serviceFullName":"Amazon Elastic Transcoder",
"serviceId":"Elastic Transcoder",
"signatureVersion":"v4"
},
"operations":{

1
botocore/data/elb/2012-06-01/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"elasticloadbalancing",
"protocol":"query",
"serviceFullName":"Elastic Load Balancing",
"serviceId":"Elastic Load Balancing",
"signatureVersion":"v4",
"uid":"elasticloadbalancing-2012-06-01",
"xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/"

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

@ -73,7 +73,9 @@
{"shape":"CertificateNotFoundException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"}
{"shape":"TooManyTargetsException"},
{"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>"
},
@ -126,9 +128,12 @@
{"shape":"TargetGroupNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"}
{"shape":"TooManyTargetsException"},
{"shape":"UnsupportedProtocolException"},
{"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 condition for a rule is met, the specified action is taken. If no conditions are met, the action for the default rule is taken. 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=\"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>"
},
"CreateTargetGroup":{
"name":"CreateTargetGroup",
@ -274,7 +279,8 @@
},
"errors":[
{"shape":"ListenerNotFoundException"},
{"shape":"LoadBalancerNotFoundException"}
{"shape":"LoadBalancerNotFoundException"},
{"shape":"UnsupportedProtocolException"}
],
"documentation":"<p>Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.</p>"
},
@ -292,7 +298,7 @@
"errors":[
{"shape":"LoadBalancerNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified Application Load Balancer or Network Load Balancer.</p>"
"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>"
},
"DescribeLoadBalancers":{
"name":"DescribeLoadBalancers",
@ -323,7 +329,8 @@
},
"errors":[
{"shape":"ListenerNotFoundException"},
{"shape":"RuleNotFoundException"}
{"shape":"RuleNotFoundException"},
{"shape":"UnsupportedProtocolException"}
],
"documentation":"<p>Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.</p>"
},
@ -376,7 +383,7 @@
"errors":[
{"shape":"TargetGroupNotFoundException"}
],
"documentation":"<p>Describes the attributes for the specified target group.</p>"
"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>"
},
"DescribeTargetGroups":{
"name":"DescribeTargetGroups",
@ -437,7 +444,9 @@
{"shape":"InvalidConfigurationRequestException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"}
{"shape":"TooManyTargetsException"},
{"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>"
},
@ -476,9 +485,12 @@
{"shape":"OperationNotPermittedException"},
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"},
{"shape":"TargetGroupNotFoundException"}
{"shape":"TargetGroupNotFoundException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyActionsException"},
{"shape":"InvalidLoadBalancerActionException"}
],
"documentation":"<p>Modifies the specified rule.</p> <p>Any existing properties that you do not modify retain their current values.</p> <p>To modify the default action, use <a>ModifyListener</a>.</p>"
"documentation":"<p>Modifies the specified rule.</p> <p>Any existing properties that you do not modify retain their current values.</p> <p>To modify the actions for the default rule, use <a>ModifyListener</a>.</p>"
},
"ModifyTargetGroup":{
"name":"ModifyTargetGroup",
@ -649,25 +661,43 @@
"shapes":{
"Action":{
"type":"structure",
"required":[
"Type",
"TargetGroupArn"
],
"required":["Type"],
"members":{
"Type":{
"shape":"ActionTypeEnum",
"documentation":"<p>The type of action.</p>"
"documentation":"<p>The type of action. Each rule must include one forward action.</p>"
},
"TargetGroupArn":{
"shape":"TargetGroupArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the target group.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the target group. Specify only when <code>Type</code> is <code>forward</code>.</p> <p>For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p>"
},
"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>"
},
"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>"
},
"Order":{
"shape":"ActionOrder",
"documentation":"<p>The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The forward action must be performed last.</p>"
}
},
"documentation":"<p>Information about an action.</p>"
},
"ActionOrder":{
"type":"integer",
"max":50000,
"min":1
},
"ActionTypeEnum":{
"type":"string",
"enum":["forward"]
"enum":[
"forward",
"authenticate-oidc",
"authenticate-cognito"
]
},
"Actions":{
"type":"list",
@ -734,6 +764,152 @@
},
"exception":true
},
"AuthenticateCognitoActionAuthenticationRequestExtraParams":{
"type":"map",
"key":{"shape":"AuthenticateCognitoActionAuthenticationRequestParamName"},
"value":{"shape":"AuthenticateCognitoActionAuthenticationRequestParamValue"}
},
"AuthenticateCognitoActionAuthenticationRequestParamName":{"type":"string"},
"AuthenticateCognitoActionAuthenticationRequestParamValue":{"type":"string"},
"AuthenticateCognitoActionConditionalBehaviorEnum":{
"type":"string",
"enum":[
"deny",
"allow",
"authenticate"
]
},
"AuthenticateCognitoActionConfig":{
"type":"structure",
"required":[
"UserPoolArn",
"UserPoolClientId",
"UserPoolDomain"
],
"members":{
"UserPoolArn":{
"shape":"AuthenticateCognitoActionUserPoolArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Cognito user pool.</p>"
},
"UserPoolClientId":{
"shape":"AuthenticateCognitoActionUserPoolClientId",
"documentation":"<p>The ID of the Amazon Cognito user pool client.</p>"
},
"UserPoolDomain":{
"shape":"AuthenticateCognitoActionUserPoolDomain",
"documentation":"<p>The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.</p>"
},
"SessionCookieName":{
"shape":"AuthenticateCognitoActionSessionCookieName",
"documentation":"<p>The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.</p>"
},
"Scope":{
"shape":"AuthenticateCognitoActionScope",
"documentation":"<p>The set of user claims to be requested from the IdP. The default is <code>openid</code>.</p> <p>To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.</p>"
},
"SessionTimeout":{
"shape":"AuthenticateCognitoActionSessionTimeout",
"documentation":"<p>The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).</p>"
},
"AuthenticationRequestExtraParams":{
"shape":"AuthenticateCognitoActionAuthenticationRequestExtraParams",
"documentation":"<p>The query parameters (up to 10) to include in the redirect request to the authorization endpoint.</p>"
},
"OnUnauthenticatedRequest":{
"shape":"AuthenticateCognitoActionConditionalBehaviorEnum",
"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>"
}
},
"documentation":"<p>Request parameters to use when integrating with Amazon Cognito to authenticate users.</p>"
},
"AuthenticateCognitoActionScope":{"type":"string"},
"AuthenticateCognitoActionSessionCookieName":{"type":"string"},
"AuthenticateCognitoActionSessionTimeout":{"type":"long"},
"AuthenticateCognitoActionUserPoolArn":{"type":"string"},
"AuthenticateCognitoActionUserPoolClientId":{"type":"string"},
"AuthenticateCognitoActionUserPoolDomain":{"type":"string"},
"AuthenticateOidcActionAuthenticationRequestExtraParams":{
"type":"map",
"key":{"shape":"AuthenticateOidcActionAuthenticationRequestParamName"},
"value":{"shape":"AuthenticateOidcActionAuthenticationRequestParamValue"}
},
"AuthenticateOidcActionAuthenticationRequestParamName":{"type":"string"},
"AuthenticateOidcActionAuthenticationRequestParamValue":{"type":"string"},
"AuthenticateOidcActionAuthorizationEndpoint":{"type":"string"},
"AuthenticateOidcActionClientId":{"type":"string"},
"AuthenticateOidcActionClientSecret":{"type":"string"},
"AuthenticateOidcActionConditionalBehaviorEnum":{
"type":"string",
"enum":[
"deny",
"allow",
"authenticate"
]
},
"AuthenticateOidcActionConfig":{
"type":"structure",
"required":[
"Issuer",
"AuthorizationEndpoint",
"TokenEndpoint",
"UserInfoEndpoint",
"ClientId",
"ClientSecret"
],
"members":{
"Issuer":{
"shape":"AuthenticateOidcActionIssuer",
"documentation":"<p>The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
},
"AuthorizationEndpoint":{
"shape":"AuthenticateOidcActionAuthorizationEndpoint",
"documentation":"<p>The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
},
"TokenEndpoint":{
"shape":"AuthenticateOidcActionTokenEndpoint",
"documentation":"<p>The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
},
"UserInfoEndpoint":{
"shape":"AuthenticateOidcActionUserInfoEndpoint",
"documentation":"<p>The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"
},
"ClientId":{
"shape":"AuthenticateOidcActionClientId",
"documentation":"<p>The OAuth 2.0 client identifier.</p>"
},
"ClientSecret":{
"shape":"AuthenticateOidcActionClientSecret",
"documentation":"<p>The OAuth 2.0 client secret.</p>"
},
"SessionCookieName":{
"shape":"AuthenticateOidcActionSessionCookieName",
"documentation":"<p>The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.</p>"
},
"Scope":{
"shape":"AuthenticateOidcActionScope",
"documentation":"<p>The set of user claims to be requested from the IdP. The default is <code>openid</code>.</p> <p>To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.</p>"
},
"SessionTimeout":{
"shape":"AuthenticateOidcActionSessionTimeout",
"documentation":"<p>The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).</p>"
},
"AuthenticationRequestExtraParams":{
"shape":"AuthenticateOidcActionAuthenticationRequestExtraParams",
"documentation":"<p>The query parameters (up to 10) to include in the redirect request to the authorization endpoint.</p>"
},
"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>"
}
},
"documentation":"<p>Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.</p>"
},
"AuthenticateOidcActionIssuer":{"type":"string"},
"AuthenticateOidcActionScope":{"type":"string"},
"AuthenticateOidcActionSessionCookieName":{"type":"string"},
"AuthenticateOidcActionSessionTimeout":{"type":"long"},
"AuthenticateOidcActionTokenEndpoint":{"type":"string"},
"AuthenticateOidcActionUserInfoEndpoint":{"type":"string"},
"AvailabilityZone":{
"type":"structure",
"members":{
@ -851,11 +1027,11 @@
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>[HTTPS listeners] The SSL server certificate. You must provide exactly one certificate.</p>"
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The default action for the listener. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.</p>"
"documentation":"<p>The actions for the default rule. The rule must include one forward action.</p> <p>If the action type is <code>forward</code>, you can specify a single 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>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
}
}
},
@ -874,7 +1050,7 @@
"members":{
"Name":{
"shape":"LoadBalancerName",
"documentation":"<p>The name of the load balancer.</p> <p>This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.</p>"
"documentation":"<p>The name of the load balancer.</p> <p>This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".</p>"
},
"Subnets":{
"shape":"Subnets",
@ -934,11 +1110,11 @@
},
"Priority":{
"shape":"RulePriority",
"documentation":"<p>The priority for the rule. A listener can't have multiple rules with the same priority.</p>"
"documentation":"<p>The rule priority. A listener can't have multiple rules with the same priority.</p>"
},
"Actions":{
"shape":"Actions",
"documentation":"<p>An action. Each action has the type <code>forward</code> and specifies a target group.</p>"
"documentation":"<p>The actions. Each rule must include one forward action.</p> <p>If the action type is <code>forward</code>, you can specify a single target group.</p> <p>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
}
}
},
@ -1516,6 +1692,18 @@
},
"exception":true
},
"InvalidLoadBalancerActionException":{
"type":"structure",
"members":{
},
"documentation":"<p>The requested action is not valid.</p>",
"error":{
"code":"InvalidLoadBalancerAction",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidSchemeException":{
"type":"structure",
"members":{
@ -1732,7 +1920,7 @@
"members":{
"Key":{
"shape":"LoadBalancerAttributeKey",
"documentation":"<p>The name of the attribute.</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - [Application Load Balancers] Indicates whether access logs stored in Amazon S3 are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - [Application Load Balancers] The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - [Application Load Balancers] The prefix for the location in the S3 bucket. If you don't specify a prefix, the access logs are stored in the root of the bucket.</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>.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - [Application Load Balancers] The idle timeout value, in seconds. The valid range is 1-4000. The default is 60 seconds.</p> </li> <li> <p> <code>load_balancing.cross_zone.enabled</code> - [Network Load Balancers] 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> <li> <p> <code>routing.http2.enabled</code> - [Application Load Balancers] 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>"
"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 permission 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>"
},
"Value":{
"shape":"LoadBalancerAttributeValue",
@ -1844,15 +2032,15 @@
},
"SslPolicy":{
"shape":"SslPolicyName",
"documentation":"<p>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 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>"
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>The default SSL server certificate.</p>"
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The default action. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.</p>"
"documentation":"<p>The actions for the default rule. The rule must include one forward action.</p> <p>If the action type is <code>forward</code>, you can specify a single 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>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
}
}
},
@ -1861,7 +2049,7 @@
"members":{
"Listeners":{
"shape":"Listeners",
"documentation":"<p>Information about the modified listeners.</p>"
"documentation":"<p>Information about the modified listener.</p>"
}
}
},
@ -1901,11 +2089,11 @@
},
"Conditions":{
"shape":"RuleConditionList",
"documentation":"<p>The conditions.</p>"
"documentation":"<p>The conditions. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
},
"Actions":{
"shape":"Actions",
"documentation":"<p>The actions. The target group must use the HTTP or HTTPS protocol.</p>"
"documentation":"<p>The actions.</p> <p>If the action type is <code>forward</code>, you can specify a single target group.</p> <p>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
}
}
},
@ -1914,7 +2102,7 @@
"members":{
"Rules":{
"shape":"Rules",
"documentation":"<p>Information about the rule.</p>"
"documentation":"<p>Information about the modified rule.</p>"
}
}
},
@ -1991,7 +2179,7 @@
"members":{
"TargetGroups":{
"shape":"TargetGroups",
"documentation":"<p>Information about the target group.</p>"
"documentation":"<p>Information about the modified target group.</p>"
}
}
},
@ -2304,10 +2492,7 @@
},
"SetSubnetsInput":{
"type":"structure",
"required":[
"LoadBalancerArn",
"Subnets"
],
"required":["LoadBalancerArn"],
"members":{
"LoadBalancerArn":{
"shape":"LoadBalancerArn",
@ -2567,7 +2752,7 @@
"members":{
"Key":{
"shape":"TargetGroupAttributeKey",
"documentation":"<p>The name of the attribute.</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds.</p> </li> <li> <p> <code>proxy_protocol_v2.enabled</code> - [Network Load Balancers] Indicates whether Proxy Protocol version 2 is enabled.</p> </li> <li> <p> <code>stickiness.enabled</code> - [Application Load Balancers] Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - [Application Load Balancers] The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - [Application Load Balancers] The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</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>deregistration_delay.timeout_seconds</code> - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>slow_start.duration_seconds</code> - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default.</p> </li> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>proxy_protocol_v2.enabled</code> - Indicates whether Proxy Protocol version 2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
},
"Value":{
"shape":"TargetGroupAttributeValue",
@ -2682,6 +2867,18 @@
"ip"
]
},
"TooManyActionsException":{
"type":"structure",
"members":{
},
"documentation":"<p>You've reached the limit on the number of actions per rule.</p>",
"error":{
"code":"TooManyActions",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"TooManyCertificatesException":{
"type":"structure",
"members":{

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

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"Amazon EMR",
"serviceFullName":"Amazon Elastic MapReduce",
"serviceId":"EMR",
"signatureVersion":"v4",
"targetPrefix":"ElasticMapReduce",
"timestampFormat":"unixTimestamp",

134
botocore/data/endpoints.json
View file

@ -97,6 +97,15 @@
"us-west-2" : { }
}
},
"api.mediatailor" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-west-1" : { },
"us-east-1" : { }
}
},
"api.pricing" : {
"defaults" : {
"credentialScope" : {
@ -221,6 +230,7 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
@ -338,6 +348,7 @@
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -583,11 +594,14 @@
"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" : { }
}
},
@ -809,6 +823,7 @@
},
"elasticfilesystem" : {
"endpoints" : {
"ap-northeast-2" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
@ -937,8 +952,10 @@
"firehose" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
@ -952,6 +969,7 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -998,11 +1016,13 @@
"glue" : {
"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" : { }
@ -1098,6 +1118,7 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
@ -1249,9 +1270,12 @@
"medialive" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -1270,6 +1294,16 @@
"us-west-2" : { }
}
},
"mediastore" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
}
},
"metering.marketplace" : {
"defaults" : {
"credentialScope" : {
@ -1347,6 +1381,34 @@
},
"isRegionalized" : false
},
"neptune" : {
"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"
}
}
},
"opsworks" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -1519,6 +1581,7 @@
},
"runtime.sagemaker" : {
"endpoints" : {
"ap-northeast-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1583,6 +1646,8 @@
},
"sagemaker" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1698,6 +1763,7 @@
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
@ -1786,6 +1852,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "sqs-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "sqs-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "sqs-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "sqs-fips.us-west-2.amazonaws.com"
},
"sa-east-1" : { },
"us-east-1" : {
"sslCommonName" : "queue.{dnsSuffix}"
@ -1817,6 +1907,7 @@
"states" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
@ -1825,6 +1916,7 @@
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
@ -2088,7 +2180,8 @@
"services" : {
"apigateway" : {
"endpoints" : {
"cn-north-1" : { }
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"application-autoscaling" : {
@ -2142,12 +2235,29 @@
"cn-northwest-1" : { }
}
},
"data.iot" : {
"defaults" : {
"credentialScope" : {
"service" : "iotdata"
},
"protocols" : [ "https" ]
},
"endpoints" : {
"cn-north-1" : { }
}
},
"directconnect" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"ds" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"dynamodb" : {
"defaults" : {
"protocols" : [ "http", "https" ]
@ -2168,12 +2278,14 @@
},
"ecr" : {
"endpoints" : {
"cn-north-1" : { }
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"ecs" : {
"endpoints" : {
"cn-north-1" : { }
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"elasticache" : {
@ -2256,7 +2368,8 @@
},
"lambda" : {
"endpoints" : {
"cn-north-1" : { }
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"logs" : {
@ -2525,6 +2638,11 @@
"isRegionalized" : false,
"partitionEndpoint" : "aws-us-gov-global"
},
"inspector" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"kinesis" : {
"endpoints" : {
"us-gov-west-1" : { }
@ -2662,6 +2780,14 @@
"endpoints" : {
"us-gov-west-1" : { }
}
},
"translate" : {
"defaults" : {
"protocols" : [ "https" ]
},
"endpoints" : {
"us-gov-west-1" : { }
}
}
}
} ],

402
botocore/data/firehose/2015-08-04/service-2.json
View file

@ -26,7 +26,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Creates a delivery stream.</p> <p>By default, you can create up to 50 delivery streams per AWS Region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis data stream as its source. To specify a Kinesis data stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis data stream Amazon Resource Name (ARN) and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. Specify only one of the following destination configuration parameters: <code>ExtendedS3DestinationConfiguration</code>, <code>S3DestinationConfiguration</code>, <code>ElasticsearchDestinationConfiguration</code>, <code>RedshiftDestinationConfiguration</code>, or <code>SplunkDestinationConfiguration</code>.</p> <p>When you specify <code>S3DestinationConfiguration</code>, you can also provide the following optional values: <code>BufferingHints</code>, <code>EncryptionConfiguration</code>, and <code>CompressionFormat</code>. By default, if no <code>BufferingHints</code> value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. <code>BufferingHints</code> is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location. This is because Kinesis Data Firehose first delivers data to Amazon S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <code>RedshiftDestinationConfiguration.S3Configuration</code> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password that you provide exclusively with Kinesis Data Firehose. In addition, the permissions for the account should be restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Firehose Access to an Amazon S3 Destination</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>"
"documentation":"<p>Creates a Kinesis Data Firehose delivery stream.</p> <p>By default, you can create up to 50 delivery streams per AWS Region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: <b>ExtendedS3DestinationConfiguration</b>, <b>S3DestinationConfiguration</b>, <b>ElasticsearchDestinationConfiguration</b>, <b>RedshiftDestinationConfiguration</b>, or <b>SplunkDestinationConfiguration</b>.</p> <p>When you specify <b>S3DestinationConfiguration</b>, you can also provide the following optional values: <b>BufferingHints</b>, <b>EncryptionConfiguration</b>, and <b>CompressionFormat</b>. By default, if no <b>BufferingHints</b> value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. <b>BufferingHints</b> is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <b>RedshiftDestinationConfiguration.S3Configuration</b> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>"
},
"DeleteDeliveryStream":{
"name":"DeleteDeliveryStream",
@ -40,7 +40,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a delivery stream and its data.</p> <p>You can delete a delivery stream only if it is in <code>ACTIVE</code> or <code>DELETING</code> state, and not in the <code>CREATING</code> state. While the deletion request is in process, the delivery stream is in the <code>DELETING</code> state.</p> <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>While the delivery stream is <code>DELETING</code> state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.</p>"
"documentation":"<p>Deletes a delivery stream and its data.</p> <p>You can delete a delivery stream only if it is in <code>ACTIVE</code> or <code>DELETING</code> state, and not in the <code>CREATING</code> state. While the deletion request is in process, the delivery stream is in the <code>DELETING</code> state.</p> <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>While the delivery stream is <code>DELETING</code> state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.</p>"
},
"DescribeDeliveryStream":{
"name":"DescribeDeliveryStream",
@ -93,7 +93,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <code>PutRecord</code> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>. </p> <p>You must specify the name of the delivery stream and the data record when using <code>PutRecord</code>. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <code>PutRecord</code> operation returns a <code>RecordId</code>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.</p> <p>If the <code>PutRecord</code> operation throws a <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </p> <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>"
"documentation":"<p>Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>. </p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <code>PutRecord</code> operation returns a <code>RecordId</code>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.</p> <p>If the <code>PutRecord</code> operation throws a <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </p> <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>"
},
"PutRecordBatch":{
"name":"PutRecordBatch",
@ -108,7 +108,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <code>PutRecordBatch</code>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>.</p> <p>Each <code>PutRecordBatch</code> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.</p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <code>PutRecordBatch</code> response includes a count of failed records, <code>FailedPutCount</code>, and an array of responses, <code>RequestResponses</code>. Each entry in the <code>RequestResponses</code> array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. <code>RequestResponses</code> includes both successfully and unsuccessfully processed records. Kinesis Data Firehose attempts to process all records in each <code>PutRecordBatch</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes a <code>RecordId</code> value, which is unique for the record. An unsuccessfully processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error, and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the error.</p> <p>If there is an internal server error or a timeout, the write might have completed or it might have failed. If <code>FailedPutCount</code> is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.</p> <p>If <code>PutRecordBatch</code> throws <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.</p> <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>"
"documentation":"<p>Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>.</p> <p>Each <a>PutRecordBatch</a> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.</p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecordBatch</a> response includes a count of failed records, <b>FailedPutCount</b>, and an array of responses, <b>RequestResponses</b>. Each entry in the <b>RequestResponses</b> array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. <b>RequestResponses</b> includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each <a>PutRecordBatch</a> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes a <b>RecordId</b> value, which is unique for the record. An unsuccessfully processed record includes <b>ErrorCode</b> and <b>ErrorMessage</b> values. <b>ErrorCode</b> reflects the type of error, and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <b>ErrorMessage</b> provides more detailed information about the error.</p> <p>If there is an internal server error or a timeout, the write might have completed or it might have failed. If <b>FailedPutCount</b> is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.</p> <p>If <a>PutRecordBatch</a> throws <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.</p> <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>"
},
"TagDeliveryStream":{
"name":"TagDeliveryStream",
@ -156,7 +156,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Updates the specified destination of the specified delivery stream.</p> <p>Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified, then the existing <code>EncryptionConfiguration</code> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Kinesis Data Firehose uses <code>CurrentDeliveryStreamVersionId</code> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and you can retrieve it using <a>DescribeDeliveryStream</a>. Use the new version ID to set <code>CurrentDeliveryStreamVersionId</code> in the next call.</p>"
"documentation":"<p>Updates the specified destination of the specified delivery stream.</p> <p>Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified, then the existing <code>EncryptionConfiguration</code> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Kinesis Data Firehose uses <b>CurrentDeliveryStreamVersionId</b> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using <a>DescribeDeliveryStream</a>. Use the new version ID to set <b>CurrentDeliveryStreamVersionId</b> in the next call.</p>"
}
},
"shapes":{
@ -166,6 +166,10 @@
"min":1,
"pattern":"arn:.*"
},
"BlockSizeBytes":{
"type":"integer",
"min":67108864
},
"BooleanObject":{"type":"boolean"},
"BucketARN":{
"type":"string",
@ -185,7 +189,7 @@
"documentation":"<p>Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.</p>"
}
},
"documentation":"<p>Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values whenever it is optimal.</p>"
"documentation":"<p>Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal.</p>"
},
"CloudWatchLoggingOptions":{
"type":"structure",
@ -210,6 +214,11 @@
"min":1,
"pattern":"jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)+redshift\\.amazonaws\\.com:\\d{1,5}/[a-zA-Z0-9_$]+"
},
"ColumnToJsonKeyMappings":{
"type":"map",
"key":{"shape":"NonEmptyStringWithoutWhitespace"},
"value":{"shape":"NonEmptyString"}
},
"CompressionFormat":{
"type":"string",
"enum":[
@ -256,7 +265,7 @@
"members":{
"DeliveryStreamName":{
"shape":"DeliveryStreamName",
"documentation":"<p>The name of the delivery stream. This name must be unique per AWS account in the same Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.</p>"
"documentation":"<p>The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.</p>"
},
"DeliveryStreamType":{
"shape":"DeliveryStreamType",
@ -303,6 +312,28 @@
"max":1024000,
"min":0
},
"DataFormatConversionConfiguration":{
"type":"structure",
"members":{
"SchemaConfiguration":{
"shape":"SchemaConfiguration",
"documentation":"<p>Specifies the AWS Glue Data Catalog table that contains the column information.</p>"
},
"InputFormatConfiguration":{
"shape":"InputFormatConfiguration",
"documentation":"<p>Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.</p>"
},
"OutputFormatConfiguration":{
"shape":"OutputFormatConfiguration",
"documentation":"<p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.</p>"
},
"Enabled":{
"shape":"BooleanObject",
"documentation":"<p>Defaults to <code>true</code>. Set it to <code>false</code> if you want to disable format conversion while preserving the configuration details.</p>"
}
},
"documentation":"<p>Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html\">Kinesis Data Firehose Record Format Conversion</a>.</p>"
},
"DataTableColumns":{"type":"string"},
"DataTableName":{
"type":"string",
@ -348,7 +379,7 @@
},
"DeliveryStreamARN":{
"shape":"DeliveryStreamARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the delivery stream.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the delivery stream. 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>.</p>"
},
"DeliveryStreamStatus":{
"shape":"DeliveryStreamStatus",
@ -426,11 +457,11 @@
},
"Limit":{
"shape":"DescribeDeliveryStreamInputLimit",
"documentation":"<p>The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.</p>"
"documentation":"<p>The limit on the number of destinations to return. You can have one destination per delivery stream.</p>"
},
"ExclusiveStartDestinationId":{
"shape":"DestinationId",
"documentation":"<p>The ID of the destination to start returning the destination information. Currently, Kinesis Data Firehose supports one destination per delivery stream.</p>"
"documentation":"<p>The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.</p>"
}
}
},
@ -449,6 +480,20 @@
}
}
},
"Deserializer":{
"type":"structure",
"members":{
"OpenXJsonSerDe":{
"shape":"OpenXJsonSerDe",
"documentation":"<p>The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.</p>"
},
"HiveJsonSerDe":{
"shape":"HiveJsonSerDe",
"documentation":"<p>The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.</p>"
}
},
"documentation":"<p>The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the <a>Serializer</a>. Kinesis Data Firehose supports two types of deserializers: the <a href=\"https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON\">Apache Hive JSON SerDe</a> and the <a href=\"https://github.com/rcongiu/Hive-JSON-Serde\">OpenX JSON SerDe</a>.</p>"
},
"DestinationDescription":{
"type":"structure",
"required":["DestinationId"],
@ -525,11 +570,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon Destination</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
},
"DomainARN":{
"shape":"ElasticsearchDomainARN",
"documentation":"<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the role specified in <code>RoleARN</code>.</p>"
"documentation":"<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the role specified in <b>RoleARN</b>. 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>.</p>"
},
"IndexName":{
"shape":"ElasticsearchIndexName",
@ -537,11 +582,11 @@
},
"TypeName":{
"shape":"ElasticsearchTypeName",
"documentation":"<p>The Elasticsearch type name.</p>"
"documentation":"<p>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.</p>"
},
"IndexRotationPeriod":{
"shape":"ElasticsearchIndexRotationPeriod",
"documentation":"<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. The default value is <code>OneDay</code>.</p>"
"documentation":"<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to the <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. The default value is <code>OneDay</code>.</p>"
},
"BufferingHints":{
"shape":"ElasticsearchBufferingHints",
@ -553,7 +598,7 @@
},
"S3BackupMode":{
"shape":"ElasticsearchS3BackupMode",
"documentation":"<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <code>elasticsearch-failed/</code> appended to the key prefix. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <code>elasticsearch-failed/</code> appended to the prefix. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#retry\">Data Delivery Failure Handling</a>. Default value is <code>FailedDocumentsOnly</code>.</p>"
"documentation":"<p>Defines how documents should be delivered to Amazon S3. When it is set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <code>elasticsearch-failed/</code> appended to the key prefix. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <code>elasticsearch-failed/</code> appended to the prefix. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup\">Amazon S3 Backup for the Amazon ES Destination</a>. Default value is <code>FailedDocumentsOnly</code>.</p>"
},
"S3Configuration":{
"shape":"S3DestinationConfiguration",
@ -565,7 +610,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes the configuration of a destination in Amazon ES.</p>"
@ -575,11 +620,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"DomainARN":{
"shape":"ElasticsearchDomainARN",
"documentation":"<p>The ARN of the Amazon ES domain.</p>"
"documentation":"<p>The ARN of the Amazon ES domain. 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>.</p>"
},
"IndexName":{
"shape":"ElasticsearchIndexName",
@ -615,7 +660,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options.</p>"
"documentation":"<p>The Amazon CloudWatch logging options.</p>"
}
},
"documentation":"<p>The destination description in Amazon ES.</p>"
@ -625,11 +670,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
},
"DomainARN":{
"shape":"ElasticsearchDomainARN",
"documentation":"<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the IAM role specified in <code>RoleARN</code>.</p>"
"documentation":"<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the IAM role specified in <b>RoleARN</b>. 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>.</p>"
},
"IndexName":{
"shape":"ElasticsearchIndexName",
@ -637,15 +682,15 @@
},
"TypeName":{
"shape":"ElasticsearchTypeName",
"documentation":"<p>The Elasticsearch type name.</p>"
"documentation":"<p>The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.</p>"
},
"IndexRotationPeriod":{
"shape":"ElasticsearchIndexRotationPeriod",
"documentation":"<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. Default value is <code>OneDay</code>.</p>"
"documentation":"<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. Default value is <code>OneDay</code>.</p>"
},
"BufferingHints":{
"shape":"ElasticsearchBufferingHints",
"documentation":"<p>The buffering options. If no value is specified, <code>ElasticsearchBufferingHints</code> object default values are used. </p>"
"documentation":"<p>The buffering options. If no value is specified, <b>ElasticsearchBufferingHints</b> object default values are used. </p>"
},
"RetryOptions":{
"shape":"ElasticsearchRetryOptions",
@ -697,7 +742,7 @@
"members":{
"DurationInSeconds":{
"shape":"ElasticsearchRetryDurationInSeconds",
"documentation":"<p>After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.</p>"
"documentation":"<p>After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.</p>"
}
},
"documentation":"<p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.</p>"
@ -739,11 +784,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"BucketARN":{
"shape":"BucketARN",
"documentation":"<p>The ARN of the S3 bucket.</p>"
"documentation":"<p>The ARN of the S3 bucket. 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>.</p>"
},
"Prefix":{
"shape":"Prefix",
@ -763,7 +808,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
},
"ProcessingConfiguration":{
"shape":"ProcessingConfiguration",
@ -776,6 +821,10 @@
"S3BackupConfiguration":{
"shape":"S3DestinationConfiguration",
"documentation":"<p>The configuration for backup in Amazon S3.</p>"
},
"DataFormatConversionConfiguration":{
"shape":"DataFormatConversionConfiguration",
"documentation":"<p>The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.</p>"
}
},
"documentation":"<p>Describes the configuration of a destination in Amazon S3.</p>"
@ -792,15 +841,15 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"BucketARN":{
"shape":"BucketARN",
"documentation":"<p>The ARN of the S3 bucket.</p>"
"documentation":"<p>The ARN of the S3 bucket. 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>.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>"
"documentation":"<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>"
},
"BufferingHints":{
"shape":"BufferingHints",
@ -816,7 +865,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
},
"ProcessingConfiguration":{
"shape":"ProcessingConfiguration",
@ -829,6 +878,10 @@
"S3BackupDescription":{
"shape":"S3DestinationDescription",
"documentation":"<p>The configuration for backup in Amazon S3.</p>"
},
"DataFormatConversionConfiguration":{
"shape":"DataFormatConversionConfiguration",
"documentation":"<p>The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.</p>"
}
},
"documentation":"<p>Describes a destination in Amazon S3.</p>"
@ -838,11 +891,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"BucketARN":{
"shape":"BucketARN",
"documentation":"<p>The ARN of the S3 bucket.</p>"
"documentation":"<p>The ARN of the S3 bucket. 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>.</p>"
},
"Prefix":{
"shape":"Prefix",
@ -862,7 +915,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
},
"ProcessingConfiguration":{
"shape":"ProcessingConfiguration",
@ -875,6 +928,10 @@
"S3BackupUpdate":{
"shape":"S3DestinationUpdate",
"documentation":"<p>The Amazon S3 destination for backup.</p>"
},
"DataFormatConversionConfiguration":{
"shape":"DataFormatConversionConfiguration",
"documentation":"<p>The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.</p>"
}
},
"documentation":"<p>Describes an update for a destination in Amazon S3.</p>"
@ -893,6 +950,26 @@
]
},
"HECToken":{"type":"string"},
"HiveJsonSerDe":{
"type":"structure",
"members":{
"TimestampFormats":{
"shape":"ListOfNonEmptyStrings",
"documentation":"<p>Indicates how you want Kinesis Data Firehose to parse the date and time stamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see <a href=\"https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html\">Class DateTimeFormat</a>. You can also use the special value <code>millis</code> to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses <code>java.sql.Timestamp::valueOf</code> by default.</p>"
}
},
"documentation":"<p>The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.</p>"
},
"InputFormatConfiguration":{
"type":"structure",
"members":{
"Deserializer":{
"shape":"Deserializer",
"documentation":"<p>Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.</p>"
}
},
"documentation":"<p>Specifies the deserializer you want to use to convert the format of the input data.</p>"
},
"IntervalInSeconds":{
"type":"integer",
"max":900,
@ -915,7 +992,7 @@
"members":{
"AWSKMSKeyARN":{
"shape":"AWSKMSKeyARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. 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>.</p>"
}
},
"documentation":"<p>Describes an encryption key for a destination in Amazon S3.</p>"
@ -935,11 +1012,11 @@
"members":{
"KinesisStreamARN":{
"shape":"KinesisStreamARN",
"documentation":"<p>The ARN of the source Kinesis data stream.</p>"
"documentation":"<p>The ARN of the source Kinesis data stream. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Kinesis Data Streams ARN Format</a>.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The ARN of the role that provides access to the source Kinesis data stream.</p>"
"documentation":"<p>The ARN of the role that provides access to the source Kinesis data stream. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam\">AWS Identity and Access Management (IAM) ARN Format</a>.</p>"
}
},
"documentation":"<p>The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.</p>"
@ -949,11 +1026,11 @@
"members":{
"KinesisStreamARN":{
"shape":"KinesisStreamARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the source Kinesis data stream.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Kinesis Data Streams ARN Format</a>.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The ARN of the role used by the source Kinesis data stream.</p>"
"documentation":"<p>The ARN of the role used by the source Kinesis data stream. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam\">AWS Identity and Access Management (IAM) ARN Format</a>.</p>"
},
"DeliveryStartTimestamp":{
"shape":"DeliveryStartTimestamp",
@ -1012,6 +1089,14 @@
}
}
},
"ListOfNonEmptyStrings":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"ListOfNonEmptyStringsWithoutWhitespace":{
"type":"list",
"member":{"shape":"NonEmptyStringWithoutWhitespace"}
},
"ListTagsForDeliveryStreamInput":{
"type":"structure",
"required":["DeliveryStreamName"],
@ -1064,10 +1149,164 @@
"type":"string",
"enum":["NoEncryption"]
},
"NonEmptyString":{
"type":"string",
"pattern":"^(?!\\s*$).+"
},
"NonEmptyStringWithoutWhitespace":{
"type":"string",
"pattern":"^\\S+$"
},
"NonNegativeIntegerObject":{
"type":"integer",
"min":0
},
"OpenXJsonSerDe":{
"type":"structure",
"members":{
"ConvertDotsInJsonKeysToUnderscores":{
"shape":"BooleanObject",
"documentation":"<p>When set to <code>true</code>, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is \"a.b\", you can define the column name to be \"a_b\" when using this option.</p> <p>The default is <code>false</code>.</p>"
},
"CaseInsensitive":{
"shape":"BooleanObject",
"documentation":"<p>When set to <code>true</code>, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.</p>"
},
"ColumnToJsonKeyMappings":{
"shape":"ColumnToJsonKeyMappings",
"documentation":"<p>Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, <code>timestamp</code> is a Hive keyword. If you have a JSON key named <code>timestamp</code>, set this parameter to <code>{\"ts\": \"timestamp\"}</code> to map this key to a column named <code>ts</code>.</p>"
}
},
"documentation":"<p>The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.</p>"
},
"OrcCompression":{
"type":"string",
"enum":[
"NONE",
"ZLIB",
"SNAPPY"
]
},
"OrcFormatVersion":{
"type":"string",
"enum":[
"V0_11",
"V0_12"
]
},
"OrcRowIndexStride":{
"type":"integer",
"min":1000
},
"OrcSerDe":{
"type":"structure",
"members":{
"StripeSizeBytes":{
"shape":"OrcStripeSizeBytes",
"documentation":"<p>The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.</p>"
},
"BlockSizeBytes":{
"shape":"BlockSizeBytes",
"documentation":"<p>The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.</p>"
},
"RowIndexStride":{
"shape":"OrcRowIndexStride",
"documentation":"<p>The number of rows between index entries. The default is 10,000 and the minimum is 1,000.</p>"
},
"EnablePadding":{
"shape":"BooleanObject",
"documentation":"<p>Set this to <code>true</code> to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is <code>false</code>.</p>"
},
"PaddingTolerance":{
"shape":"Proportion",
"documentation":"<p>A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.</p> <p>For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.</p> <p>Kinesis Data Firehose ignores this parameter when <a>OrcSerDe$EnablePadding</a> is <code>false</code>.</p>"
},
"Compression":{
"shape":"OrcCompression",
"documentation":"<p>The compression code to use over data blocks. The default is <code>SNAPPY</code>.</p>"
},
"BloomFilterColumns":{
"shape":"ListOfNonEmptyStringsWithoutWhitespace",
"documentation":"<p>The column names for which you want Kinesis Data Firehose to create bloom filters. The default is <code>null</code>.</p>"
},
"BloomFilterFalsePositiveProbability":{
"shape":"Proportion",
"documentation":"<p>The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.</p>"
},
"DictionaryKeyThreshold":{
"shape":"Proportion",
"documentation":"<p>Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.</p>"
},
"FormatVersion":{
"shape":"OrcFormatVersion",
"documentation":"<p>The version of the file to write. The possible values are <code>V0_11</code> and <code>V0_12</code>. The default is <code>V0_12</code>.</p>"
}
},
"documentation":"<p>A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see <a href=\"https://orc.apache.org/docs/\">Apache ORC</a>.</p>"
},
"OrcStripeSizeBytes":{
"type":"integer",
"min":8388608
},
"OutputFormatConfiguration":{
"type":"structure",
"members":{
"Serializer":{
"shape":"Serializer",
"documentation":"<p>Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.</p>"
}
},
"documentation":"<p>Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.</p>"
},
"ParquetCompression":{
"type":"string",
"enum":[
"UNCOMPRESSED",
"GZIP",
"SNAPPY"
]
},
"ParquetPageSizeBytes":{
"type":"integer",
"min":65536
},
"ParquetSerDe":{
"type":"structure",
"members":{
"BlockSizeBytes":{
"shape":"BlockSizeBytes",
"documentation":"<p>The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.</p>"
},
"PageSizeBytes":{
"shape":"ParquetPageSizeBytes",
"documentation":"<p>The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.</p>"
},
"Compression":{
"shape":"ParquetCompression",
"documentation":"<p>The compression code to use over data blocks. The possible values are <code>UNCOMPRESSED</code>, <code>SNAPPY</code>, and <code>GZIP</code>, with the default being <code>SNAPPY</code>. Use <code>SNAPPY</code> for higher decompression speed. Use <code>GZIP</code> if the compression ration is more important than speed.</p>"
},
"EnableDictionaryCompression":{
"shape":"BooleanObject",
"documentation":"<p>Indicates whether to enable dictionary compression.</p>"
},
"MaxPaddingBytes":{
"shape":"NonNegativeIntegerObject",
"documentation":"<p>The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.</p>"
},
"WriterVersion":{
"shape":"ParquetWriterVersion",
"documentation":"<p>Indicates the version of row format to output. The possible values are <code>V1</code> and <code>V2</code>. The default is <code>V1</code>.</p>"
}
},
"documentation":"<p>A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see <a href=\"https://parquet.apache.org/documentation/latest/\">Apache Parquet</a>.</p>"
},
"ParquetWriterVersion":{
"type":"string",
"enum":[
"V1",
"V2"
]
},
"Password":{
"type":"string",
"min":6,
@ -1148,6 +1387,11 @@
"type":"string",
"enum":["Lambda"]
},
"Proportion":{
"type":"double",
"max":1,
"min":0
},
"PutRecordBatchInput":{
"type":"structure",
"required":[
@ -1267,7 +1511,7 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"ClusterJDBCURL":{
"shape":"ClusterJDBCURL",
@ -1324,7 +1568,7 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"ClusterJDBCURL":{
"shape":"ClusterJDBCURL",
@ -1360,7 +1604,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes a destination in Amazon Redshift.</p>"
@ -1370,7 +1614,7 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"ClusterJDBCURL":{
"shape":"ClusterJDBCURL",
@ -1410,7 +1654,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes an update for a destination in Amazon Redshift.</p>"
@ -1481,11 +1725,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"BucketARN":{
"shape":"BucketARN",
"documentation":"<p>The ARN of the S3 bucket.</p>"
"documentation":"<p>The ARN of the S3 bucket. 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>.</p>"
},
"Prefix":{
"shape":"Prefix",
@ -1522,11 +1766,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"BucketARN":{
"shape":"BucketARN",
"documentation":"<p>The ARN of the S3 bucket.</p>"
"documentation":"<p>The ARN of the S3 bucket. 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>.</p>"
},
"Prefix":{
"shape":"Prefix",
@ -1546,7 +1790,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes a destination in Amazon S3.</p>"
@ -1556,11 +1800,11 @@
"members":{
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS credentials. 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>.</p>"
},
"BucketARN":{
"shape":"BucketARN",
"documentation":"<p>The ARN of the S3 bucket.</p>"
"documentation":"<p>The ARN of the S3 bucket. 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>.</p>"
},
"Prefix":{
"shape":"Prefix",
@ -1585,6 +1829,50 @@
},
"documentation":"<p>Describes an update for a destination in Amazon S3.</p>"
},
"SchemaConfiguration":{
"type":"structure",
"members":{
"RoleARN":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.</p>"
},
"CatalogId":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.</p>"
},
"DatabaseName":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>Specifies the name of the AWS Glue database that contains the schema for the output data.</p>"
},
"TableName":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>Specifies the AWS Glue table that contains the column information that constitutes your data schema.</p>"
},
"Region":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>If you don't specify an AWS Region, the default is the current Region.</p>"
},
"VersionId":{
"shape":"NonEmptyStringWithoutWhitespace",
"documentation":"<p>Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to <code>LATEST</code>, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.</p>"
}
},
"documentation":"<p>Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.</p>"
},
"Serializer":{
"type":"structure",
"members":{
"ParquetSerDe":{
"shape":"ParquetSerDe",
"documentation":"<p>A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see <a href=\"https://parquet.apache.org/documentation/latest/\">Apache Parquet</a>.</p>"
},
"OrcSerDe":{
"shape":"OrcSerDe",
"documentation":"<p>A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see <a href=\"https://orc.apache.org/docs/\">Apache ORC</a>.</p>"
}
},
"documentation":"<p>The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the <a href=\"https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html\">ORC SerDe</a> and the <a href=\"https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html\">Parquet SerDe</a>.</p>"
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
@ -1655,7 +1943,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes the configuration of a destination in Splunk.</p>"
@ -1673,7 +1961,7 @@
},
"HECToken":{
"shape":"HECToken",
"documentation":"<p>This is a GUID you obtain from your Splunk cluster when you create a new HEC endpoint.</p>"
"documentation":"<p>A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.</p>"
},
"HECAcknowledgmentTimeoutInSeconds":{
"shape":"HECAcknowledgmentTimeoutInSeconds",
@ -1697,7 +1985,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes a destination in Splunk.</p>"
@ -1739,7 +2027,7 @@
},
"CloudWatchLoggingOptions":{
"shape":"CloudWatchLoggingOptions",
"documentation":"<p>The CloudWatch logging options for your delivery stream.</p>"
"documentation":"<p>The Amazon CloudWatch logging options for your delivery stream.</p>"
}
},
"documentation":"<p>Describes an update for a destination in Splunk.</p>"
@ -1862,7 +2150,7 @@
},
"CurrentDeliveryStreamVersionId":{
"shape":"DeliveryStreamVersionId",
"documentation":"<p>Obtain this value from the <code>VersionId</code> result of <a>DeliveryStreamDescription</a>. This value is required, and it helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"
"documentation":"<p>Obtain this value from the <b>VersionId</b> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"
},
"DestinationId":{
"shape":"DestinationId",

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

File diff suppressed because one or more lines are too long

1
botocore/data/glacier/2012-06-01/service-2.json
View file

@ -6,6 +6,7 @@
"endpointPrefix":"glacier",
"protocol":"rest-json",
"serviceFullName":"Amazon Glacier",
"serviceId":"Glacier",
"signatureVersion":"v4",
"uid":"glacier-2012-06-01"
},

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

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Glue",
"serviceId":"Glue",
"signatureVersion":"v4",
"targetPrefix":"AWSGlue",
"uid":"glue-2017-03-31"
@ -167,7 +168,7 @@
{"shape":"OperationTimeoutException"},
{"shape":"ResourceNumberLimitExceededException"}
],
"documentation":"<p>Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in either the <i>s3Targets</i> or the <i>jdbcTargets</i> field.</p>"
"documentation":"<p>Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the <i>s3Targets</i> field, the <i>jdbcTargets</i> field, or the <i>DynamoDBTargets</i> field.</p>"
},
"CreateDatabase":{
"name":"CreateDatabase",
@ -969,7 +970,7 @@
{"shape":"CrawlerRunningException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, does nothing.</p>"
"documentation":"<p>Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-exceptions.html#aws-glue-api-exceptions-CrawlerRunningException\">CrawlerRunningException</a>.</p>"
},
"StartCrawlerSchedule":{
"name":"StartCrawlerSchedule",
@ -1282,6 +1283,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job run timeout in minutes. It overrides the timeout value of the job.</p>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job run notification.</p>"
}
},
"documentation":"<p>Defines an action to be initiated by a trigger.</p>"
@ -1675,7 +1680,7 @@
"documentation":"<p>A <code>JsonClassifier</code> object.</p>"
}
},
"documentation":"<p>Classifiers are written in Python and triggered during a crawl task. You can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier checks whether a given file is in a format it can handle, and if it is, the classifier creates a schema in the form of a <code>StructType</code> object that matches that data format.</p> <p>A classifier can be a <code>grok</code> classifier, an XML classifier, or a JSON classifier, asspecified in one of the fields in the <code>Classifier</code> object.</p>"
"documentation":"<p>Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle, and if it is, the classifier creates a schema in the form of a <code>StructType</code> object that matches that data format.</p> <p>You can use the standard classifiers that AWS Glue supplies, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a <code>grok</code> classifier, an <code>XML</code> classifier, or a <code>JSON</code> classifier, as specified in one of the fields in the <code>Classifier</code> object.</p>"
},
"ClassifierList":{
"type":"list",
@ -2042,7 +2047,7 @@
},
"Configuration":{
"shape":"CrawlerConfiguration",
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.</p> <p>You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:</p> <p>Example: <code>'{ \"Version\": 1.0, \"CrawlerOutput\": { \"Partitions\": { \"AddOrUpdateBehavior\": \"InheritFromTable\" } } }'</code> </p>"
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html\">Configuring a Crawler</a>.</p>"
}
},
"documentation":"<p>Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.</p>"
@ -2151,6 +2156,10 @@
"JdbcTargets":{
"shape":"JdbcTargetList",
"documentation":"<p>Specifies JDBC targets.</p>"
},
"DynamoDBTargets":{
"shape":"DynamoDBTargetList",
"documentation":"<p>Specifies DynamoDB targets.</p>"
}
},
"documentation":"<p>Specifies data stores to crawl.</p>"
@ -2231,7 +2240,7 @@
},
"Classifiers":{
"shape":"ClassifierNameList",
"documentation":"<p>A list of custom classifiers that the user has registered. By default, all AWS classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.</p>"
"documentation":"<p>A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.</p>"
},
"TablePrefix":{
"shape":"TablePrefix",
@ -2243,7 +2252,7 @@
},
"Configuration":{
"shape":"CrawlerConfiguration",
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.</p> <p>You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:</p> <p>Example: <code>'{ \"Version\": 1.0, \"CrawlerOutput\": { \"Partitions\": { \"AddOrUpdateBehavior\": \"InheritFromTable\" } } }'</code> </p>"
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html\">Configuring a Crawler</a>.</p>"
}
}
},
@ -2451,6 +2460,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job timeout in minutes. The default is 2880 minutes (48 hours).</p>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job notification.</p>"
}
}
},
@ -3094,6 +3107,20 @@
"type":"list",
"member":{"shape":"DevEndpoint"}
},
"DynamoDBTarget":{
"type":"structure",
"members":{
"Path":{
"shape":"Path",
"documentation":"<p>The name of the DynamoDB table to crawl.</p>"
}
},
"documentation":"<p>Specifies a DynamoDB table to crawl.</p>"
},
"DynamoDBTargetList":{
"type":"list",
"member":{"shape":"DynamoDBTarget"}
},
"EntityNotFoundException":{
"type":"structure",
"members":{
@ -3135,6 +3162,7 @@
},
"documentation":"<p>An execution property of a job.</p>"
},
"ExecutionTime":{"type":"integer"},
"FieldType":{"type":"string"},
"FilterString":{
"type":"string",
@ -4196,6 +4224,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job timeout in minutes.</p>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job notification.</p>"
}
},
"documentation":"<p>Specifies a job definition.</p>"
@ -4301,12 +4333,16 @@
"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>"
},
"ExecutionTime":{
"shape":"IntegerValue",
"shape":"ExecutionTime",
"documentation":"<p>The amount of time (in seconds) that the job run consumed resources.</p>"
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job run timeout in minutes.</p>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job run notification.</p>"
}
},
"documentation":"<p>Contains information about a job run.</p>"
@ -4369,6 +4405,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job timeout in minutes. The default is 2880 minutes (48 hours).</p>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job notification.</p>"
}
},
"documentation":"<p>Specifies information used to update an existing job definition. Note that the previous job definition will be completely overwritten by this information.</p>"
@ -4466,6 +4506,10 @@
"S3":{
"shape":"CodeGenNodeArgs",
"documentation":"<p>An Amazon S3 location.</p>"
},
"DynamoDB":{
"shape":"CodeGenNodeArgs",
"documentation":"<p>A DynamoDB Table location.</p>"
}
},
"documentation":"<p>The location of resources.</p>"
@ -4582,6 +4626,21 @@
"type":"integer",
"min":0
},
"NotificationProperty":{
"type":"structure",
"members":{
"NotifyDelayAfter":{
"shape":"NotifyDelayAfter",
"documentation":"<p>After a job run starts, the number of minutes to wait before sending a job run delay notification.</p>"
}
},
"documentation":"<p>Specifies configuration properties of a notification.</p>"
},
"NotifyDelayAfter":{
"type":"integer",
"box":true,
"min":1
},
"OperationTimeoutException":{
"type":"structure",
"members":{
@ -5071,6 +5130,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job run timeout in minutes. It overrides the timeout value of the job.</p>"
},
"NotificationProperty":{
"shape":"NotificationProperty",
"documentation":"<p>Specifies configuration properties of a job run notification.</p>"
}
}
},
@ -5596,7 +5659,7 @@
},
"Classifiers":{
"shape":"ClassifierNameList",
"documentation":"<p>A list of custom classifiers that the user has registered. By default, all classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.</p>"
"documentation":"<p>A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.</p>"
},
"TablePrefix":{
"shape":"TablePrefix",
@ -5608,7 +5671,7 @@
},
"Configuration":{
"shape":"CrawlerConfiguration",
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.</p> <p>You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:</p> <p>Example: <code>'{ \"Version\": 1.0, \"CrawlerOutput\": { \"Partitions\": { \"AddOrUpdateBehavior\": \"InheritFromTable\" } } }'</code> </p>"
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see <a href=\"http://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html\">Configuring a Crawler</a>.</p>"
}
}
},

1
botocore/data/greengrass/2017-06-07/service-2.json
View file

@ -4,6 +4,7 @@
"endpointPrefix" : "greengrass",
"signingName" : "greengrass",
"serviceFullName" : "AWS Greengrass",
"serviceId" : "Greengrass",
"protocol" : "rest-json",
"jsonVersion" : "1.1",
"uid" : "greengrass-2017-06-07",

1
botocore/data/health/2016-08-04/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"AWSHealth",
"serviceFullName":"AWS Health APIs and Notifications",
"serviceId":"Health",
"signatureVersion":"v4",
"targetPrefix":"AWSHealth_20160804",
"uid":"health-2016-08-04"

1
botocore/data/importexport/2010-06-01/service-2.json
View file

@ -6,6 +6,7 @@
"endpointPrefix":"importexport",
"globalEndpoint":"importexport.amazonaws.com",
"serviceFullName":"AWS Import/Export",
"serviceId":"ImportExport",
"signatureVersion":"v2",
"xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/",
"protocol":"query"

345
botocore/data/inspector/2016-02-16/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Inspector",
"serviceId":"Inspector",
"signatureVersion":"v4",
"targetPrefix":"InspectorService",
"uid":"inspector-2016-02-16"
@ -40,7 +41,8 @@
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"InvalidCrossAccountRoleException"}
],
"documentation":"<p>Creates a new assessment target using the ARN of the resource group that is generated by <a>CreateResourceGroup</a>. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isn’t already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html\"> Amazon Inspector Assessment Targets</a>.</p>"
},
@ -61,6 +63,23 @@
],
"documentation":"<p>Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isn’t already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.</p>"
},
"CreateExclusionsPreview":{
"name":"CreateExclusionsPreview",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateExclusionsPreviewRequest"},
"output":{"shape":"CreateExclusionsPreviewResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"PreviewGenerationInProgressException"},
{"shape":"InternalException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
],
"documentation":"<p>Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment. </p>"
},
"CreateResourceGroup":{
"name":"CreateResourceGroup",
"http":{
@ -179,6 +198,20 @@
],
"documentation":"<p>Describes the IAM role that enables Amazon Inspector to access your AWS account.</p>"
},
"DescribeExclusions":{
"name":"DescribeExclusions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeExclusionsRequest"},
"output":{"shape":"DescribeExclusionsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Describes the exclusions that are specified by the exclusions' ARNs.</p>"
},
"DescribeFindings":{
"name":"DescribeFindings",
"http":{
@ -239,6 +272,22 @@
],
"documentation":"<p>Produces an assessment report that includes detailed and comprehensive results of a specified assessment run. </p>"
},
"GetExclusionsPreview":{
"name":"GetExclusionsPreview",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetExclusionsPreviewRequest"},
"output":{"shape":"GetExclusionsPreviewResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"InternalException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
],
"documentation":"<p>Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.</p>"
},
"GetTelemetryMetadata":{
"name":"GetTelemetryMetadata",
"http":{
@ -334,6 +383,22 @@
],
"documentation":"<p>Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see <a>SubscribeToEvent</a> and <a>UnsubscribeFromEvent</a>.</p>"
},
"ListExclusions":{
"name":"ListExclusions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListExclusionsRequest"},
"output":{"shape":"ListExclusionsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
],
"documentation":"<p>List exclusions that are generated by the assessment run.</p>"
},
"ListFindings":{
"name":"ListFindings",
"http":{
@ -1097,7 +1162,6 @@
"required":[
"arn",
"name",
"resourceGroupArn",
"createdAt",
"updatedAt"
],
@ -1173,7 +1237,7 @@
},
"durationInSeconds":{
"shape":"AssessmentRunDuration",
"documentation":"<p>The duration in seconds specified for this assessment tempate. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).</p>"
"documentation":"<p>The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).</p>"
},
"rulesPackageArns":{
"shape":"AssessmentTemplateRulesPackageArnList",
@ -1185,7 +1249,7 @@
},
"lastAssessmentRunArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greater than zero.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero.</p>"
},
"assessmentRunCount":{
"shape":"ArnCount",
@ -1316,13 +1380,16 @@
"max":10,
"min":1
},
"BatchDescribeExclusionsArnList":{
"type":"list",
"member":{"shape":"Arn"},
"max":100,
"min":1
},
"Bool":{"type":"boolean"},
"CreateAssessmentTargetRequest":{
"type":"structure",
"required":[
"assessmentTargetName",
"resourceGroupArn"
],
"required":["assessmentTargetName"],
"members":{
"assessmentTargetName":{
"shape":"AssessmentTargetName",
@ -1385,6 +1452,26 @@
}
}
},
"CreateExclusionsPreviewRequest":{
"type":"structure",
"required":["assessmentTemplateArn"],
"members":{
"assessmentTemplateArn":{
"shape":"Arn",
"documentation":"<p>The ARN that specifies the assessment template for which you want to create an exclusions preview.</p>"
}
}
},
"CreateExclusionsPreviewResponse":{
"type":"structure",
"required":["previewToken"],
"members":{
"previewToken":{
"shape":"UUID",
"documentation":"<p>Specifies the unique identifier of the requested exclusions preview. You can use the unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview API.</p>"
}
}
},
"CreateResourceGroupRequest":{
"type":"structure",
"required":["resourceGroupTags"],
@ -1535,6 +1622,37 @@
}
}
},
"DescribeExclusionsRequest":{
"type":"structure",
"required":["exclusionArns"],
"members":{
"exclusionArns":{
"shape":"BatchDescribeExclusionsArnList",
"documentation":"<p>The list of ARNs that specify the exclusions that you want to describe.</p>"
},
"locale":{
"shape":"Locale",
"documentation":"<p>The locale into which you want to translate the exclusion's title, description, and recommendation.</p>"
}
}
},
"DescribeExclusionsResponse":{
"type":"structure",
"required":[
"exclusions",
"failedItems"
],
"members":{
"exclusions":{
"shape":"ExclusionMap",
"documentation":"<p>Information about the exclusions.</p>"
},
"failedItems":{
"shape":"FailedItems",
"documentation":"<p>Exclusion details that cannot be described. An error code is provided for each failed item.</p>"
}
}
},
"DescribeFindingsRequest":{
"type":"structure",
"required":["findingArns"],
@ -1667,6 +1785,88 @@
"max":50,
"min":1
},
"Exclusion":{
"type":"structure",
"required":[
"arn",
"title",
"description",
"recommendation",
"scopes"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The ARN that specifies the exclusion.</p>"
},
"title":{
"shape":"Text",
"documentation":"<p>The name of the exclusion.</p>"
},
"description":{
"shape":"Text",
"documentation":"<p>The description of the exclusion.</p>"
},
"recommendation":{
"shape":"Text",
"documentation":"<p>The recommendation for the exclusion.</p>"
},
"scopes":{
"shape":"ScopeList",
"documentation":"<p>The AWS resources for which the exclusion pertains.</p>"
},
"attributes":{
"shape":"AttributeList",
"documentation":"<p>The system-defined attributes for the exclusion.</p>"
}
},
"documentation":"<p>Contains information about what was excluded from an assessment run.</p>"
},
"ExclusionMap":{
"type":"map",
"key":{"shape":"Arn"},
"value":{"shape":"Exclusion"},
"max":100,
"min":1
},
"ExclusionPreview":{
"type":"structure",
"required":[
"title",
"description",
"recommendation",
"scopes"
],
"members":{
"title":{
"shape":"Text",
"documentation":"<p>The name of the exclusion preview.</p>"
},
"description":{
"shape":"Text",
"documentation":"<p>The description of the exclusion preview.</p>"
},
"recommendation":{
"shape":"Text",
"documentation":"<p>The recommendation for the exclusion preview.</p>"
},
"scopes":{
"shape":"ScopeList",
"documentation":"<p>The AWS resources for which the exclusion preview pertains.</p>"
},
"attributes":{
"shape":"AttributeList",
"documentation":"<p>The system-defined attributes for the exclusion preview.</p>"
}
},
"documentation":"<p>Contains information about what is excluded from an assessment run given the current state of the assessment template.</p>"
},
"ExclusionPreviewList":{
"type":"list",
"member":{"shape":"ExclusionPreview"},
"max":100,
"min":0
},
"FailedItemDetails":{
"type":"structure",
"required":[
@ -1878,6 +2078,53 @@
}
}
},
"GetExclusionsPreviewRequest":{
"type":"structure",
"required":[
"assessmentTemplateArn",
"previewToken"
],
"members":{
"assessmentTemplateArn":{
"shape":"Arn",
"documentation":"<p>The ARN that specifies the assessment template for which the exclusions preview was requested.</p>"
},
"previewToken":{
"shape":"UUID",
"documentation":"<p>The unique identifier associated of the exclusions preview.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.</p>"
},
"maxResults":{
"shape":"ListMaxResults",
"documentation":"<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.</p>"
},
"locale":{
"shape":"Locale",
"documentation":"<p>The locale into which you want to translate the exclusion's title, description, and recommendation.</p>"
}
}
},
"GetExclusionsPreviewResponse":{
"type":"structure",
"required":["previewStatus"],
"members":{
"previewStatus":{
"shape":"PreviewStatus",
"documentation":"<p>Specifies the status of the request to generate an exclusions preview.</p>"
},
"exclusionPreviews":{
"shape":"ExclusionPreviewList",
"documentation":"<p>Information about the exclusions included in the preview.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.</p>"
}
}
},
"GetTelemetryMetadataRequest":{
"type":"structure",
"required":["assessmentRunArn"],
@ -2290,6 +2537,38 @@
}
}
},
"ListExclusionsRequest":{
"type":"structure",
"required":["assessmentRunArn"],
"members":{
"assessmentRunArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the assessment run that generated the exclusions that you want to list.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.</p>"
},
"maxResults":{
"shape":"ListMaxResults",
"documentation":"<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.</p>"
}
}
},
"ListExclusionsResponse":{
"type":"structure",
"required":["exclusionArns"],
"members":{
"exclusionArns":{
"shape":"ListReturnedArnList",
"documentation":"<p>A list of exclusions' ARNs returned by the action.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.</p>"
}
}
},
"ListFindingsRequest":{
"type":"structure",
"members":{
@ -2494,6 +2773,22 @@
}
}
},
"PreviewGenerationInProgressException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request is rejected. The specified assessment template is currently generating an exclusions preview.</p>",
"exception":true
},
"PreviewStatus":{
"type":"string",
"enum":[
"WORK_IN_PROGRESS",
"COMPLETED"
]
},
"ProviderName":{
"type":"string",
"max":1000,
@ -2661,6 +2956,33 @@
"max":1000,
"min":0
},
"Scope":{
"type":"structure",
"members":{
"key":{
"shape":"ScopeType",
"documentation":"<p>The type of the scope.</p>"
},
"value":{
"shape":"ScopeValue",
"documentation":"<p>The resource identifier for the specified scope type.</p>"
}
},
"documentation":"<p>This data type contains key-value pairs that identify various Amazon resources.</p>"
},
"ScopeList":{
"type":"list",
"member":{"shape":"Scope"},
"min":1
},
"ScopeType":{
"type":"string",
"enum":[
"INSTANCE_ID",
"RULES_PACKAGE_ARN"
]
},
"ScopeValue":{"type":"string"},
"ServiceName":{
"type":"string",
"max":128,
@ -2871,6 +3193,10 @@
},
"documentation":"<p>This data type is used in the <a>AssessmentRunFilter</a> data type.</p>"
},
"UUID":{
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"UnsubscribeFromEventRequest":{
"type":"structure",
"required":[
@ -2910,8 +3236,7 @@
"type":"structure",
"required":[
"assessmentTargetArn",
"assessmentTargetName",
"resourceGroupArn"
"assessmentTargetName"
],
"members":{
"assessmentTargetArn":{

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

@ -6,6 +6,7 @@
"endpointPrefix":"data.iot",
"protocol":"rest-json",
"serviceFullName":"AWS IoT Data Plane",
"serviceId":"IoT Data Plane",
"signatureVersion":"v4",
"signingName":"iotdata"
},

1
botocore/data/iot-jobs-data/2017-09-29/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"data.jobs.iot",
"protocol":"rest-json",
"serviceFullName":"AWS IoT Jobs Data Plane",
"serviceId":"IoT Jobs Data Plane",
"signatureVersion":"v4",
"signingName":"iot-jobs-data",
"uid":"iot-jobs-data-2017-09-29"

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

@ -151,6 +151,23 @@
],
"documentation":"<p>Cancels a job.</p>"
},
"CancelJobExecution":{
"name":"CancelJobExecution",
"http":{
"method":"PUT",
"requestUri":"/things/{thingName}/jobs/{jobId}/cancel"
},
"input":{"shape":"CancelJobExecutionRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidStateTransitionException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ServiceUnavailableException"},
{"shape":"VersionConflictException"}
],
"documentation":"<p>Cancels the execution of a job for a given thing.</p>"
},
"ClearDefaultAuthorizer":{
"name":"ClearDefaultAuthorizer",
"http":{
@ -462,6 +479,39 @@
],
"documentation":"<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status.</p>"
},
"DeleteJob":{
"name":"DeleteJob",
"http":{
"method":"DELETE",
"requestUri":"/jobs/{jobId}"
},
"input":{"shape":"DeleteJobRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidStateTransitionException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes a job and its related job executions.</p> <p>Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as \"DELETION_IN_PROGRESS\". Attempting to delete or cancel a job whose status is already \"DELETION_IN_PROGRESS\" will result in an error.</p> <p>Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, or a LimitExceededException will occur.</p>"
},
"DeleteJobExecution":{
"name":"DeleteJobExecution",
"http":{
"method":"DELETE",
"requestUri":"/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}"
},
"input":{"shape":"DeleteJobExecutionRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidStateTransitionException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Deletes a job execution.</p>"
},
"DeleteOTAUpdate":{
"name":"DeleteOTAUpdate",
"http":{
@ -1028,7 +1078,7 @@
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Gets effective policies.</p>"
"documentation":"<p>Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.</p>"
},
"GetIndexingConfiguration":{
"name":"GetIndexingConfiguration",
@ -1930,7 +1980,7 @@
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Test custom authorization.</p>"
"documentation":"<p>Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.</p>"
},
"TestInvokeAuthorizer":{
"name":"TestInvokeAuthorizer",
@ -1949,7 +1999,7 @@
{"shape":"InternalFailureException"},
{"shape":"InvalidResponseException"}
],
"documentation":"<p>Invoke the specified custom authorizer for testing purposes.</p>"
"documentation":"<p>Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.</p>"
},
"TransferCertificate":{
"name":"TransferCertificate",
@ -2668,6 +2718,41 @@
},
"documentation":"<p>The input for the CancelCertificateTransfer operation.</p>"
},
"CancelJobExecutionRequest":{
"type":"structure",
"required":[
"jobId",
"thingName"
],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The ID of the job to be canceled.</p>",
"location":"uri",
"locationName":"jobId"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing whose execution of the job will be canceled.</p>",
"location":"uri",
"locationName":"thingName"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(Optional) If <code>true</code> the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set <code>force</code> to <code>true</code>, then an <code>InvalidStateTransitionException</code> will be thrown. The default is <code>false</code>.</p> <p>Canceling a job execution which is \"IN_PROGRESS\", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.</p>",
"location":"querystring",
"locationName":"force"
},
"expectedVersion":{
"shape":"ExpectedVersion",
"documentation":"<p>(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)</p>"
},
"statusDetails":{
"shape":"DetailsMap",
"documentation":"<p>A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.</p>"
}
}
},
"CancelJobRequest":{
"type":"structure",
"required":["jobId"],
@ -2681,6 +2766,12 @@
"comment":{
"shape":"Comment",
"documentation":"<p>An optional comment string describing why the job was canceled.</p>"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(Optional) If <code>true</code> job executions with status \"IN_PROGRESS\" and \"QUEUED\" are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default is <code>false</code>.</p> <p>Canceling a job which is \"IN_PROGRESS\", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>",
"location":"querystring",
"locationName":"force"
}
}
},
@ -3663,6 +3754,58 @@
"error":{"httpStatusCode":409},
"exception":true
},
"DeleteJobExecutionRequest":{
"type":"structure",
"required":[
"jobId",
"thingName",
"executionNumber"
],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The ID of the job whose execution on a particular device will be deleted.</p>",
"location":"uri",
"locationName":"jobId"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing whose job execution will be deleted.</p>",
"location":"uri",
"locationName":"thingName"
},
"executionNumber":{
"shape":"ExecutionNumber",
"documentation":"<p>The ID of the job execution to be deleted. The <code>executionNumber</code> refers to the execution of a particular job on a particular device.</p> <p>Note that once a job execution is deleted, the <code>executionNumber</code> may be reused by IoT, so be sure you get and use the correct value here.</p>",
"location":"uri",
"locationName":"executionNumber"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". Otherwise, you can only delete a job execution which is in a terminal state (\"SUCCEEDED\", \"FAILED\", \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The default is false.</p> <note> <p>Deleting a job execution which is \"IN_PROGRESS\", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.</p> </note>",
"location":"querystring",
"locationName":"force"
}
}
},
"DeleteJobRequest":{
"type":"structure",
"required":["jobId"],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The ID of the job to be deleted.</p> <p>After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.</p>",
"location":"uri",
"locationName":"jobId"
},
"force":{
"shape":"ForceFlag",
"documentation":"<p>(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default is false.</p> <note> <p>Deleting a job which is \"IN_PROGRESS\", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.</p> </note>",
"location":"querystring",
"locationName":"force"
}
}
},
"DeleteOTAUpdateRequest":{
"type":"structure",
"required":["otaUpdateId"],
@ -4644,6 +4787,7 @@
]
},
"ExecutionNumber":{"type":"long"},
"ExpectedVersion":{"type":"long"},
"ExpiresInSec":{
"type":"long",
"max":3600,
@ -4694,6 +4838,8 @@
},
"Flag":{"type":"boolean"},
"ForceDelete":{"type":"boolean"},
"ForceFlag":{"type":"boolean"},
"Forced":{"type":"boolean"},
"FunctionArn":{"type":"string"},
"GEMaxResults":{
"type":"integer",
@ -5090,6 +5236,15 @@
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidStateTransitionException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
},
"documentation":"<p>An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is \"IN_PROGRESS\" without setting the <code>force</code> parameter.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"IotAnalyticsAction":{
"type":"structure",
"members":{
@ -5103,10 +5258,10 @@
},
"roleArn":{
"shape":"AwsArn",
"documentation":"<p>The ARN of the role which has a policy that grants IoT permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</p>"
"documentation":"<p>The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).</p>"
}
},
"documentation":"<p>Sends message data to an AWS IoT Analytics channel.</p>"
"documentation":"<p>Sends messge data to an AWS IoT Analytics channel.</p>"
},
"IsAuthenticated":{"type":"boolean"},
"IsDefaultVersion":{"type":"boolean"},
@ -5130,6 +5285,10 @@
"shape":"JobStatus",
"documentation":"<p>The status of the job, one of <code>IN_PROGRESS</code>, <code>CANCELED</code>, or <code>COMPLETED</code>. </p>"
},
"forceCanceled":{
"shape":"Forced",
"documentation":"<p>Will be <code>true</code> if the job was canceled with the optional <code>force</code> parameter set to <code>true</code>.</p>"
},
"comment":{
"shape":"Comment",
"documentation":"<p>If the job was updated, describes the reason for the update.</p>"
@ -5205,6 +5364,10 @@
"shape":"JobExecutionStatus",
"documentation":"<p>The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).</p>"
},
"forceCanceled":{
"shape":"Forced",
"documentation":"<p>Will be <code>true</code> if the job execution was canceled with the optional <code>force</code> parameter set to <code>true</code>.</p>"
},
"statusDetails":{
"shape":"JobExecutionStatusDetails",
"documentation":"<p>A collection of name/value pairs that describe the status of the job execution.</p>"
@ -5228,6 +5391,10 @@
"executionNumber":{
"shape":"ExecutionNumber",
"documentation":"<p>A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information. </p>"
},
"versionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version of the job execution. Job execution versions are incremented each time they are updated by a device.</p>"
}
},
"documentation":"<p>The job execution object represents the execution of a job on a particular device.</p>"
@ -5337,7 +5504,7 @@
"members":{
"processingTargets":{
"shape":"ProcessingTargetNameList",
"documentation":"<p>The devices on which the job is executing.</p>"
"documentation":"<p>The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.</p>"
},
"numberOfCanceledThings":{
"shape":"CanceledThings",
@ -5375,7 +5542,8 @@
"enum":[
"IN_PROGRESS",
"CANCELED",
"COMPLETED"
"COMPLETED",
"DELETION_IN_PROGRESS"
]
},
"JobSummary":{
@ -5498,7 +5666,7 @@
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>The number of attached entities exceeds the limit.</p>",
"documentation":"<p>A limit has been exceeded.</p>",
"error":{"httpStatusCode":410},
"exception":true
},
@ -7751,7 +7919,7 @@
},
"messageFormat":{
"shape":"MessageFormat",
"documentation":"<p>The message format of the message to publish. Optional. 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=\"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>Describes an action to publish to an Amazon SNS topic.</p>"
@ -8847,10 +9015,11 @@
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.</p>",
"documentation":"<p>An exception thrown when the version of an entity specified with the <code>expectedVersion</code> parameter does not match the latest version in the system.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"VersionNumber":{"type":"long"},
"VersionsLimitExceededException":{
"type":"structure",
"members":{

889
botocore/data/iot1click-devices/2018-05-14/service-2.json Normal file
View file

@ -0,0 +1,889 @@
{
"metadata" : {
"apiVersion" : "2018-05-14",
"endpointPrefix" : "devices.iot1click",
"signingName" : "iot1click",
"serviceFullName" : "AWS IoT 1-Click Devices Service",
"serviceId" : "IoT 1Click Devices Service",
"protocol" : "rest-json",
"jsonVersion" : "1.1",
"uid" : "devices-2018-05-14",
"signatureVersion" : "v4"
},
"operations" : {
"ClaimDevicesByClaimCode" : {
"name" : "ClaimDevicesByClaimCode",
"http" : {
"method" : "PUT",
"requestUri" : "/claims/{claimCode}",
"responseCode" : 200
},
"input" : {
"shape" : "ClaimDevicesByClaimCodeRequest"
},
"output" : {
"shape" : "ClaimDevicesByClaimCodeResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
}, {
"shape" : "ForbiddenException",
"documentation" : "<p>403 response</p>"
} ],
"documentation" : "<p>Adds device(s) to your account (i.e., claim one or more devices) if and only if\n you received a claim code with the device(s).</p>"
},
"DescribeDevice" : {
"name" : "DescribeDevice",
"http" : {
"method" : "GET",
"requestUri" : "/devices/{deviceId}",
"responseCode" : 200
},
"input" : {
"shape" : "DescribeDeviceRequest"
},
"output" : {
"shape" : "DescribeDeviceResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
} ],
"documentation" : "<p>Given a device ID, returns a DescribeDeviceResponse object describing\n the details of the device.</p>"
},
"FinalizeDeviceClaim" : {
"name" : "FinalizeDeviceClaim",
"http" : {
"method" : "PUT",
"requestUri" : "/devices/{deviceId}/finalize-claim",
"responseCode" : 200
},
"input" : {
"shape" : "FinalizeDeviceClaimRequest"
},
"output" : {
"shape" : "FinalizeDeviceClaimResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
}, {
"shape" : "PreconditionFailedException",
"documentation" : "<p>412 response</p>"
}, {
"shape" : "ResourceConflictException",
"documentation" : "<p>409 response</p>"
} ],
"documentation" : "<p>Given a device ID, finalizes the claim request for the associated device.</p><note>\n <p>Claiming a device consists of initiating a claim, then publishing a device\n event, and finalizing the claim. For a device of type button, a\n device event can be published by simply clicking the device.</p>\n </note>"
},
"GetDeviceMethods" : {
"name" : "GetDeviceMethods",
"http" : {
"method" : "GET",
"requestUri" : "/devices/{deviceId}/methods",
"responseCode" : 200
},
"input" : {
"shape" : "GetDeviceMethodsRequest"
},
"output" : {
"shape" : "GetDeviceMethodsResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
} ],
"documentation" : "<p>Given a device ID, returns the invokable methods associated with the\n device.</p>"
},
"InitiateDeviceClaim" : {
"name" : "InitiateDeviceClaim",
"http" : {
"method" : "PUT",
"requestUri" : "/devices/{deviceId}/initiate-claim",
"responseCode" : 200
},
"input" : {
"shape" : "InitiateDeviceClaimRequest"
},
"output" : {
"shape" : "InitiateDeviceClaimResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
}, {
"shape" : "ResourceConflictException",
"documentation" : "<p>409 response</p>"
} ],
"documentation" : "<p>Given a device ID, initiates a claim request for the associated device.</p><note>\n <p>Claiming a device consists of initiating a claim, then publishing a device\n event, and finalizing the claim. For a device of type button, a\n device event can be published by simply clicking the device.</p>\n </note>"
},
"InvokeDeviceMethod" : {
"name" : "InvokeDeviceMethod",
"http" : {
"method" : "POST",
"requestUri" : "/devices/{deviceId}/methods",
"responseCode" : 200
},
"input" : {
"shape" : "InvokeDeviceMethodRequest"
},
"output" : {
"shape" : "InvokeDeviceMethodResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "PreconditionFailedException",
"documentation" : "<p>412 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
}, {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "RangeNotSatisfiableException",
"documentation" : "<p>416 response</p>"
}, {
"shape" : "ResourceConflictException",
"documentation" : "<p>409 response</p>"
} ],
"documentation" : "<p>Given a device ID, issues a request to invoke a named device method (with possible\n parameters). See the \"Example POST\" code snippet below.</p>"
},
"ListDeviceEvents" : {
"name" : "ListDeviceEvents",
"http" : {
"method" : "GET",
"requestUri" : "/devices/{deviceId}/events",
"responseCode" : 200
},
"input" : {
"shape" : "ListDeviceEventsRequest"
},
"output" : {
"shape" : "ListDeviceEventsResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "RangeNotSatisfiableException",
"documentation" : "<p>416 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
} ],
"documentation" : "<p>Using a device ID, returns a DeviceEventsResponse object containing\n an array of events for the device.</p>"
},
"ListDevices" : {
"name" : "ListDevices",
"http" : {
"method" : "GET",
"requestUri" : "/devices",
"responseCode" : 200
},
"input" : {
"shape" : "ListDevicesRequest"
},
"output" : {
"shape" : "ListDevicesResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "RangeNotSatisfiableException",
"documentation" : "<p>416 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
} ],
"documentation" : "<p>Lists the 1-Click compatible devices associated with your AWS account.</p>"
},
"UnclaimDevice" : {
"name" : "UnclaimDevice",
"http" : {
"method" : "PUT",
"requestUri" : "/devices/{deviceId}/unclaim",
"responseCode" : 200
},
"input" : {
"shape" : "UnclaimDeviceRequest"
},
"output" : {
"shape" : "UnclaimDeviceResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
} ],
"documentation" : "<p>Disassociates a device from your AWS account using its device ID.</p>"
},
"UpdateDeviceState" : {
"name" : "UpdateDeviceState",
"http" : {
"method" : "PUT",
"requestUri" : "/devices/{deviceId}/state",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateDeviceStateRequest"
},
"output" : {
"shape" : "UpdateDeviceStateResponse",
"documentation" : "<p>200 response</p>"
},
"errors" : [ {
"shape" : "ResourceNotFoundException",
"documentation" : "<p>404 response</p>"
}, {
"shape" : "InvalidRequestException",
"documentation" : "<p>400 response</p>"
}, {
"shape" : "InternalFailureException",
"documentation" : "<p>500 response</p>"
} ],
"documentation" : "<p>Using a Boolean value (true or false), this operation\n enables or disables the device given a device ID.</p>"
}
},
"shapes" : {
"Attributes" : {
"type" : "structure",
"members" : { }
},
"ClaimDevicesByClaimCodeRequest" : {
"type" : "structure",
"members" : {
"ClaimCode" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "claimCode",
"documentation" : "<p>The claim code, starting with \"C-\", as provided by the device manufacturer.</p>"
}
},
"required" : [ "ClaimCode" ]
},
"ClaimDevicesByClaimCodeResponse" : {
"type" : "structure",
"members" : {
"ClaimCode" : {
"shape" : "__stringMin12Max40",
"locationName" : "claimCode",
"documentation" : "<p>The claim code provided by the device manufacturer.</p>"
},
"Total" : {
"shape" : "__integer",
"locationName" : "total",
"documentation" : "<p>The total number of devices associated with the claim code that has been processed\n in the claim request.</p>"
}
}
},
"DescribeDeviceRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
}
},
"required" : [ "DeviceId" ]
},
"DescribeDeviceResponse" : {
"type" : "structure",
"members" : {
"DeviceDescription" : {
"shape" : "DeviceDescription",
"locationName" : "deviceDescription",
"documentation" : "<p>Device details.</p>"
}
}
},
"Device" : {
"type" : "structure",
"members" : {
"Attributes" : {
"shape" : "Attributes",
"locationName" : "attributes",
"documentation" : "<p>The user specified attributes associated with the device for an event.</p>"
},
"DeviceId" : {
"shape" : "__string",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
},
"Type" : {
"shape" : "__string",
"locationName" : "type",
"documentation" : "<p>The device type, such as \"button\".</p>"
}
}
},
"DeviceAttributes" : {
"type" : "map",
"documentation" : "<p>\n DeviceAttributes is a string-to-string map specified by the user.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__string"
}
},
"DeviceClaimResponse" : {
"type" : "structure",
"members" : {
"State" : {
"shape" : "__string",
"locationName" : "state",
"documentation" : "<p>The device's final claim state.</p>"
}
}
},
"DeviceDescription" : {
"type" : "structure",
"members" : {
"Attributes" : {
"shape" : "DeviceAttributes",
"locationName" : "attributes",
"documentation" : "<p>An array of zero or more elements of DeviceAttribute objects\n providing user specified device attributes.</p>"
},
"DeviceId" : {
"shape" : "__string",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
},
"Enabled" : {
"shape" : "__boolean",
"locationName" : "enabled",
"documentation" : "<p>A Boolean value indicating whether or not the device is enabled.</p>"
},
"RemainingLife" : {
"shape" : "__doubleMin0Max100",
"locationName" : "remainingLife",
"documentation" : "<p>A value between 0 and 1 inclusive, representing the fraction of life remaining for\n the device.</p>"
},
"Type" : {
"shape" : "__string",
"locationName" : "type",
"documentation" : "<p>The type of the device, such as \"button\".</p>"
}
}
},
"DeviceEvent" : {
"type" : "structure",
"members" : {
"Device" : {
"shape" : "Device",
"locationName" : "device",
"documentation" : "<p>An object representing the device associated with the event.</p>"
},
"StdEvent" : {
"shape" : "__string",
"locationName" : "stdEvent",
"documentation" : "<p>A serialized JSON object representing the device-type specific event.</p>"
}
}
},
"DeviceEventsResponse" : {
"type" : "structure",
"members" : {
"Events" : {
"shape" : "__listOfDeviceEvent",
"locationName" : "events",
"documentation" : "<p>An array of zero or more elements describing the event(s) associated with the\n device.</p>"
},
"NextToken" : {
"shape" : "__string",
"locationName" : "nextToken",
"documentation" : "<p>The token to retrieve the next set of results.</p>"
}
}
},
"DeviceMethod" : {
"type" : "structure",
"members" : {
"DeviceType" : {
"shape" : "__string",
"locationName" : "deviceType",
"documentation" : "<p>The type of the device, such as \"button\".</p>"
},
"MethodName" : {
"shape" : "__string",
"locationName" : "methodName",
"documentation" : "<p>The name of the method applicable to the deviceType.</p>"
}
}
},
"Empty" : {
"type" : "structure",
"members" : { },
"documentation" : "<p>On success, an empty object is returned.</p>"
},
"FinalizeDeviceClaimRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
}
},
"required" : [ "DeviceId" ]
},
"FinalizeDeviceClaimResponse" : {
"type" : "structure",
"members" : {
"State" : {
"shape" : "__string",
"locationName" : "state",
"documentation" : "<p>The device's final claim state.</p>"
}
}
},
"ForbiddenException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>403</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>The 403 error message returned by the web server.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 403
}
},
"GetDeviceMethodsRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
}
},
"required" : [ "DeviceId" ]
},
"GetDeviceMethodsResponse" : {
"type" : "structure",
"members" : {
"DeviceMethods" : {
"shape" : "__listOfDeviceMethod",
"locationName" : "deviceMethods",
"documentation" : "<p>List of available device APIs.</p>"
}
}
},
"InitiateDeviceClaimRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
}
},
"required" : [ "DeviceId" ]
},
"InitiateDeviceClaimResponse" : {
"type" : "structure",
"members" : {
"State" : {
"shape" : "__string",
"locationName" : "state",
"documentation" : "<p>The device's final claim state.</p>"
}
}
},
"InternalFailureException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>500</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>The 500 error message returned by the web server.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 500
}
},
"InvalidRequestException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>400</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>The 400 error message returned by the web server.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 400
}
},
"InvokeDeviceMethodRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
},
"DeviceMethod" : {
"shape" : "DeviceMethod",
"locationName" : "deviceMethod",
"documentation" : "<p>The device method to invoke.</p>"
},
"DeviceMethodParameters" : {
"shape" : "__string",
"locationName" : "deviceMethodParameters",
"documentation" : "<p>A JSON encoded string containing the device method request parameters.</p>"
}
},
"required" : [ "DeviceId" ]
},
"InvokeDeviceMethodResponse" : {
"type" : "structure",
"members" : {
"DeviceMethodResponse" : {
"shape" : "__string",
"locationName" : "deviceMethodResponse",
"documentation" : "<p>A JSON encoded string containing the device method response.</p>"
}
}
},
"ListDeviceEventsRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
},
"FromTimeStamp" : {
"shape" : "__timestampIso8601",
"location" : "querystring",
"locationName" : "fromTimeStamp",
"documentation" : "<p>The start date for the device event query, in ISO8061 format. For example,\n 2018-03-28T15:45:12.880Z\n </p>"
},
"MaxResults" : {
"shape" : "MaxResults",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of results to return per request. If not set, a default value\n of 100 is used.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The token to retrieve the next set of results.</p>"
},
"ToTimeStamp" : {
"shape" : "__timestampIso8601",
"location" : "querystring",
"locationName" : "toTimeStamp",
"documentation" : "<p>The end date for the device event query, in ISO8061 format. For example,\n 2018-03-28T15:45:12.880Z\n </p>"
}
},
"required" : [ "DeviceId", "FromTimeStamp", "ToTimeStamp" ]
},
"ListDeviceEventsResponse" : {
"type" : "structure",
"members" : {
"Events" : {
"shape" : "__listOfDeviceEvent",
"locationName" : "events",
"documentation" : "<p>An array of zero or more elements describing the event(s) associated with the\n device.</p>"
},
"NextToken" : {
"shape" : "__string",
"locationName" : "nextToken",
"documentation" : "<p>The token to retrieve the next set of results.</p>"
}
}
},
"ListDevicesRequest" : {
"type" : "structure",
"members" : {
"DeviceType" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "deviceType",
"documentation" : "<p>The type of the device, such as \"button\".</p>"
},
"MaxResults" : {
"shape" : "MaxResults",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of results to return per request. If not set, a default value\n of 100 is used.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The token to retrieve the next set of results.</p>"
}
}
},
"ListDevicesResponse" : {
"type" : "structure",
"members" : {
"Devices" : {
"shape" : "__listOfDeviceDescription",
"locationName" : "devices",
"documentation" : "<p>A list of devices.</p>"
},
"NextToken" : {
"shape" : "__string",
"locationName" : "nextToken",
"documentation" : "<p>The token to retrieve the next set of results.</p>"
}
}
},
"MaxResults" : {
"type" : "integer",
"min" : 1,
"max" : 250
},
"PreconditionFailedException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>412</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>An error message explaining the error or its remedy.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 412
}
},
"RangeNotSatisfiableException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>416</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>The requested number of results specified by nextToken cannot be\n satisfied.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 416
}
},
"ResourceConflictException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>409</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>An error message explaining the error or its remedy.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 409
}
},
"ResourceNotFoundException" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code",
"documentation" : "<p>404</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>The requested device could not be found.</p>"
}
},
"exception" : true,
"error" : {
"httpStatusCode" : 404
}
},
"UnclaimDeviceRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
}
},
"required" : [ "DeviceId" ]
},
"UnclaimDeviceResponse" : {
"type" : "structure",
"members" : {
"State" : {
"shape" : "__string",
"locationName" : "state",
"documentation" : "<p>The device's final claim state.</p>"
}
}
},
"UpdateDeviceStateRequest" : {
"type" : "structure",
"members" : {
"DeviceId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deviceId",
"documentation" : "<p>The unique identifier of the device.</p>"
},
"Enabled" : {
"shape" : "__boolean",
"locationName" : "enabled",
"documentation" : "<p>If true, the device is enabled. If false, the device is\n disabled.</p>"
}
},
"required" : [ "DeviceId" ]
},
"UpdateDeviceStateResponse" : {
"type" : "structure",
"members" : { }
},
"__boolean" : {
"type" : "boolean"
},
"__double" : {
"type" : "double"
},
"__doubleMin0Max100" : {
"type" : "double"
},
"__integer" : {
"type" : "integer"
},
"__listOfDeviceDescription" : {
"type" : "list",
"member" : {
"shape" : "DeviceDescription"
}
},
"__listOfDeviceEvent" : {
"type" : "list",
"member" : {
"shape" : "DeviceEvent"
}
},
"__listOfDeviceMethod" : {
"type" : "list",
"member" : {
"shape" : "DeviceMethod"
}
},
"__long" : {
"type" : "long"
},
"__string" : {
"type" : "string"
},
"__stringMin12Max40" : {
"type" : "string",
"min" : 12,
"max" : 40
},
"__timestampIso8601" : {
"type" : "timestamp",
"timestampFormat" : "iso8601"
},
"__timestampUnix" : {
"type" : "timestamp",
"timestampFormat" : "unixTimestamp"
}
},
"documentation" : "<p>Stub description</p>"
}

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

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

907
botocore/data/iot1click-projects/2018-05-14/service-2.json Normal file
View file

@ -0,0 +1,907 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-05-14",
"endpointPrefix":"projects.iot1click",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"AWS IoT 1-Click Projects",
"serviceFullName":"AWS IoT 1-Click Projects Service",
"serviceId":"IoT 1Click Projects",
"signatureVersion":"v4",
"signingName":"iot1click",
"uid":"iot1click-projects-2018-05-14"
},
"operations":{
"AssociateDeviceWithPlacement":{
"name":"AssociateDeviceWithPlacement",
"http":{
"method":"PUT",
"requestUri":"/projects/{projectName}/placements/{placementName}/devices/{deviceTemplateName}"
},
"input":{"shape":"AssociateDeviceWithPlacementRequest"},
"output":{"shape":"AssociateDeviceWithPlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceConflictException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Associates a physical device with a placement.</p>"
},
"CreatePlacement":{
"name":"CreatePlacement",
"http":{
"method":"POST",
"requestUri":"/projects/{projectName}/placements"
},
"input":{"shape":"CreatePlacementRequest"},
"output":{"shape":"CreatePlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceConflictException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates an empty placement.</p>"
},
"CreateProject":{
"name":"CreateProject",
"http":{
"method":"POST",
"requestUri":"/projects"
},
"input":{"shape":"CreateProjectRequest"},
"output":{"shape":"CreateProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.</p>"
},
"DeletePlacement":{
"name":"DeletePlacement",
"http":{
"method":"DELETE",
"requestUri":"/projects/{projectName}/placements/{placementName}"
},
"input":{"shape":"DeletePlacementRequest"},
"output":{"shape":"DeletePlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Deletes a placement. To delete a placement, it must not have any devices associated with it.</p> <note> <p>When you delete a placement, all associated data becomes irretrievable.</p> </note>"
},
"DeleteProject":{
"name":"DeleteProject",
"http":{
"method":"DELETE",
"requestUri":"/projects/{projectName}"
},
"input":{"shape":"DeleteProjectRequest"},
"output":{"shape":"DeleteProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Deletes a project. To delete a project, it must not have any placements associated with it.</p> <note> <p>When you delete a project, all associated data becomes irretrievable.</p> </note>"
},
"DescribePlacement":{
"name":"DescribePlacement",
"http":{
"method":"GET",
"requestUri":"/projects/{projectName}/placements/{placementName}"
},
"input":{"shape":"DescribePlacementRequest"},
"output":{"shape":"DescribePlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a placement in a project.</p>"
},
"DescribeProject":{
"name":"DescribeProject",
"http":{
"method":"GET",
"requestUri":"/projects/{projectName}"
},
"input":{"shape":"DescribeProjectRequest"},
"output":{"shape":"DescribeProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns an object describing a project.</p>"
},
"DisassociateDeviceFromPlacement":{
"name":"DisassociateDeviceFromPlacement",
"http":{
"method":"DELETE",
"requestUri":"/projects/{projectName}/placements/{placementName}/devices/{deviceTemplateName}"
},
"input":{"shape":"DisassociateDeviceFromPlacementRequest"},
"output":{"shape":"DisassociateDeviceFromPlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Removes a physical device from a placement.</p>"
},
"GetDevicesInPlacement":{
"name":"GetDevicesInPlacement",
"http":{
"method":"GET",
"requestUri":"/projects/{projectName}/placements/{placementName}/devices"
},
"input":{"shape":"GetDevicesInPlacementRequest"},
"output":{"shape":"GetDevicesInPlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns an object enumerating the devices in a placement.</p>"
},
"ListPlacements":{
"name":"ListPlacements",
"http":{
"method":"GET",
"requestUri":"/projects/{projectName}/placements"
},
"input":{"shape":"ListPlacementsRequest"},
"output":{"shape":"ListPlacementsResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the placement(s) of a project.</p>"
},
"ListProjects":{
"name":"ListProjects",
"http":{
"method":"GET",
"requestUri":"/projects"
},
"input":{"shape":"ListProjectsRequest"},
"output":{"shape":"ListProjectsResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.</p>"
},
"UpdatePlacement":{
"name":"UpdatePlacement",
"http":{
"method":"PUT",
"requestUri":"/projects/{projectName}/placements/{placementName}"
},
"input":{"shape":"UpdatePlacementRequest"},
"output":{"shape":"UpdatePlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., \"\").</p>"
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
"method":"PUT",
"requestUri":"/projects/{projectName}"
},
"input":{"shape":"UpdateProjectRequest"},
"output":{"shape":"UpdateProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., <code>\"\"</code>).</p>"
}
},
"shapes":{
"AssociateDeviceWithPlacementRequest":{
"type":"structure",
"required":[
"projectName",
"placementName",
"deviceId",
"deviceTemplateName"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement in which to associate the device.</p>",
"location":"uri",
"locationName":"projectName"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement in which to associate the device.</p>",
"location":"uri",
"locationName":"placementName"
},
"deviceId":{
"shape":"DeviceId",
"documentation":"<p>The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all <code>deviceId</code> values.</p>"
},
"deviceTemplateName":{
"shape":"DeviceTemplateName",
"documentation":"<p>The device template name to associate with the device ID.</p>",
"location":"uri",
"locationName":"deviceTemplateName"
}
}
},
"AssociateDeviceWithPlacementResponse":{
"type":"structure",
"members":{
}
},
"AttributeDefaultValue":{
"type":"string",
"max":800
},
"AttributeName":{
"type":"string",
"max":128,
"min":1
},
"AttributeValue":{
"type":"string",
"max":800
},
"Code":{"type":"string"},
"CreatePlacementRequest":{
"type":"structure",
"required":[
"placementName",
"projectName"
],
"members":{
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement to be created.</p>"
},
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project in which to create the placement.</p>",
"location":"uri",
"locationName":"projectName"
},
"attributes":{
"shape":"PlacementAttributeMap",
"documentation":"<p>Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.</p>"
}
}
},
"CreatePlacementResponse":{
"type":"structure",
"members":{
}
},
"CreateProjectRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to create.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>An optional description for the project.</p>"
},
"placementTemplate":{
"shape":"PlacementTemplate",
"documentation":"<p>The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update <code>callbackOverrides</code> for the device templates using the <code>UpdateProject</code> API.</p>"
}
}
},
"CreateProjectResponse":{
"type":"structure",
"members":{
}
},
"DefaultPlacementAttributeMap":{
"type":"map",
"key":{"shape":"AttributeName"},
"value":{"shape":"AttributeDefaultValue"}
},
"DeletePlacementRequest":{
"type":"structure",
"required":[
"placementName",
"projectName"
],
"members":{
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the empty placement to delete.</p>",
"location":"uri",
"locationName":"placementName"
},
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The project containing the empty placement to delete.</p>",
"location":"uri",
"locationName":"projectName"
}
}
},
"DeletePlacementResponse":{
"type":"structure",
"members":{
}
},
"DeleteProjectRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the empty project to delete.</p>",
"location":"uri",
"locationName":"projectName"
}
}
},
"DeleteProjectResponse":{
"type":"structure",
"members":{
}
},
"DescribePlacementRequest":{
"type":"structure",
"required":[
"placementName",
"projectName"
],
"members":{
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement within a project.</p>",
"location":"uri",
"locationName":"placementName"
},
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The project containing the placement to be described.</p>",
"location":"uri",
"locationName":"projectName"
}
}
},
"DescribePlacementResponse":{
"type":"structure",
"required":["placement"],
"members":{
"placement":{
"shape":"PlacementDescription",
"documentation":"<p>An object describing the placement.</p>"
}
}
},
"DescribeProjectRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to be described.</p>",
"location":"uri",
"locationName":"projectName"
}
}
},
"DescribeProjectResponse":{
"type":"structure",
"required":["project"],
"members":{
"project":{
"shape":"ProjectDescription",
"documentation":"<p>An object describing the project.</p>"
}
}
},
"Description":{
"type":"string",
"max":500,
"min":0
},
"DeviceCallbackKey":{
"type":"string",
"max":128,
"min":1
},
"DeviceCallbackOverrideMap":{
"type":"map",
"key":{"shape":"DeviceCallbackKey"},
"value":{"shape":"DeviceCallbackValue"}
},
"DeviceCallbackValue":{
"type":"string",
"max":200
},
"DeviceId":{
"type":"string",
"max":32,
"min":1
},
"DeviceMap":{
"type":"map",
"key":{"shape":"DeviceTemplateName"},
"value":{"shape":"DeviceId"}
},
"DeviceTemplate":{
"type":"structure",
"members":{
"deviceType":{
"shape":"DeviceType",
"documentation":"<p>The device type, which currently must be <code>\"button\"</code>.</p>"
},
"callbackOverrides":{
"shape":"DeviceCallbackOverrideMap",
"documentation":"<p>An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.</p>"
}
},
"documentation":"<p>An object representing a device for a placement template (see <a>PlacementTemplate</a>).</p>"
},
"DeviceTemplateMap":{
"type":"map",
"key":{"shape":"DeviceTemplateName"},
"value":{"shape":"DeviceTemplate"}
},
"DeviceTemplateName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9_-]+$"
},
"DeviceType":{
"type":"string",
"max":128
},
"DisassociateDeviceFromPlacementRequest":{
"type":"structure",
"required":[
"projectName",
"placementName",
"deviceTemplateName"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project that contains the placement.</p>",
"location":"uri",
"locationName":"projectName"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement that the device should be removed from.</p>",
"location":"uri",
"locationName":"placementName"
},
"deviceTemplateName":{
"shape":"DeviceTemplateName",
"documentation":"<p>The device ID that should be removed from the placement.</p>",
"location":"uri",
"locationName":"deviceTemplateName"
}
}
},
"DisassociateDeviceFromPlacementResponse":{
"type":"structure",
"members":{
}
},
"GetDevicesInPlacementRequest":{
"type":"structure",
"required":[
"projectName",
"placementName"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement.</p>",
"location":"uri",
"locationName":"projectName"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement to get the devices from.</p>",
"location":"uri",
"locationName":"placementName"
}
}
},
"GetDevicesInPlacementResponse":{
"type":"structure",
"required":["devices"],
"members":{
"devices":{
"shape":"DeviceMap",
"documentation":"<p>An object containing the devices (zero or more) within the placement.</p>"
}
}
},
"InternalFailureException":{
"type":"structure",
"required":[
"code",
"message"
],
"members":{
"code":{"shape":"Code"},
"message":{"shape":"Message"}
},
"documentation":"<p/>",
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"required":[
"code",
"message"
],
"members":{
"code":{"shape":"Code"},
"message":{"shape":"Message"}
},
"documentation":"<p/>",
"error":{"httpStatusCode":400},
"exception":true
},
"ListPlacementsRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The project containing the placements to be listed.</p>",
"location":"uri",
"locationName":"projectName"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return per request. If not set, a default value of 100 is used.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListPlacementsResponse":{
"type":"structure",
"required":["placements"],
"members":{
"placements":{
"shape":"PlacementSummaryList",
"documentation":"<p>An object listing the requested placements.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to retrieve the next set of results - will be effectively empty if there are no further results.</p>"
}
}
},
"ListProjectsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return per request. If not set, a default value of 100 is used.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListProjectsResponse":{
"type":"structure",
"required":["projects"],
"members":{
"projects":{
"shape":"ProjectSummaryList",
"documentation":"<p>An object containing the list of projects.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to retrieve the next set of results - will be effectively empty if there are no further results.</p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":250,
"min":1
},
"Message":{"type":"string"},
"NextToken":{
"type":"string",
"max":1024,
"min":1
},
"PlacementAttributeMap":{
"type":"map",
"key":{"shape":"AttributeName"},
"value":{"shape":"AttributeValue"}
},
"PlacementDescription":{
"type":"structure",
"required":[
"projectName",
"placementName",
"attributes",
"createdDate",
"updatedDate"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement.</p>"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement.</p>"
},
"attributes":{
"shape":"PlacementAttributeMap",
"documentation":"<p>The user-defined attributes associated with the placement.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was initially created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
}
},
"documentation":"<p>An object describing a project's placement.</p>"
},
"PlacementName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9_-]+$"
},
"PlacementSummary":{
"type":"structure",
"required":[
"projectName",
"placementName",
"createdDate",
"updatedDate"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement.</p>"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement being summarized.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was originally created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
}
},
"documentation":"<p>An object providing summary information for a particular placement.</p>"
},
"PlacementSummaryList":{
"type":"list",
"member":{"shape":"PlacementSummary"}
},
"PlacementTemplate":{
"type":"structure",
"members":{
"defaultAttributes":{
"shape":"DefaultPlacementAttributeMap",
"documentation":"<p>The default attributes (key/value pairs) to be applied to all placements using this template.</p>"
},
"deviceTemplates":{
"shape":"DeviceTemplateMap",
"documentation":"<p>An object specifying the <a>DeviceTemplate</a> for all placements using this (<a>PlacementTemplate</a>) template.</p>"
}
},
"documentation":"<p>An object defining the template for a placement.</p>"
},
"ProjectDescription":{
"type":"structure",
"required":[
"projectName",
"createdDate",
"updatedDate"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project for which to obtain information from.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>The description of the project.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the project was originally created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
},
"placementTemplate":{
"shape":"PlacementTemplate",
"documentation":"<p>An object describing the project's placement specifications.</p>"
}
},
"documentation":"<p>An object providing detailed information for a particular project associated with an AWS account and region.</p>"
},
"ProjectName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[0-9A-Za-z_-]+$"
},
"ProjectSummary":{
"type":"structure",
"required":[
"projectName",
"createdDate",
"updatedDate"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project being summarized.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the project was originally created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
}
},
"documentation":"<p>An object providing summary information for a particular project for an associated AWS account and region.</p>"
},
"ProjectSummaryList":{
"type":"list",
"member":{"shape":"ProjectSummary"}
},
"ResourceConflictException":{
"type":"structure",
"required":[
"code",
"message"
],
"members":{
"code":{"shape":"Code"},
"message":{"shape":"Message"}
},
"documentation":"<p/>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"required":[
"code",
"message"
],
"members":{
"code":{"shape":"Code"},
"message":{"shape":"Message"}
},
"documentation":"<p/>",
"error":{"httpStatusCode":404},
"exception":true
},
"Time":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
"required":[
"code",
"message"
],
"members":{
"code":{"shape":"Code"},
"message":{"shape":"Message"}
},
"documentation":"<p/>",
"error":{"httpStatusCode":429},
"exception":true
},
"UpdatePlacementRequest":{
"type":"structure",
"required":[
"placementName",
"projectName"
],
"members":{
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement to update.</p>",
"location":"uri",
"locationName":"placementName"
},
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement to be updated.</p>",
"location":"uri",
"locationName":"projectName"
},
"attributes":{
"shape":"PlacementAttributeMap",
"documentation":"<p>The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.</p>"
}
}
},
"UpdatePlacementResponse":{
"type":"structure",
"members":{
}
},
"UpdateProjectRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to be updated.</p>",
"location":"uri",
"locationName":"projectName"
},
"description":{
"shape":"Description",
"documentation":"<p>An optional user-defined description for the project.</p>"
},
"placementTemplate":{
"shape":"PlacementTemplate",
"documentation":"<p>An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given <code>placementTemplate</code>, you can update the associated <code>callbackOverrides</code> for the device definition using this API.</p>"
}
}
},
"UpdateProjectResponse":{
"type":"structure",
"members":{
}
}
},
"documentation":"<p>The AWS IoT 1-Click Project API Reference</p>"
}

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

@ -389,6 +389,24 @@
],
"documentation":"<p>Retrieves a list of pipelines.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the tags (metadata) which you have assigned to the resource.</p>"
},
"PutLoggingOptions":{
"name":"PutLoggingOptions",
"http":{
@ -402,7 +420,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Sets or updates the AWS IoT Analytics logging options.</p>"
"documentation":"<p>Sets or updates the AWS IoT Analytics logging options.</p> <p>Note that if you update the value of any <code>loggingOptions</code> field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect. </p>"
},
"RunPipelineActivity":{
"name":"RunPipelineActivity",
@ -455,6 +473,44 @@
],
"documentation":"<p>Starts the reprocessing of raw message data through the pipeline.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags",
"responseCode":204
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags",
"responseCode":204
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes the given tags (metadata) from the resource.</p>"
},
"UpdateChannel":{
"name":"UpdateChannel",
"http":{
@ -750,6 +806,10 @@
"retentionPeriod":{
"shape":"RetentionPeriod",
"documentation":"<p>How long, in days, message data is kept for the channel.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata which can be used to manage the channel.</p>"
}
}
},
@ -800,6 +860,10 @@
"triggers":{
"shape":"DatasetTriggers",
"documentation":"<p>A list of triggers. A trigger causes data set content to be populated at a specified time or time interval. The list of triggers can be empty or contain up to five <b>DataSetTrigger</b> objects.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata which can be used to manage the data set.</p>"
}
}
},
@ -827,6 +891,10 @@
"retentionPeriod":{
"shape":"RetentionPeriod",
"documentation":"<p>How long, in days, message data is kept for the data store.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata which can be used to manage the data store.</p>"
}
}
},
@ -861,6 +929,10 @@
"pipelineActivities":{
"shape":"PipelineActivities",
"documentation":"<p>A list of pipeline activities.</p> <p>The list can be 1-25 <b>PipelineActivity</b> objects. Activities perform transformations on your messages, such as removing, renaming, or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Metadata which can be used to manage the pipeline.</p>"
}
}
},
@ -1599,6 +1671,27 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource whose tags you want to list.</p>",
"location":"querystring",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"tags":{
"shape":"TagList",
"documentation":"<p>The tags (metadata) which you have assigned to the resource.</p>"
}
}
},
"LogResult":{"type":"string"},
"LoggingEnabled":{"type":"boolean"},
"LoggingLevel":{
@ -1679,7 +1772,7 @@
"members":{
"messageId":{
"shape":"MessageId",
"documentation":"<p>The ID you wish to assign to the message.</p>"
"documentation":"<p>The ID you wish to assign to the message. Each \"messageId\" must be unique within each batch sent.</p>"
},
"payload":{
"shape":"MessagePayload",
@ -1903,6 +1996,11 @@
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceArn":{
"type":"string",
"max":2048,
"min":20
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
@ -2089,6 +2187,70 @@
}
},
"StartTime":{"type":"timestamp"},
"Tag":{
"type":"structure",
"required":[
"key",
"value"
],
"members":{
"key":{
"shape":"TagKey",
"documentation":"<p>The tag's key.</p>"
},
"value":{
"shape":"TagValue",
"documentation":"<p>The tag's value.</p>"
}
},
"documentation":"<p>A set of key/value pairs which are used to manage the resource.</p>"
},
"TagKey":{
"type":"string",
"max":256,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource whose tags will be modified.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The new or modified tags for the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":1
},
"ThrottlingException":{
"type":"structure",
"members":{
@ -2100,6 +2262,32 @@
},
"Timestamp":{"type":"timestamp"},
"UnlimitedRetentionPeriod":{"type":"boolean"},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN of the resource whose tags will be removed.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of those tags which will be removed.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateChannelRequest":{
"type":"structure",
"required":["channelName"],
@ -2178,5 +2366,5 @@
"resourceArn":{"type":"string"},
"resourceId":{"type":"string"}
},
"documentation":"<p>AWS IoT Analytics provides advanced data analysis for AWS IoT. It allows you to collect large amounts of device data, process messages, store them, and then query the data and run sophisticated analytics to make accurate decisions in your IoT applications and machine learning use cases. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.</p> <p>Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result, the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources. </p> <p>AWS IoT Analytics automates each of the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.</p>"
"documentation":"<p>AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.</p> <p>Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources. </p> <p>AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.</p>"
}

34
botocore/data/lambda/2015-03-31/service-2.json
View file

@ -64,7 +64,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.</p> <p>This association between a stream source and a Lambda function is called the event source mapping.</p> <p>You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.</p> <p>Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda functions. A given Lambda function can be associated with multiple AWS event sources.</p> <p>If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html\">AWS Lambda Function Versioning and Aliases</a>. </p> <p>This operation requires permission for the <code>lambda:CreateEventSourceMapping</code> action.</p>"
"documentation":"<p>Identifies a poll-based event source for a Lambda function. It can be either an Amazon Kinesis or DynamoDB stream, or an Amazon SQS queue. AWS Lambda invokes the specified function when records are posted to the event source.</p> <p>This association between a poll-based source and a Lambda function is called the event source mapping.</p> <p>You provide mapping information (for example, which stream or SQS queue to read from and which Lambda function to invoke) in the request body.</p> <p>Amazon Kinesis or DynamoDB stream event sources can be associated with multiple AWS Lambda functions and a given Lambda function can be associated with multiple AWS event sources. For Amazon SQS, you can configure multiple queues as event sources for a single Lambda function, but an SQS queue can be mapped only to a single Lambda function.</p> <p>If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html\">AWS Lambda Function Versioning and Aliases</a>. </p> <p>This operation requires permission for the <code>lambda:CreateEventSourceMapping</code> action.</p>"
},
"CreateFunction":{
"name":"CreateFunction",
@ -113,7 +113,8 @@
{"shape":"ServiceException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"TooManyRequestsException"}
{"shape":"TooManyRequestsException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.</p> <p>This operation requires permission for the <code>lambda:DeleteEventSourceMapping</code> action.</p>"
},
@ -500,7 +501,8 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"TooManyRequestsException"},
{"shape":"ResourceConflictException"}
{"shape":"ResourceConflictException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.</p> <p>If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the <code>FunctionName</code> parameter. For information about the versioning feature, see <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html\">AWS Lambda Function Versioning and Aliases</a>. </p> <p>If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.</p> <p>This operation requires permission for the <code>lambda:UpdateEventSourceMapping</code> action.</p>"
},
@ -787,13 +789,12 @@
"type":"structure",
"required":[
"EventSourceArn",
"FunctionName",
"StartingPosition"
"FunctionName"
],
"members":{
"EventSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the <code>BatchSize</code>. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the event source. Any record added to this source could cause AWS Lambda to invoke your Lambda function, it depends on the <code>BatchSize</code>. AWS Lambda POSTs the event's records to your Lambda function as JSON.</p>"
},
"FunctionName":{
"shape":"FunctionName",
@ -805,7 +806,7 @@
},
"BatchSize":{
"shape":"BatchSize",
"documentation":"<p>The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.</p>"
"documentation":"<p>The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default for Amazon Kinesis and Amazon DynamoDB is 100 records. For SQS, the default is 1.</p>"
},
"StartingPosition":{
"shape":"EventSourcePosition",
@ -1073,11 +1074,11 @@
},
"EventSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream or the SQS queue that is the source of events.</p>"
},
"FunctionArn":{
"shape":"FunctionArn",
"documentation":"<p>The Lambda function to invoke when AWS Lambda detects an event on the stream.</p>"
"documentation":"<p>The Lambda function to invoke when AWS Lambda detects an event on the poll-based source.</p>"
},
"LastModified":{
"shape":"Date",
@ -1096,7 +1097,7 @@
"documentation":"<p>The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.</p>"
}
},
"documentation":"<p>Describes mapping between an Amazon Kinesis stream and a Lambda function.</p>"
"documentation":"<p>Describes mapping between an Amazon Kinesis or DynamoDB stream or an Amazon SQS queue and a Lambda function.</p>"
},
"EventSourceMappingsList":{
"type":"list",
@ -1674,7 +1675,7 @@
"members":{
"EventSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Kinesis stream. (This parameter is optional.)</p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Kinesis or DynamoDB stream, or an SQS queue. (This parameter is optional.)</p>",
"location":"querystring",
"locationName":"EventSourceArn"
},
@ -2003,6 +2004,16 @@
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceInUseException":{
"type":"structure",
"members":{
"Type":{"shape":"String"},
"Message":{"shape":"String"}
},
"documentation":"<p>The operation conflicts with the resource's availability. For example, you attempted to update an EventSoure Mapping in CREATING, or tried to delete a EventSoure mapping currently in the UPDATING state. </p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
@ -2029,6 +2040,7 @@
"python3.6",
"dotnetcore1.0",
"dotnetcore2.0",
"dotnetcore2.1",
"nodejs4.3-edge",
"go1.x"
]

1
botocore/data/logs/2014-03-28/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon CloudWatch Logs",
"serviceId":"CloudWatch Logs",
"signatureVersion":"v4",
"targetPrefix":"Logs_20140328",
"uid":"logs-2014-03-28"

1
botocore/data/machinelearning/2014-12-12/service-2.json
View file

@ -6,6 +6,7 @@
"endpointPrefix":"machinelearning",
"jsonVersion":"1.1",
"serviceFullName":"Amazon Machine Learning",
"serviceId":"Machine Learning",
"signatureVersion":"v4",
"targetPrefix":"AmazonML_20141212",
"protocol":"json"

3
botocore/data/macie/2017-12-19/paginators-1.json Normal file
View file

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

495
botocore/data/macie/2017-12-19/service-2.json Normal file
View file

@ -0,0 +1,495 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-12-19",
"endpointPrefix":"macie",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Macie",
"serviceId":"Macie",
"signatureVersion":"v4",
"targetPrefix":"MacieService",
"uid":"macie-2017-12-19"
},
"operations":{
"AssociateMemberAccount":{
"name":"AssociateMemberAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateMemberAccountRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InternalException"}
],
"documentation":"<p>Associates a specified AWS account with Amazon Macie as a member account.</p>"
},
"AssociateS3Resources":{
"name":"AssociateS3Resources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateS3ResourcesRequest"},
"output":{"shape":"AssociateS3ResourcesResult"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"LimitExceededException"},
{"shape":"InternalException"}
],
"documentation":"<p>Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account. </p>"
},
"DisassociateMemberAccount":{
"name":"DisassociateMemberAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateMemberAccountRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"InternalException"}
],
"documentation":"<p>Removes the specified member account from Amazon Macie.</p>"
},
"DisassociateS3Resources":{
"name":"DisassociateS3Resources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateS3ResourcesRequest"},
"output":{"shape":"DisassociateS3ResourcesResult"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
"documentation":"<p>Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.</p>"
},
"ListMemberAccounts":{
"name":"ListMemberAccounts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListMemberAccountsRequest"},
"output":{"shape":"ListMemberAccountsResult"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Lists all Amazon Macie member accounts for the current Amazon Macie master account.</p>"
},
"ListS3Resources":{
"name":"ListS3Resources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListS3ResourcesRequest"},
"output":{"shape":"ListS3ResourcesResult"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
"documentation":"<p>Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account. </p>"
},
"UpdateS3Resources":{
"name":"UpdateS3Resources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateS3ResourcesRequest"},
"output":{"shape":"UpdateS3ResourcesResult"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
"documentation":"<p>Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account. </p>"
}
},
"shapes":{
"AWSAccountId":{
"type":"string",
"pattern":"[0-9]{12}"
},
"AccessDeniedException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"},
"resourceType":{"shape":"ResourceType"}
},
"documentation":"<p>You do not have required permissions to access the requested resource.</p>",
"exception":true
},
"AssociateMemberAccountRequest":{
"type":"structure",
"required":["memberAccountId"],
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The ID of the AWS account that you want to associate with Amazon Macie as a member account.</p>"
}
}
},
"AssociateS3ResourcesRequest":{
"type":"structure",
"required":["s3Resources"],
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The ID of the Amazon Macie member account whose resources you want to associate with Macie. </p>"
},
"s3Resources":{
"shape":"S3ResourcesClassification",
"documentation":"<p>The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. </p>"
}
}
},
"AssociateS3ResourcesResult":{
"type":"structure",
"members":{
"failedS3Resources":{
"shape":"FailedS3Resources",
"documentation":"<p>S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item. </p>"
}
}
},
"BucketName":{
"type":"string",
"max":500
},
"ClassificationType":{
"type":"structure",
"required":[
"oneTime",
"continuous"
],
"members":{
"oneTime":{
"shape":"S3OneTimeClassificationType",
"documentation":"<p>A one-time classification of all of the existing objects in a specified S3 bucket. </p>"
},
"continuous":{
"shape":"S3ContinuousClassificationType",
"documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie. </p>"
}
},
"documentation":"<p>The classification type that Amazon Macie applies to the associated S3 resources. </p>"
},
"ClassificationTypeUpdate":{
"type":"structure",
"members":{
"oneTime":{
"shape":"S3OneTimeClassificationType",
"documentation":"<p>A one-time classification of all of the existing objects in a specified S3 bucket. </p>"
},
"continuous":{
"shape":"S3ContinuousClassificationType",
"documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie. </p>"
}
},
"documentation":"<p>The classification type that Amazon Macie applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified. </p>"
},
"DisassociateMemberAccountRequest":{
"type":"structure",
"required":["memberAccountId"],
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The ID of the member account that you want to remove from Amazon Macie.</p>"
}
}
},
"DisassociateS3ResourcesRequest":{
"type":"structure",
"required":["associatedS3Resources"],
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie. </p>"
},
"associatedS3Resources":{
"shape":"S3Resources",
"documentation":"<p>The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie. </p>"
}
}
},
"DisassociateS3ResourcesResult":{
"type":"structure",
"members":{
"failedS3Resources":{
"shape":"FailedS3Resources",
"documentation":"<p>S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an error message are provided for each failed item. </p>"
}
}
},
"ErrorCode":{
"type":"string",
"documentation":"Error code for the exception",
"max":10
},
"ExceptionMessage":{
"type":"string",
"max":10000
},
"FailedS3Resource":{
"type":"structure",
"members":{
"failedItem":{
"shape":"S3Resource",
"documentation":"<p>The failed S3 resources.</p>"
},
"errorCode":{
"shape":"ErrorCode",
"documentation":"<p>The status code of a failed item.</p>"
},
"errorMessage":{
"shape":"ExceptionMessage",
"documentation":"<p>The error message of a failed item.</p>"
}
},
"documentation":"<p>Includes details about the failed S3 resources.</p>"
},
"FailedS3Resources":{
"type":"list",
"member":{"shape":"FailedS3Resource"}
},
"FieldName":{
"type":"string",
"documentation":"Field that has invalid input",
"max":1000
},
"InternalException":{
"type":"structure",
"members":{
"errorCode":{"shape":"ErrorCode"},
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>Internal server error.</p>",
"exception":true,
"fault":true
},
"InvalidInputException":{
"type":"structure",
"members":{
"errorCode":{"shape":"ErrorCode"},
"message":{"shape":"ExceptionMessage"},
"fieldName":{"shape":"FieldName"}
},
"documentation":"<p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter. </p>",
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"errorCode":{"shape":"ErrorCode"},
"message":{"shape":"ExceptionMessage"},
"resourceType":{"shape":"ResourceType"}
},
"documentation":"<p>The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded. </p>",
"exception":true
},
"ListMemberAccountsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. </p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. </p>"
}
}
},
"ListMemberAccountsResult":{
"type":"structure",
"members":{
"memberAccounts":{
"shape":"MemberAccounts",
"documentation":"<p>A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list. </p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. </p>"
}
}
},
"ListS3ResourcesRequest":{
"type":"structure",
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The Amazon Macie member account ID whose associated S3 resources you want to list. </p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data. </p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250. </p>"
}
}
},
"ListS3ResourcesResult":{
"type":"structure",
"members":{
"s3Resources":{
"shape":"S3ResourcesClassification",
"documentation":"<p>A list of the associated S3 resources returned by the action.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. </p>"
}
}
},
"MaxResults":{
"type":"integer",
"box":true,
"max":250
},
"MemberAccount":{
"type":"structure",
"members":{
"accountId":{
"shape":"AWSAccountId",
"documentation":"<p>The AWS account ID of the Amazon Macie member account.</p>"
}
},
"documentation":"<p>Contains information about the Amazon Macie member account.</p>"
},
"MemberAccounts":{
"type":"list",
"member":{"shape":"MemberAccount"}
},
"NextToken":{
"type":"string",
"max":500
},
"Prefix":{
"type":"string",
"max":10000
},
"ResourceType":{
"type":"string",
"documentation":"Resource type that caused the exception",
"max":1000
},
"S3ContinuousClassificationType":{
"type":"string",
"enum":["FULL"]
},
"S3OneTimeClassificationType":{
"type":"string",
"enum":[
"FULL",
"NONE"
]
},
"S3Resource":{
"type":"structure",
"required":["bucketName"],
"members":{
"bucketName":{
"shape":"BucketName",
"documentation":"<p>The name of the S3 bucket.</p>"
},
"prefix":{
"shape":"Prefix",
"documentation":"<p>The prefix of the S3 bucket. </p>"
}
},
"documentation":"<p>Contains information about the S3 resource. This data type is used as a request parameter in the DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and UpdateS3Resources actions. </p>"
},
"S3ResourceClassification":{
"type":"structure",
"required":[
"bucketName",
"classificationType"
],
"members":{
"bucketName":{
"shape":"BucketName",
"documentation":"<p>The name of the S3 bucket that you want to associate with Amazon Macie.</p>"
},
"prefix":{
"shape":"Prefix",
"documentation":"<p>The prefix of the S3 bucket that you want to associate with Amazon Macie.</p>"
},
"classificationType":{
"shape":"ClassificationType",
"documentation":"<p>The classification type that you want to specify for the resource associated with Amazon Macie. </p>"
}
},
"documentation":"<p>The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action. </p>"
},
"S3ResourceClassificationUpdate":{
"type":"structure",
"required":[
"bucketName",
"classificationTypeUpdate"
],
"members":{
"bucketName":{
"shape":"BucketName",
"documentation":"<p>The name of the S3 bucket whose classification types you want to update.</p>"
},
"prefix":{
"shape":"Prefix",
"documentation":"<p>The prefix of the S3 bucket whose classification types you want to update.</p>"
},
"classificationTypeUpdate":{
"shape":"ClassificationTypeUpdate",
"documentation":"<p>The classification type that you want to update for the resource associated with Amazon Macie. </p>"
}
},
"documentation":"<p>The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action. </p>"
},
"S3Resources":{
"type":"list",
"member":{"shape":"S3Resource"}
},
"S3ResourcesClassification":{
"type":"list",
"member":{"shape":"S3ResourceClassification"}
},
"S3ResourcesClassificationUpdate":{
"type":"list",
"member":{"shape":"S3ResourceClassificationUpdate"}
},
"UpdateS3ResourcesRequest":{
"type":"structure",
"required":["s3ResourcesUpdate"],
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update. </p>"
},
"s3ResourcesUpdate":{
"shape":"S3ResourcesClassificationUpdate",
"documentation":"<p>The S3 resources whose classification types you want to update.</p>"
}
}
},
"UpdateS3ResourcesResult":{
"type":"structure",
"members":{
"failedS3Resources":{
"shape":"FailedS3Resources",
"documentation":"<p>The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item. </p>"
}
}
}
},
"documentation":"<fullname>Amazon Macie</fullname> <p>Amazon Macie is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the <a href=\"https://docs.aws.amazon.com/macie/latest/userguide/what-is-macie.html\">Macie User Guide</a>. </p>"
}

1
botocore/data/marketplace-entitlement/2017-01-11/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Marketplace Entitlement Service",
"serviceId":"Marketplace Entitlement Service",
"signatureVersion":"v4",
"signingName":"aws-marketplace",
"targetPrefix":"AWSMPEntitlementService",

1
botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Marketplace Commerce Analytics",
"serviceId":"Marketplace Commerce Analytics",
"signatureVersion":"v4",
"signingName":"marketplacecommerceanalytics",
"targetPrefix":"MarketplaceCommerceAnalytics20150701",

2229
botocore/data/mediaconvert/2017-08-29/service-2.json
View file

@ -709,6 +709,129 @@
],
"documentation": "Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array."
},
"ListTagsForResource": {
"name": "ListTagsForResource",
"http": {
"method": "GET",
"requestUri": "/2017-08-29/tags/{arn}",
"responseCode": 200
},
"input": {
"shape": "ListTagsForResourceRequest"
},
"output": {
"shape": "ListTagsForResourceResponse"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax."
},
{
"shape": "InternalServerErrorException",
"documentation": "The service encountered an unexpected condition and cannot fulfill your request."
},
{
"shape": "ForbiddenException",
"documentation": "You don't have permissions for this action with the credentials you sent."
},
{
"shape": "NotFoundException",
"documentation": "The resource you requested does not exist."
},
{
"shape": "TooManyRequestsException",
"documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests."
},
{
"shape": "ConflictException",
"documentation": "The service could not complete your request because there is a conflict with the current state of the resource."
}
],
"documentation": "Retrieve the tags for a MediaConvert resource."
},
"TagResource": {
"name": "TagResource",
"http": {
"method": "POST",
"requestUri": "/2017-08-29/tags",
"responseCode": 200
},
"input": {
"shape": "TagResourceRequest"
},
"output": {
"shape": "TagResourceResponse"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax."
},
{
"shape": "InternalServerErrorException",
"documentation": "The service encountered an unexpected condition and cannot fulfill your request."
},
{
"shape": "ForbiddenException",
"documentation": "You don't have permissions for this action with the credentials you sent."
},
{
"shape": "NotFoundException",
"documentation": "The resource you requested does not exist."
},
{
"shape": "TooManyRequestsException",
"documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests."
},
{
"shape": "ConflictException",
"documentation": "The service could not complete your request because there is a conflict with the current state of the resource."
}
],
"documentation": "Tag a MediaConvert queue, preset, or job template. For information about these resource types, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html"
},
"UntagResource": {
"name": "UntagResource",
"http": {
"method": "DELETE",
"requestUri": "/2017-08-29/tags",
"responseCode": 200
},
"input": {
"shape": "UntagResourceRequest"
},
"output": {
"shape": "UntagResourceResponse"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax."
},
{
"shape": "InternalServerErrorException",
"documentation": "The service encountered an unexpected condition and cannot fulfill your request."
},
{
"shape": "ForbiddenException",
"documentation": "You don't have permissions for this action with the credentials you sent."
},
{
"shape": "NotFoundException",
"documentation": "The resource you requested does not exist."
},
{
"shape": "TooManyRequestsException",
"documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests."
},
{
"shape": "ConflictException",
"documentation": "The service could not complete your request because there is a conflict with the current state of the resource."
}
],
"documentation": "Untag a MediaConvert queue, preset, or job template. For information about these resource types, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html"
},
"UpdateJobTemplate": {
"name": "UpdateJobTemplate",
"http": {
@ -886,9 +1009,9 @@
"locationName": "audioDescriptionBroadcasterMix"
},
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin6000Max1024000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Valid values depend on rate control mode and profile."
"documentation": "Average bitrate in bits/second. Defaults and valid values depend on rate control mode and profile."
},
"CodecProfile": {
"shape": "AacCodecProfile",
@ -907,7 +1030,7 @@
"locationName": "rawFormat"
},
"SampleRate": {
"shape": "__integer",
"shape": "__integerMin8000Max96000",
"locationName": "sampleRate",
"documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile."
},
@ -920,7 +1043,11 @@
"locationName": "vbrQuality"
}
},
"documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC."
"documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to \"VBR\" or \"CBR\". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode.",
"required": [
"CodingMode",
"SampleRate"
]
},
"AacSpecification": {
"type": "string",
@ -992,7 +1119,7 @@
"type": "structure",
"members": {
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin64000Max640000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
},
@ -1005,7 +1132,7 @@
"locationName": "codingMode"
},
"Dialnorm": {
"shape": "__integer",
"shape": "__integerMin1Max31",
"locationName": "dialnorm",
"documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through."
},
@ -1022,7 +1149,7 @@
"locationName": "metadataControl"
},
"SampleRate": {
"shape": "__integer",
"shape": "__integerMin48000Max48000",
"locationName": "sampleRate",
"documentation": "Sample rate in hz. Sample rate is always 48000."
}
@ -1031,7 +1158,7 @@
},
"AfdSignaling": {
"type": "string",
"documentation": "This setting only applies to H.264 and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to whether there are AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.",
"documentation": "This setting only applies to H.264 and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.",
"enum": [
"NONE",
"AUTO",
@ -1042,17 +1169,17 @@
"type": "structure",
"members": {
"BitDepth": {
"shape": "__integer",
"shape": "__integerMin16Max24",
"locationName": "bitDepth",
"documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track."
},
"Channels": {
"shape": "__integer",
"shape": "__integerMin1Max2",
"locationName": "channels",
"documentation": "Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2."
},
"SampleRate": {
"shape": "__integer",
"shape": "__integerMin8000Max192000",
"locationName": "sampleRate",
"documentation": "Sample rate in hz."
}
@ -1063,7 +1190,7 @@
"type": "structure",
"members": {
"SourceAncillaryChannelNumber": {
"shape": "__integer",
"shape": "__integerMin1Max4",
"locationName": "sourceAncillaryChannelNumber",
"documentation": "Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough."
}
@ -1123,11 +1250,14 @@
"locationName": "wavSettings"
}
},
"documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings"
"documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings",
"required": [
"Codec"
]
},
"AudioDefaultSelection": {
"type": "string",
"documentation": "When an \"Audio Description\":#audio_description specifies an AudioSelector or AudioSelectorGroup for which no matching source is found in the input, then the audio selector marked as DEFAULT will be used. If none are marked as default, silence will be inserted for the duration of the input.",
"documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.",
"enum": [
"DEFAULT",
"NOT_DEFAULT"
@ -1146,7 +1276,7 @@
"documentation": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically."
},
"AudioType": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "audioType",
"documentation": "Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved."
},
@ -1158,6 +1288,11 @@
"shape": "AudioCodecSettings",
"locationName": "codecSettings"
},
"CustomLanguageCode": {
"shape": "__stringMin3Max3PatternAZaZ3",
"locationName": "customLanguageCode",
"documentation": "Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input."
},
"LanguageCode": {
"shape": "LanguageCode",
"locationName": "languageCode",
@ -1173,12 +1308,15 @@
"documentation": "Advanced audio remixing settings."
},
"StreamName": {
"shape": "__string",
"shape": "__stringPatternWS",
"locationName": "streamName",
"documentation": "Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal."
}
},
"documentation": "Description of audio output"
"documentation": "Description of audio output",
"required": [
"CodecSettings"
]
},
"AudioLanguageCodeControl": {
"type": "string",
@ -1232,7 +1370,7 @@
"locationName": "algorithmControl"
},
"CorrectionGateLevel": {
"shape": "__integer",
"shape": "__integerMinNegative70Max0",
"locationName": "correctionGateLevel",
"documentation": "Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction."
},
@ -1245,7 +1383,7 @@
"locationName": "peakCalculation"
},
"TargetLkfs": {
"shape": "__double",
"shape": "__doubleMinNegative59Max0",
"locationName": "targetLkfs",
"documentation": "Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS."
}
@ -1255,12 +1393,17 @@
"AudioSelector": {
"type": "structure",
"members": {
"CustomLanguageCode": {
"shape": "__stringMin3Max3PatternAZaZ3",
"locationName": "customLanguageCode",
"documentation": "Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code"
},
"DefaultSelection": {
"shape": "AudioDefaultSelection",
"locationName": "defaultSelection"
},
"ExternalAudioFileInput": {
"shape": "__string",
"shape": "__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
"locationName": "externalAudioFileInput",
"documentation": "Specifies audio data from an external file source."
},
@ -1270,33 +1413,33 @@
"documentation": "Selects a specific language code from within an audio source."
},
"Offset": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "offset",
"documentation": "Specifies a time delta in milliseconds to offset the audio from the input video."
},
"Pids": {
"shape": "ListOf__integer",
"shape": "__listOf__integerMin1Max2147483647",
"locationName": "pids",
"documentation": "Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101)."
},
"ProgramSelection": {
"shape": "__integer",
"shape": "__integerMin0Max8",
"locationName": "programSelection",
"documentation": "Applies only when input streams contain Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. \"All channels\" means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect."
"documentation": "Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track."
},
"RemixSettings": {
"shape": "RemixSettings",
"locationName": "remixSettings",
"documentation": "Advanced audio remixing settings."
"documentation": "Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other."
},
"SelectorType": {
"shape": "AudioSelectorType",
"locationName": "selectorType"
},
"Tracks": {
"shape": "ListOf__integer",
"shape": "__listOf__integerMin1Max2147483647",
"locationName": "tracks",
"documentation": "Identify the channel to include in this selector by entering the 1-based track index. To combine several tracks, enter a comma-separated list, e.g. \"1,2,3\" for tracks 1-3."
"documentation": "Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type \"1,2,3\" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, \"tracks\": [1,2,3]."
}
},
"documentation": "Selector for Audio"
@ -1305,12 +1448,15 @@
"type": "structure",
"members": {
"AudioSelectorNames": {
"shape": "ListOf__string",
"shape": "__listOf__stringMin1",
"locationName": "audioSelectorNames",
"documentation": "Name of an \"Audio Selector\":#inputs-audio_selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g. \"Audio Selector 1\"). The audio_selector_name parameter can be repeated to add any number of audio selectors to the group."
"documentation": "Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., \"Audio Selector 1\"). The audio selector name parameter can be repeated to add any number of audio selectors to the group."
}
},
"documentation": "Group of Audio Selectors"
"documentation": "Group of Audio Selectors",
"required": [
"AudioSelectorNames"
]
},
"AudioSelectorType": {
"type": "string",
@ -1333,7 +1479,7 @@
"type": "structure",
"members": {
"AvailBlankingImage": {
"shape": "__string",
"shape": "__stringMin14PatternS3BmpBMPPngPNG",
"locationName": "availBlankingImage",
"documentation": "Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported."
}
@ -1366,7 +1512,7 @@
"locationName": "backgroundColor"
},
"BackgroundOpacity": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "backgroundOpacity",
"documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
},
@ -1375,17 +1521,17 @@
"locationName": "fontColor"
},
"FontOpacity": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "fontOpacity",
"documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match."
},
"FontResolution": {
"shape": "__integer",
"shape": "__integerMin96Max600",
"locationName": "fontResolution",
"documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match."
},
"FontSize": {
"shape": "__integer",
"shape": "__integerMin0Max96",
"locationName": "fontSize",
"documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match."
},
@ -1394,7 +1540,7 @@
"locationName": "outlineColor"
},
"OutlineSize": {
"shape": "__integer",
"shape": "__integerMin0Max10",
"locationName": "outlineSize",
"documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
},
@ -1403,17 +1549,17 @@
"locationName": "shadowColor"
},
"ShadowOpacity": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "shadowOpacity",
"documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
},
"ShadowXOffset": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "shadowXOffset",
"documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match."
},
"ShadowYOffset": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "shadowYOffset",
"documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match."
},
@ -1422,17 +1568,23 @@
"locationName": "teletextSpacing"
},
"XPosition": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "xPosition",
"documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
},
"YPosition": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "yPosition",
"documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
}
},
"documentation": "Burn-In Destination Settings."
"documentation": "Burn-In Destination Settings.",
"required": [
"OutlineColor",
"Alignment",
"OutlineSize",
"FontOpacity"
]
},
"BurninSubtitleAlignment": {
"type": "string",
@ -1486,7 +1638,7 @@
},
"BurninSubtitleTeletextSpacing": {
"type": "string",
"documentation": "Controls whether a fixed grid size or proportional font spacing will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.",
"documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.",
"enum": [
"FIXED_GRID",
"PROPORTIONAL"
@ -1515,10 +1667,15 @@
"type": "structure",
"members": {
"CaptionSelectorName": {
"shape": "__string",
"shape": "__stringMin1",
"locationName": "captionSelectorName",
"documentation": "Specifies which \"Caption Selector\":#inputs-caption_selector to use from each input when generating captions. The name should be of the format \"Caption Selector <N>\", which denotes that the Nth Caption Selector will be used from each input."
},
"CustomLanguageCode": {
"shape": "__stringMin3Max3PatternAZaZ3",
"locationName": "customLanguageCode",
"documentation": "Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code"
},
"DestinationSettings": {
"shape": "CaptionDestinationSettings",
"locationName": "destinationSettings"
@ -1534,11 +1691,20 @@
"documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal."
}
},
"documentation": "Description of Caption output"
"documentation": "Description of Caption output",
"required": [
"DestinationSettings",
"CaptionSelectorName"
]
},
"CaptionDescriptionPreset": {
"type": "structure",
"members": {
"CustomLanguageCode": {
"shape": "__stringMin3Max3PatternAZaZ3",
"locationName": "customLanguageCode",
"documentation": "Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code"
},
"DestinationSettings": {
"shape": "CaptionDestinationSettings",
"locationName": "destinationSettings"
@ -1554,7 +1720,10 @@
"documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal."
}
},
"documentation": "Caption Description for preset"
"documentation": "Caption Description for preset",
"required": [
"DestinationSettings"
]
},
"CaptionDestinationSettings": {
"type": "structure",
@ -1584,7 +1753,10 @@
"locationName": "ttmlDestinationSettings"
}
},
"documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext."
"documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.",
"required": [
"DestinationType"
]
},
"CaptionDestinationType": {
"type": "string",
@ -1603,6 +1775,11 @@
"CaptionSelector": {
"type": "structure",
"members": {
"CustomLanguageCode": {
"shape": "__stringMin3Max3PatternAZaZ3",
"locationName": "customLanguageCode",
"documentation": "The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions."
},
"LanguageCode": {
"shape": "LanguageCode",
"locationName": "languageCode",
@ -1613,7 +1790,10 @@
"locationName": "sourceSettings"
}
},
"documentation": "Caption inputs to be mapped to caption outputs."
"documentation": "Set up captions in your outputs by first selecting them from your input here.",
"required": [
"SourceSettings"
]
},
"CaptionSourceSettings": {
"type": "structure",
@ -1643,7 +1823,10 @@
"locationName": "teletextSourceSettings"
}
},
"documentation": "Source settings (SourceSettings) contains the group of settings for captions in the input."
"documentation": "Source settings (SourceSettings) contains the group of settings for captions in the input.",
"required": [
"SourceType"
]
},
"CaptionSourceType": {
"type": "string",
@ -1664,18 +1847,209 @@
"type": "structure",
"members": {
"OutputChannels": {
"shape": "ListOfOutputChannelMapping",
"shape": "__listOfOutputChannelMapping",
"locationName": "outputChannels",
"documentation": "List of output channels"
}
},
"documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification)."
"documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification).",
"required": [
"OutputChannels"
]
},
"CmafClientCache": {
"type": "string",
"documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.",
"enum": [
"DISABLED",
"ENABLED"
]
},
"CmafCodecSpecification": {
"type": "string",
"documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.",
"enum": [
"RFC_6381",
"RFC_4281"
]
},
"CmafEncryptionSettings": {
"type": "structure",
"members": {
"ConstantInitializationVector": {
"shape": "__stringMin32Max32Pattern09aFAF32",
"locationName": "constantInitializationVector",
"documentation": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default."
},
"EncryptionMethod": {
"shape": "CmafEncryptionType",
"locationName": "encryptionMethod"
},
"InitializationVectorInManifest": {
"shape": "CmafInitializationVectorInManifest",
"locationName": "initializationVectorInManifest"
},
"StaticKeyProvider": {
"shape": "StaticKeyProvider",
"locationName": "staticKeyProvider"
},
"Type": {
"shape": "CmafKeyProviderType",
"locationName": "type"
}
},
"documentation": "Settings for CMAF encryption",
"required": [
"Type"
]
},
"CmafEncryptionType": {
"type": "string",
"documentation": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.",
"enum": [
"SAMPLE_AES"
]
},
"CmafGroupSettings": {
"type": "structure",
"members": {
"BaseUrl": {
"shape": "__string",
"locationName": "baseUrl",
"documentation": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file."
},
"ClientCache": {
"shape": "CmafClientCache",
"locationName": "clientCache"
},
"CodecSpecification": {
"shape": "CmafCodecSpecification",
"locationName": "codecSpecification"
},
"Destination": {
"shape": "__stringPatternS3",
"locationName": "destination",
"documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file."
},
"Encryption": {
"shape": "CmafEncryptionSettings",
"locationName": "encryption",
"documentation": "DRM settings."
},
"FragmentLength": {
"shape": "__integerMin1Max2147483647",
"locationName": "fragmentLength",
"documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types."
},
"ManifestCompression": {
"shape": "CmafManifestCompression",
"locationName": "manifestCompression"
},
"ManifestDurationFormat": {
"shape": "CmafManifestDurationFormat",
"locationName": "manifestDurationFormat"
},
"MinBufferTime": {
"shape": "__integerMin0Max2147483647",
"locationName": "minBufferTime",
"documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout."
},
"SegmentControl": {
"shape": "CmafSegmentControl",
"locationName": "segmentControl"
},
"SegmentLength": {
"shape": "__integerMin1Max2147483647",
"locationName": "segmentLength",
"documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment."
},
"StreamInfResolution": {
"shape": "CmafStreamInfResolution",
"locationName": "streamInfResolution"
},
"WriteDashManifest": {
"shape": "CmafWriteDASHManifest",
"locationName": "writeDashManifest"
},
"WriteHlsManifest": {
"shape": "CmafWriteHLSManifest",
"locationName": "writeHlsManifest"
}
},
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.",
"required": [
"FragmentLength",
"SegmentLength"
]
},
"CmafInitializationVectorInManifest": {
"type": "string",
"documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.",
"enum": [
"INCLUDE",
"EXCLUDE"
]
},
"CmafKeyProviderType": {
"type": "string",
"documentation": "Indicates which type of key provider is used for encryption.",
"enum": [
"STATIC_KEY"
]
},
"CmafManifestCompression": {
"type": "string",
"documentation": "When set to GZIP, compresses HLS playlist.",
"enum": [
"GZIP",
"NONE"
]
},
"CmafManifestDurationFormat": {
"type": "string",
"documentation": "Indicates whether the output manifest should use floating point values for segment duration.",
"enum": [
"FLOATING_POINT",
"INTEGER"
]
},
"CmafSegmentControl": {
"type": "string",
"documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.",
"enum": [
"SINGLE_FILE",
"SEGMENTED_FILES"
]
},
"CmafStreamInfResolution": {
"type": "string",
"documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.",
"enum": [
"INCLUDE",
"EXCLUDE"
]
},
"CmafWriteDASHManifest": {
"type": "string",
"documentation": "When set to ENABLED, a DASH MPD manifest will be generated for this output.",
"enum": [
"DISABLED",
"ENABLED"
]
},
"CmafWriteHLSManifest": {
"type": "string",
"documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output.",
"enum": [
"DISABLED",
"ENABLED"
]
},
"ColorCorrector": {
"type": "structure",
"members": {
"Brightness": {
"shape": "__integer",
"shape": "__integerMin1Max100",
"locationName": "brightness",
"documentation": "Brightness level."
},
@ -1684,7 +2058,7 @@
"locationName": "colorSpaceConversion"
},
"Contrast": {
"shape": "__integer",
"shape": "__integerMin1Max100",
"locationName": "contrast",
"documentation": "Contrast level."
},
@ -1693,12 +2067,12 @@
"locationName": "hdr10Metadata"
},
"Hue": {
"shape": "__integer",
"shape": "__integerMinNegative180Max180",
"locationName": "hue",
"documentation": "Hue in degrees."
},
"Saturation": {
"shape": "__integer",
"shape": "__integerMin1Max100",
"locationName": "saturation",
"documentation": "Saturation level."
}
@ -1715,7 +2089,7 @@
},
"ColorSpace": {
"type": "string",
"documentation": "Specifies the colorspace of an input. This setting works in tandem with \"Color Corrector\":#color_corrector > color_space_conversion to determine if any conversion will be performed.",
"documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values.",
"enum": [
"FOLLOW",
"REC_601",
@ -1737,7 +2111,7 @@
},
"ColorSpaceUsage": {
"type": "string",
"documentation": "There are two sources for color metadata, the input file and the job configuration. This enum controls which takes precedence. FORCE: System will use color metadata supplied by user, if any. If the user does not supply color metadata the system will use data from the source. FALLBACK: System will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available.",
"documentation": "There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available.",
"enum": [
"FORCE",
"FALLBACK"
@ -1785,7 +2159,10 @@
"locationName": "mp4Settings"
}
},
"documentation": "Container specific settings."
"documentation": "Container specific settings.",
"required": [
"Container"
]
},
"ContainerType": {
"type": "string",
@ -1795,6 +2172,7 @@
"ISMV",
"M2TS",
"M3U8",
"CMFC",
"MOV",
"MP4",
"MPD",
@ -1831,11 +2209,15 @@
"locationName": "settings"
},
"UserMetadata": {
"shape": "MapOf__string",
"shape": "__mapOf__string",
"locationName": "userMetadata",
"documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs."
}
}
},
"required": [
"Role",
"Settings"
]
},
"CreateJobResponse": {
"type": "structure",
@ -1872,8 +2254,17 @@
"Settings": {
"shape": "JobTemplateSettings",
"locationName": "settings"
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
"documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key."
}
}
},
"required": [
"Settings",
"Name"
]
},
"CreateJobTemplateResponse": {
"type": "structure",
@ -1905,8 +2296,17 @@
"Settings": {
"shape": "PresetSettings",
"locationName": "settings"
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
"documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key."
}
}
},
"required": [
"Settings",
"Name"
]
},
"CreatePresetResponse": {
"type": "structure",
@ -1929,8 +2329,16 @@
"shape": "__string",
"locationName": "name",
"documentation": "The name of the queue you are creating."
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
"documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key."
}
}
},
"required": [
"Name"
]
},
"CreateQueueResponse": {
"type": "structure",
@ -1949,7 +2357,10 @@
"locationName": "spekeKeyProvider"
}
},
"documentation": "Specifies DRM settings for DASH outputs."
"documentation": "Specifies DRM settings for DASH outputs.",
"required": [
"SpekeKeyProvider"
]
},
"DashIsoGroupSettings": {
"type": "structure",
@ -1960,7 +2371,7 @@
"documentation": "A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file."
},
"Destination": {
"shape": "__string",
"shape": "__stringPatternS3",
"locationName": "destination",
"documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file."
},
@ -1970,7 +2381,7 @@
"documentation": "DRM settings."
},
"FragmentLength": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "fragmentLength",
"documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types."
},
@ -1979,7 +2390,7 @@
"locationName": "hbbtvCompliance"
},
"MinBufferTime": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "minBufferTime",
"documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout."
},
@ -1988,12 +2399,16 @@
"locationName": "segmentControl"
},
"SegmentLength": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "segmentLength",
"documentation": "Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types."
}
},
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS."
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.",
"required": [
"SegmentLength",
"FragmentLength"
]
},
"DashIsoHbbtvCompliance": {
"type": "string",
@ -2133,7 +2548,7 @@
"type": "structure",
"members": {
"Endpoints": {
"shape": "ListOfEndpoint",
"shape": "__listOfEndpoint",
"locationName": "endpoints",
"documentation": "List of endpoints"
},
@ -2156,22 +2571,27 @@
"type": "structure",
"members": {
"NetworkId": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "networkId",
"documentation": "The numeric value placed in the Network Information Table (NIT)."
},
"NetworkName": {
"shape": "__string",
"shape": "__stringMin1Max256",
"locationName": "networkName",
"documentation": "The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters."
},
"NitInterval": {
"shape": "__integer",
"shape": "__integerMin25Max10000",
"locationName": "nitInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
}
},
"documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval."
"documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.",
"required": [
"NetworkName",
"NitInterval",
"NetworkId"
]
},
"DvbSdtSettings": {
"type": "structure",
@ -2181,17 +2601,17 @@
"locationName": "outputSdt"
},
"SdtInterval": {
"shape": "__integer",
"shape": "__integerMin25Max2000",
"locationName": "sdtInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
},
"ServiceName": {
"shape": "__string",
"shape": "__stringMin1Max256",
"locationName": "serviceName",
"documentation": "The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters."
},
"ServiceProviderName": {
"shape": "__string",
"shape": "__stringMin1Max256",
"locationName": "serviceProviderName",
"documentation": "The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters."
}
@ -2210,7 +2630,7 @@
"locationName": "backgroundColor"
},
"BackgroundOpacity": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "backgroundOpacity",
"documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
},
@ -2219,17 +2639,17 @@
"locationName": "fontColor"
},
"FontOpacity": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "fontOpacity",
"documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match."
},
"FontResolution": {
"shape": "__integer",
"shape": "__integerMin96Max600",
"locationName": "fontResolution",
"documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match."
},
"FontSize": {
"shape": "__integer",
"shape": "__integerMin0Max96",
"locationName": "fontSize",
"documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match."
},
@ -2238,7 +2658,7 @@
"locationName": "outlineColor"
},
"OutlineSize": {
"shape": "__integer",
"shape": "__integerMin0Max10",
"locationName": "outlineSize",
"documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
},
@ -2247,17 +2667,17 @@
"locationName": "shadowColor"
},
"ShadowOpacity": {
"shape": "__integer",
"shape": "__integerMin0Max255",
"locationName": "shadowOpacity",
"documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match."
},
"ShadowXOffset": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "shadowXOffset",
"documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match."
},
"ShadowYOffset": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "shadowYOffset",
"documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match."
},
@ -2266,23 +2686,29 @@
"locationName": "teletextSpacing"
},
"XPosition": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "xPosition",
"documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
},
"YPosition": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "yPosition",
"documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match."
}
},
"documentation": "DVB-Sub Destination Settings"
"documentation": "DVB-Sub Destination Settings",
"required": [
"OutlineColor",
"Alignment",
"OutlineSize",
"FontOpacity"
]
},
"DvbSubSourceSettings": {
"type": "structure",
"members": {
"Pid": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "pid",
"documentation": "When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors."
}
@ -2341,7 +2767,7 @@
},
"DvbSubtitleTeletextSpacing": {
"type": "string",
"documentation": "Controls whether a fixed grid size or proportional font spacing will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.",
"documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.",
"enum": [
"FIXED_GRID",
"PROPORTIONAL"
@ -2351,12 +2777,15 @@
"type": "structure",
"members": {
"TdtInterval": {
"shape": "__integer",
"shape": "__integerMin1000Max30000",
"locationName": "tdtInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
}
},
"documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval."
"documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.",
"required": [
"TdtInterval"
]
},
"Eac3AttenuationControl": {
"type": "string",
@ -2466,7 +2895,7 @@
"locationName": "attenuationControl"
},
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin64000Max640000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode."
},
@ -2483,7 +2912,7 @@
"locationName": "dcFilter"
},
"Dialnorm": {
"shape": "__integer",
"shape": "__integerMin1Max31",
"locationName": "dialnorm",
"documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through."
},
@ -2504,22 +2933,22 @@
"locationName": "lfeFilter"
},
"LoRoCenterMixLevel": {
"shape": "__double",
"shape": "__doubleMinNegative60Max3",
"locationName": "loRoCenterMixLevel",
"documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode.\nValid values: 3.0, 1.5, 0.0, -1.5 -3.0 -4.5 -6.0 -60"
},
"LoRoSurroundMixLevel": {
"shape": "__double",
"shape": "__doubleMinNegative60MaxNegative1",
"locationName": "loRoSurroundMixLevel",
"documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode.\nValid values: -1.5 -3.0 -4.5 -6.0 -60"
},
"LtRtCenterMixLevel": {
"shape": "__double",
"shape": "__doubleMinNegative60Max3",
"locationName": "ltRtCenterMixLevel",
"documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode.\nValid values: 3.0, 1.5, 0.0, -1.5 -3.0 -4.5 -6.0 -60"
},
"LtRtSurroundMixLevel": {
"shape": "__double",
"shape": "__doubleMinNegative60MaxNegative1",
"locationName": "ltRtSurroundMixLevel",
"documentation": "Left total/Right total surround mix level. Only used for 3/2 coding mode.\nValid values: -1.5 -3.0 -4.5 -6.0 -60"
},
@ -2536,7 +2965,7 @@
"locationName": "phaseControl"
},
"SampleRate": {
"shape": "__integer",
"shape": "__integerMin48000Max48000",
"locationName": "sampleRate",
"documentation": "Sample rate in hz. Sample rate is always 48000."
},
@ -2599,12 +3028,12 @@
"locationName": "convert608To708"
},
"Source608ChannelNumber": {
"shape": "__integer",
"shape": "__integerMin1Max4",
"locationName": "source608ChannelNumber",
"documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough."
},
"Source608TrackNumber": {
"shape": "__integer",
"shape": "__integerMin1Max1",
"locationName": "source608TrackNumber",
"documentation": "Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'."
}
@ -2653,7 +3082,7 @@
"type": "structure",
"members": {
"Destination": {
"shape": "__string",
"shape": "__stringPatternS3",
"locationName": "destination",
"documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file."
}
@ -2676,17 +3105,20 @@
"locationName": "convert608To708"
},
"SourceFile": {
"shape": "__string",
"shape": "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI",
"locationName": "sourceFile",
"documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', and 'smi'."
},
"TimeDelta": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "timeDelta",
"documentation": "Specifies a time delta in seconds to offset the captions from the source file."
}
},
"documentation": "Settings for File-based Captions in Source"
"documentation": "Settings for File-based Captions in Source",
"required": [
"SourceFile"
]
},
"ForbiddenException": {
"type": "structure",
@ -2706,22 +3138,22 @@
"type": "structure",
"members": {
"FramerateDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateDenominator",
"documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture."
},
"FramerateNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateNumerator",
"documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places."
},
"MaxCaptures": {
"shape": "__integer",
"shape": "__integerMin1Max10000000",
"locationName": "maxCaptures",
"documentation": "Maximum number of captures (encoded jpg output files)."
},
"Quality": {
"shape": "__integer",
"shape": "__integerMin1Max100",
"locationName": "quality",
"documentation": "JPEG Quality - a higher value equals higher quality."
}
@ -2893,7 +3325,7 @@
},
"H264FramerateControl": {
"type": "string",
"documentation": "Using the API, set FramerateControl to INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Using the console, do this by choosing INITIALIZE_FROM_SOURCE for Framerate.",
"documentation": "If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.",
"enum": [
"INITIALIZE_FROM_SOURCE",
"SPECIFIED"
@ -2925,7 +3357,7 @@
},
"H264InterlaceMode": {
"type": "string",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOw_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"enum": [
"PROGRESSIVE",
"TOP_FIELD",
@ -2953,7 +3385,7 @@
},
"H264RateControlMode": {
"type": "string",
"documentation": "Rate control mode. CQ uses constant quantizer (qp), ABR (average bitrate) does not write HRD parameters.",
"documentation": "Use this setting to specify whether this output has a variable bitrate (VBR) or constant bitrate (CBR).",
"enum": [
"VBR",
"CBR"
@ -2983,9 +3415,9 @@
"locationName": "adaptiveQuantization"
},
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin1000Max1152000000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Required for VBR, CBR, and ABR. Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000."
"documentation": "Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000."
},
"CodecLevel": {
"shape": "H264CodecLevel",
@ -3016,12 +3448,12 @@
"locationName": "framerateConversionAlgorithm"
},
"FramerateDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateDenominator",
"documentation": "When you use the API for transcode jobs that use framerate conversion, specify the framerate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use framerate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976."
},
"FramerateNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateNumerator",
"documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
},
@ -3030,12 +3462,12 @@
"locationName": "gopBReference"
},
"GopClosedCadence": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "gopClosedCadence",
"documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
},
"GopSize": {
"shape": "__double",
"shape": "__doubleMin0",
"locationName": "gopSize",
"documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero."
},
@ -3044,36 +3476,36 @@
"locationName": "gopSizeUnits"
},
"HrdBufferInitialFillPercentage": {
"shape": "__integer",
"shape": "__integerMin0Max100",
"locationName": "hrdBufferInitialFillPercentage",
"documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)."
},
"HrdBufferSize": {
"shape": "__integer",
"shape": "__integerMin0Max1152000000",
"locationName": "hrdBufferSize",
"documentation": "Size of buffer (HRD buffer model). Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m."
"documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000."
},
"InterlaceMode": {
"shape": "H264InterlaceMode",
"locationName": "interlaceMode"
},
"MaxBitrate": {
"shape": "__integer",
"shape": "__integerMin1000Max1152000000",
"locationName": "maxBitrate",
"documentation": "Maximum bitrate in bits/second (for VBR mode only). Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m."
"documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000."
},
"MinIInterval": {
"shape": "__integer",
"shape": "__integerMin0Max30",
"locationName": "minIInterval",
"documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
},
"NumberBFramesBetweenReferenceFrames": {
"shape": "__integer",
"shape": "__integerMin0Max7",
"locationName": "numberBFramesBetweenReferenceFrames",
"documentation": "Number of B-frames between reference frames."
},
"NumberReferenceFrames": {
"shape": "__integer",
"shape": "__integerMin1Max6",
"locationName": "numberReferenceFrames",
"documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding."
},
@ -3082,12 +3514,12 @@
"locationName": "parControl"
},
"ParDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parDenominator",
"documentation": "Pixel Aspect Ratio denominator."
},
"ParNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parNumerator",
"documentation": "Pixel Aspect Ratio numerator."
},
@ -3108,7 +3540,7 @@
"locationName": "sceneChangeDetect"
},
"Slices": {
"shape": "__integer",
"shape": "__integerMin1Max32",
"locationName": "slices",
"documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures."
},
@ -3117,7 +3549,7 @@
"locationName": "slowPal"
},
"Softness": {
"shape": "__integer",
"shape": "__integerMin0Max128",
"locationName": "softness",
"documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image."
},
@ -3257,7 +3689,7 @@
},
"H265FramerateControl": {
"type": "string",
"documentation": "Using the API, set FramerateControl to INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Using the console, do this by choosing INITIALIZE_FROM_SOURCE for Framerate.",
"documentation": "If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.",
"enum": [
"INITIALIZE_FROM_SOURCE",
"SPECIFIED"
@ -3289,7 +3721,7 @@
},
"H265InterlaceMode": {
"type": "string",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOw_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"enum": [
"PROGRESSIVE",
"TOP_FIELD",
@ -3317,7 +3749,7 @@
},
"H265RateControlMode": {
"type": "string",
"documentation": "Rate control mode. CQ uses constant quantizer (qp), ABR (average bitrate) does not write HRD parameters.",
"documentation": "Use this setting to specify whether this output has a variable bitrate (VBR) or constant bitrate (CBR).",
"enum": [
"VBR",
"CBR"
@ -3352,9 +3784,9 @@
"locationName": "alternateTransferFunctionSei"
},
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin1000Max1466400000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Required for VBR, CBR, and ABR. Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000."
"documentation": "Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000."
},
"CodecLevel": {
"shape": "H265CodecLevel",
@ -3377,12 +3809,12 @@
"locationName": "framerateConversionAlgorithm"
},
"FramerateDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateDenominator",
"documentation": "Framerate denominator."
},
"FramerateNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateNumerator",
"documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
},
@ -3391,12 +3823,12 @@
"locationName": "gopBReference"
},
"GopClosedCadence": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "gopClosedCadence",
"documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
},
"GopSize": {
"shape": "__double",
"shape": "__doubleMin0",
"locationName": "gopSize",
"documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero."
},
@ -3405,36 +3837,36 @@
"locationName": "gopSizeUnits"
},
"HrdBufferInitialFillPercentage": {
"shape": "__integer",
"shape": "__integerMin0Max100",
"locationName": "hrdBufferInitialFillPercentage",
"documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)."
},
"HrdBufferSize": {
"shape": "__integer",
"shape": "__integerMin0Max1466400000",
"locationName": "hrdBufferSize",
"documentation": "Size of buffer (HRD buffer model). Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m."
"documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000."
},
"InterlaceMode": {
"shape": "H265InterlaceMode",
"locationName": "interlaceMode"
},
"MaxBitrate": {
"shape": "__integer",
"shape": "__integerMin1000Max1466400000",
"locationName": "maxBitrate",
"documentation": "Maximum bitrate in bits/second (for VBR mode only). Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m."
"documentation": "Maximum bitrate in bits/second."
},
"MinIInterval": {
"shape": "__integer",
"shape": "__integerMin0Max30",
"locationName": "minIInterval",
"documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
},
"NumberBFramesBetweenReferenceFrames": {
"shape": "__integer",
"shape": "__integerMin0Max7",
"locationName": "numberBFramesBetweenReferenceFrames",
"documentation": "Number of B-frames between reference frames."
},
"NumberReferenceFrames": {
"shape": "__integer",
"shape": "__integerMin1Max6",
"locationName": "numberReferenceFrames",
"documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding."
},
@ -3443,12 +3875,12 @@
"locationName": "parControl"
},
"ParDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parDenominator",
"documentation": "Pixel Aspect Ratio denominator."
},
"ParNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parNumerator",
"documentation": "Pixel Aspect Ratio numerator."
},
@ -3469,7 +3901,7 @@
"locationName": "sceneChangeDetect"
},
"Slices": {
"shape": "__integer",
"shape": "__integerMin1Max32",
"locationName": "slices",
"documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures."
},
@ -3500,6 +3932,10 @@
"UnregisteredSeiTimecode": {
"shape": "H265UnregisteredSeiTimecode",
"locationName": "unregisteredSeiTimecode"
},
"WriteMp4PackagingType": {
"shape": "H265WriteMp4PackagingType",
"locationName": "writeMp4PackagingType"
}
},
"documentation": "Settings for H265 codec"
@ -3561,71 +3997,83 @@
"ENABLED"
]
},
"H265WriteMp4PackagingType": {
"type": "string",
"documentation": "If HVC1, output that is H.265 will be marked as HVC1 and adhere to the ISO-IECJTC1-SC29_N13798_Text_ISOIEC_FDIS_14496-15_3rd_E spec which states that parameter set NAL units will be stored in the sample headers but not in the samples directly. If HEV1, then H.265 will be marked as HEV1 and parameter set NAL units will be written into the samples.",
"enum": [
"HVC1",
"HEV1"
]
},
"Hdr10Metadata": {
"type": "structure",
"members": {
"BluePrimaryX": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "bluePrimaryX",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"BluePrimaryY": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "bluePrimaryY",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"GreenPrimaryX": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "greenPrimaryX",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"GreenPrimaryY": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "greenPrimaryY",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"MaxContentLightLevel": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "maxContentLightLevel",
"documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter."
},
"MaxFrameAverageLightLevel": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "maxFrameAverageLightLevel",
"documentation": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter."
},
"MaxLuminance": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "maxLuminance",
"documentation": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter."
},
"MinLuminance": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "minLuminance",
"documentation": "Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter"
},
"RedPrimaryX": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "redPrimaryX",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"RedPrimaryY": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "redPrimaryY",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"WhitePointX": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "whitePointX",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
},
"WhitePointY": {
"shape": "__integer",
"shape": "__integerMin0Max50000",
"locationName": "whitePointY",
"documentation": "HDR Master Display Information comes from the color grader and the color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction."
}
},
"documentation": "Use the HDR master display (Hdr10Metadata) settings to provide values for HDR color. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate."
"documentation": "Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the HVC1 for H.265 setting.",
"required": [
"MaxContentLightLevel",
"MaxFrameAverageLightLevel"
]
},
"HlsAdMarkers": {
"type": "string",
@ -3648,10 +4096,15 @@
"type": "structure",
"members": {
"CaptionChannel": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "captionChannel",
"documentation": "Caption channel."
},
"CustomLanguageCode": {
"shape": "__stringMin3Max3PatternAZaZ3",
"locationName": "customLanguageCode",
"documentation": "Specify the language for this caption channel, using the ISO 639-2 or ISO 639-3 three-letter language code"
},
"LanguageCode": {
"shape": "LanguageCode",
"locationName": "languageCode"
@ -3701,7 +4154,7 @@
"type": "structure",
"members": {
"ConstantInitializationVector": {
"shape": "__string",
"shape": "__stringMin32Max32Pattern09aFAF32",
"locationName": "constantInitializationVector",
"documentation": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default."
},
@ -3726,7 +4179,10 @@
"locationName": "type"
}
},
"documentation": "Settings for HLS encryption"
"documentation": "Settings for HLS encryption",
"required": [
"Type"
]
},
"HlsEncryptionType": {
"type": "string",
@ -3740,7 +4196,7 @@
"type": "structure",
"members": {
"AdMarkers": {
"shape": "ListOfHlsAdMarkers",
"shape": "__listOfHlsAdMarkers",
"locationName": "adMarkers",
"documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs."
},
@ -3750,7 +4206,7 @@
"documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
},
"CaptionLanguageMappings": {
"shape": "ListOfHlsCaptionLanguageMapping",
"shape": "__listOfHlsCaptionLanguageMapping",
"locationName": "captionLanguageMappings",
"documentation": "Language to be used on Caption outputs"
},
@ -3767,7 +4223,7 @@
"locationName": "codecSpecification"
},
"Destination": {
"shape": "__string",
"shape": "__stringPatternS3",
"locationName": "destination",
"documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file."
},
@ -3789,7 +4245,7 @@
"locationName": "manifestDurationFormat"
},
"MinSegmentLength": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "minSegmentLength",
"documentation": "When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed."
},
@ -3802,7 +4258,7 @@
"locationName": "programDateTime"
},
"ProgramDateTimePeriod": {
"shape": "__integer",
"shape": "__integerMin0Max3600",
"locationName": "programDateTimePeriod",
"documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds."
},
@ -3811,12 +4267,12 @@
"locationName": "segmentControl"
},
"SegmentLength": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "segmentLength",
"documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer."
},
"SegmentsPerSubdirectory": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "segmentsPerSubdirectory",
"documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect."
},
@ -3829,17 +4285,21 @@
"locationName": "timedMetadataId3Frame"
},
"TimedMetadataId3Period": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "timedMetadataId3Period",
"documentation": "Timed Metadata interval in seconds."
},
"TimestampDeltaMilliseconds": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "timestampDeltaMilliseconds",
"documentation": "Provides an extra millisecond delta offset to fine tune the timestamps."
}
},
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS."
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.",
"required": [
"MinSegmentLength",
"SegmentLength"
]
},
"HlsIFrameOnlyManifest": {
"type": "string",
@ -3955,44 +4415,51 @@
"type": "structure",
"members": {
"Id3": {
"shape": "__string",
"shape": "__stringPatternAZaZ0902",
"locationName": "id3",
"documentation": "Use ID3 tag (Id3) to provide a tag value in base64-encode format."
},
"Timecode": {
"shape": "__string",
"shape": "__stringPattern010920405090509092",
"locationName": "timecode",
"documentation": "Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format."
}
},
"documentation": "To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create mulitple instances of ID3 insertion (Id3Insertion)."
"documentation": "To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion (Id3Insertion).",
"required": [
"Timecode",
"Id3"
]
},
"ImageInserter": {
"type": "structure",
"members": {
"InsertableImages": {
"shape": "ListOfInsertableImage",
"shape": "__listOfInsertableImage",
"locationName": "insertableImages",
"documentation": "Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames."
}
},
"documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default."
"documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.",
"required": [
"InsertableImages"
]
},
"Input": {
"type": "structure",
"members": {
"AudioSelectorGroups": {
"shape": "MapOfAudioSelectorGroup",
"shape": "__mapOfAudioSelectorGroup",
"locationName": "audioSelectorGroups",
"documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information."
},
"AudioSelectors": {
"shape": "MapOfAudioSelector",
"shape": "__mapOfAudioSelector",
"locationName": "audioSelectors",
"documentation": "Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input."
},
"CaptionSelectors": {
"shape": "MapOfCaptionSelector",
"shape": "__mapOfCaptionSelector",
"locationName": "captionSelectors",
"documentation": "Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input."
},
@ -4005,7 +4472,7 @@
"locationName": "denoiseFilter"
},
"FileInput": {
"shape": "__string",
"shape": "__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MM",
"locationName": "fileInput",
"documentation": "Use Input (fileInput) to define the source file used in the transcode job. There can be multiple inputs in a job. These inputs are concantenated, in the order they are specified in the job, to create the output."
},
@ -4014,17 +4481,17 @@
"locationName": "filterEnable"
},
"FilterStrength": {
"shape": "__integer",
"shape": "__integerMinNegative5Max5",
"locationName": "filterStrength",
"documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0."
},
"InputClippings": {
"shape": "ListOfInputClipping",
"shape": "__listOfInputClipping",
"locationName": "inputClippings",
"documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them."
},
"ProgramNumber": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "programNumber",
"documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default."
},
@ -4041,23 +4508,26 @@
"locationName": "videoSelector"
}
},
"documentation": "Specifies media input"
"documentation": "Specifies media input",
"required": [
"FileInput"
]
},
"InputClipping": {
"type": "structure",
"members": {
"EndTimecode": {
"shape": "__string",
"shape": "__stringPattern010920405090509092",
"locationName": "endTimecode",
"documentation": "Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:00:05:00."
"documentation": "Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00."
},
"StartTimecode": {
"shape": "__string",
"shape": "__stringPattern010920405090509092",
"locationName": "startTimecode",
"documentation": "Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:00:05:00."
"documentation": "Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00."
}
},
"documentation": "Include one instance of (InputClipping) for each input clip."
"documentation": "To transcode only portions of your input (clips), include one Input clipping (one instance of InputClipping in the JSON job file) for each input clip. All input clips you specify will be included in every output of the job."
},
"InputDeblockFilter": {
"type": "string",
@ -4096,17 +4566,17 @@
"type": "structure",
"members": {
"AudioSelectorGroups": {
"shape": "MapOfAudioSelectorGroup",
"shape": "__mapOfAudioSelectorGroup",
"locationName": "audioSelectorGroups",
"documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information."
},
"AudioSelectors": {
"shape": "MapOfAudioSelector",
"shape": "__mapOfAudioSelector",
"locationName": "audioSelectors",
"documentation": "Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input."
},
"CaptionSelectors": {
"shape": "MapOfCaptionSelector",
"shape": "__mapOfCaptionSelector",
"locationName": "captionSelectors",
"documentation": "Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input."
},
@ -4123,17 +4593,17 @@
"locationName": "filterEnable"
},
"FilterStrength": {
"shape": "__integer",
"shape": "__integerMinNegative5Max5",
"locationName": "filterStrength",
"documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0."
},
"InputClippings": {
"shape": "ListOfInputClipping",
"shape": "__listOfInputClipping",
"locationName": "inputClippings",
"documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them."
},
"ProgramNumber": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "programNumber",
"documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default."
},
@ -4154,7 +4624,7 @@
},
"InputTimecodeSource": {
"type": "string",
"documentation": "Use Timecode source (InputTimecodeSource) to specify how timecode information from your input is adjusted and encoded in all outputs for the job. Default is embedded. Set to Embedded (EMBEDDED) to use the timecode that is in the input video. If no embedded timecode is in the source, will set the timecode for the first frame to 00:00:00:00. Set to Start at 0 (ZEROBASED) to set the timecode of the initial frame to 00:00:00:00. Set to Specified start (SPECIFIEDSTART) to provide the initial timecode yourself the setting (Start).",
"documentation": "Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes.",
"enum": [
"EMBEDDED",
"ZEROBASED",
@ -4165,62 +4635,69 @@
"type": "structure",
"members": {
"Duration": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "duration",
"documentation": "Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video."
},
"FadeIn": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "fadeIn",
"documentation": "Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time."
},
"FadeOut": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "fadeOut",
"documentation": "Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration."
},
"Height": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "height",
"documentation": "Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image."
},
"ImageInserterInput": {
"shape": "__string",
"shape": "__stringMin14PatternS3BmpBMPPngPNGTgaTGA",
"locationName": "imageInserterInput",
"documentation": "Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame."
},
"ImageX": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "imageX",
"documentation": "Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input."
},
"ImageY": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "imageY",
"documentation": "Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input."
},
"Layer": {
"shape": "__integer",
"shape": "__integerMin0Max99",
"locationName": "layer",
"documentation": "Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer."
},
"Opacity": {
"shape": "__integer",
"shape": "__integerMin0Max100",
"locationName": "opacity",
"documentation": "Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50."
},
"StartTime": {
"shape": "__string",
"shape": "__stringPattern01D20305D205D",
"locationName": "startTime",
"documentation": "Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode format (HH:MM:SS:FF)"
"documentation": "Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format."
},
"Width": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "width",
"documentation": "Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image."
}
},
"documentation": "Settings for Insertable Image"
"documentation": "Settings for Insertable Image",
"required": [
"ImageY",
"ImageX",
"ImageInserterInput",
"Opacity",
"Layer"
]
},
"InternalServerErrorException": {
"type": "structure",
@ -4245,7 +4722,7 @@
"documentation": "An identifier for this resource that is unique within all of AWS."
},
"CreatedAt": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "createdAt",
"documentation": "The time, in Unix epoch format in seconds, when the job got created."
},
@ -4270,7 +4747,7 @@
"documentation": "The job template that the job is created from, if it is created from a job template."
},
"OutputGroupDetails": {
"shape": "ListOfOutputGroupDetail",
"shape": "__listOfOutputGroupDetail",
"locationName": "outputGroupDetails",
"documentation": "List of output group details"
},
@ -4297,18 +4774,22 @@
"locationName": "timing"
},
"UserMetadata": {
"shape": "MapOf__string",
"shape": "__mapOf__string",
"locationName": "userMetadata",
"documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs."
}
},
"documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html"
"documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html",
"required": [
"Role",
"Settings"
]
},
"JobSettings": {
"type": "structure",
"members": {
"AdAvailOffset": {
"shape": "__integer",
"shape": "__integerMinNegative1000Max1000",
"locationName": "adAvailOffset",
"documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time."
},
@ -4318,7 +4799,7 @@
"documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails."
},
"Inputs": {
"shape": "ListOfInput",
"shape": "__listOfInput",
"locationName": "inputs",
"documentation": "Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output."
},
@ -4327,9 +4808,9 @@
"locationName": "nielsenConfiguration"
},
"OutputGroups": {
"shape": "ListOfOutputGroup",
"shape": "__listOfOutputGroup",
"locationName": "outputGroups",
"documentation": "**!!**(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings"
"documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings"
},
"TimecodeConfig": {
"shape": "TimecodeConfig",
@ -4341,7 +4822,11 @@
"locationName": "timedMetadataInsertion"
}
},
"documentation": "JobSettings contains all the transcode settings for a job."
"documentation": "JobSettings contains all the transcode settings for a job.",
"required": [
"OutputGroups",
"Inputs"
]
},
"JobStatus": {
"type": "string",
@ -4368,7 +4853,7 @@
"documentation": "An optional category you create to organize your job templates."
},
"CreatedAt": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "createdAt",
"documentation": "The timestamp in epoch seconds for Job template creation."
},
@ -4378,7 +4863,7 @@
"documentation": "An optional description you create for each job template."
},
"LastUpdated": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "lastUpdated",
"documentation": "The timestamp in epoch seconds when the Job template was last updated."
},
@ -4402,7 +4887,11 @@
"documentation": "A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user."
}
},
"documentation": "A job template is a pre-made set of encoding instructions that you can use to quickly create a job."
"documentation": "A job template is a pre-made set of encoding instructions that you can use to quickly create a job.",
"required": [
"Settings",
"Name"
]
},
"JobTemplateListBy": {
"type": "string",
@ -4417,7 +4906,7 @@
"type": "structure",
"members": {
"AdAvailOffset": {
"shape": "__integer",
"shape": "__integerMinNegative1000Max1000",
"locationName": "adAvailOffset",
"documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time."
},
@ -4427,7 +4916,7 @@
"documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails."
},
"Inputs": {
"shape": "ListOfInputTemplate",
"shape": "__listOfInputTemplate",
"locationName": "inputs",
"documentation": "Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template."
},
@ -4436,9 +4925,9 @@
"locationName": "nielsenConfiguration"
},
"OutputGroups": {
"shape": "ListOfOutputGroup",
"shape": "__listOfOutputGroup",
"locationName": "outputGroups",
"documentation": "**!!**(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings"
"documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings"
},
"TimecodeConfig": {
"shape": "TimecodeConfig",
@ -4450,11 +4939,14 @@
"locationName": "timedMetadataInsertion"
}
},
"documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it."
"documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.",
"required": [
"OutputGroups"
]
},
"LanguageCode": {
"type": "string",
"documentation": "Code to specify the language, following the specification \"ISO 639-2 three-digit code\":http://www.loc.gov/standards/iso639-2/",
"documentation": "Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.",
"enum": [
"ENG",
"SPA",
@ -4664,7 +5156,7 @@
"location": "querystring"
},
"MaxResults": {
"shape": "__integer",
"shape": "__integerMin1Max20",
"locationName": "maxResults",
"documentation": "Optional. Number of job templates, up to twenty, that will be returned at one time.",
"location": "querystring"
@ -4686,7 +5178,7 @@
"type": "structure",
"members": {
"JobTemplates": {
"shape": "ListOfJobTemplate",
"shape": "__listOfJobTemplate",
"locationName": "jobTemplates",
"documentation": "List of Job templates."
},
@ -4701,7 +5193,7 @@
"type": "structure",
"members": {
"MaxResults": {
"shape": "__integer",
"shape": "__integerMin1Max20",
"locationName": "maxResults",
"documentation": "Optional. Number of jobs, up to twenty, that will be returned at one time.",
"location": "querystring"
@ -4734,7 +5226,7 @@
"type": "structure",
"members": {
"Jobs": {
"shape": "ListOfJob",
"shape": "__listOfJob",
"locationName": "jobs",
"documentation": "List of jobs"
},
@ -4745,138 +5237,6 @@
}
}
},
"ListOfAudioDescription": {
"type": "list",
"member": {
"shape": "AudioDescription"
}
},
"ListOfCaptionDescription": {
"type": "list",
"member": {
"shape": "CaptionDescription"
}
},
"ListOfCaptionDescriptionPreset": {
"type": "list",
"member": {
"shape": "CaptionDescriptionPreset"
}
},
"ListOfEndpoint": {
"type": "list",
"member": {
"shape": "Endpoint"
}
},
"ListOfHlsAdMarkers": {
"type": "list",
"member": {
"shape": "HlsAdMarkers"
}
},
"ListOfHlsCaptionLanguageMapping": {
"type": "list",
"member": {
"shape": "HlsCaptionLanguageMapping"
}
},
"ListOfId3Insertion": {
"type": "list",
"member": {
"shape": "Id3Insertion"
}
},
"ListOfInput": {
"type": "list",
"member": {
"shape": "Input"
}
},
"ListOfInputClipping": {
"type": "list",
"member": {
"shape": "InputClipping"
}
},
"ListOfInputTemplate": {
"type": "list",
"member": {
"shape": "InputTemplate"
}
},
"ListOfInsertableImage": {
"type": "list",
"member": {
"shape": "InsertableImage"
}
},
"ListOfJob": {
"type": "list",
"member": {
"shape": "Job"
}
},
"ListOfJobTemplate": {
"type": "list",
"member": {
"shape": "JobTemplate"
}
},
"ListOfOutput": {
"type": "list",
"member": {
"shape": "Output"
}
},
"ListOfOutputChannelMapping": {
"type": "list",
"member": {
"shape": "OutputChannelMapping"
}
},
"ListOfOutputDetail": {
"type": "list",
"member": {
"shape": "OutputDetail"
}
},
"ListOfOutputGroup": {
"type": "list",
"member": {
"shape": "OutputGroup"
}
},
"ListOfOutputGroupDetail": {
"type": "list",
"member": {
"shape": "OutputGroupDetail"
}
},
"ListOfPreset": {
"type": "list",
"member": {
"shape": "Preset"
}
},
"ListOfQueue": {
"type": "list",
"member": {
"shape": "Queue"
}
},
"ListOf__integer": {
"type": "list",
"member": {
"shape": "__integer"
}
},
"ListOf__string": {
"type": "list",
"member": {
"shape": "__string"
}
},
"ListPresetsRequest": {
"type": "structure",
"members": {
@ -4892,7 +5252,7 @@
"location": "querystring"
},
"MaxResults": {
"shape": "__integer",
"shape": "__integerMin1Max20",
"locationName": "maxResults",
"documentation": "Optional. Number of presets, up to twenty, that will be returned at one time",
"location": "querystring"
@ -4919,7 +5279,7 @@
"documentation": "Use this string to request the next batch of presets."
},
"Presets": {
"shape": "ListOfPreset",
"shape": "__listOfPreset",
"locationName": "presets",
"documentation": "List of presets"
}
@ -4934,7 +5294,7 @@
"location": "querystring"
},
"MaxResults": {
"shape": "__integer",
"shape": "__integerMin1Max20",
"locationName": "maxResults",
"documentation": "Optional. Number of queues, up to twenty, that will be returned at one time.",
"location": "querystring"
@ -4961,12 +5321,35 @@
"documentation": "Use this string to request the next batch of queues."
},
"Queues": {
"shape": "ListOfQueue",
"shape": "__listOfQueue",
"locationName": "queues",
"documentation": "List of queues"
}
}
},
"ListTagsForResourceRequest": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request with the resource name.",
"location": "uri"
}
},
"required": [
"Arn"
]
},
"ListTagsForResourceResponse": {
"type": "structure",
"members": {
"ResourceTags": {
"shape": "ResourceTags",
"locationName": "resourceTags"
}
}
},
"M2tsAudioBufferModel": {
"type": "string",
"documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio.",
@ -5067,17 +5450,17 @@
"locationName": "audioBufferModel"
},
"AudioFramesPerPes": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "audioFramesPerPes",
"documentation": "The number of audio frames to insert for each PES packet."
},
"AudioPids": {
"shape": "ListOf__integer",
"shape": "__listOf__integerMin32Max8182",
"locationName": "audioPids",
"documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation."
},
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "bitrate",
"documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000."
},
@ -5094,7 +5477,7 @@
"locationName": "dvbSdtSettings"
},
"DvbSubPids": {
"shape": "ListOf__integer",
"shape": "__listOf__integerMin32Max8182",
"locationName": "dvbSubPids",
"documentation": "Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation."
},
@ -5103,7 +5486,7 @@
"locationName": "dvbTdtSettings"
},
"DvbTeletextPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "dvbTeletextPid",
"documentation": "Packet Identifier (PID) for input source DVB Teletext data to this output."
},
@ -5120,17 +5503,17 @@
"locationName": "esRateInPes"
},
"FragmentTime": {
"shape": "__double",
"shape": "__doubleMin0",
"locationName": "fragmentTime",
"documentation": "The length in seconds of each fragment. Only used with EBP markers."
},
"MaxPcrInterval": {
"shape": "__integer",
"shape": "__integerMin0Max500",
"locationName": "maxPcrInterval",
"documentation": "Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream."
},
"MinEbpInterval": {
"shape": "__integer",
"shape": "__integerMin0Max10000",
"locationName": "minEbpInterval",
"documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate."
},
@ -5139,12 +5522,12 @@
"locationName": "nielsenId3"
},
"NullPacketBitrate": {
"shape": "__double",
"shape": "__doubleMin0",
"locationName": "nullPacketBitrate",
"documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets."
},
"PatInterval": {
"shape": "__integer",
"shape": "__integerMin0Max1000",
"locationName": "patInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
},
@ -5153,27 +5536,27 @@
"locationName": "pcrControl"
},
"PcrPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "pcrPid",
"documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID."
},
"PmtInterval": {
"shape": "__integer",
"shape": "__integerMin0Max1000",
"locationName": "pmtInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
},
"PmtPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "pmtPid",
"documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream."
},
"PrivateMetadataPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "privateMetadataPid",
"documentation": "Packet Identifier (PID) of the private metadata stream in the transport stream."
},
"ProgramNumber": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "programNumber",
"documentation": "The value of the program number field in the Program Map Table."
},
@ -5182,7 +5565,7 @@
"locationName": "rateMode"
},
"Scte35Pid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "scte35Pid",
"documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream."
},
@ -5199,22 +5582,22 @@
"locationName": "segmentationStyle"
},
"SegmentationTime": {
"shape": "__double",
"shape": "__doubleMin0",
"locationName": "segmentationTime",
"documentation": "The length in seconds of each segment. Required unless markers is set to _none_."
},
"TimedMetadataPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "timedMetadataPid",
"documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream."
},
"TransportStreamId": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "transportStreamId",
"documentation": "The value of the transport stream ID field in the Program Map Table."
},
"VideoPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "videoPid",
"documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream."
}
@ -5249,12 +5632,12 @@
"type": "structure",
"members": {
"AudioFramesPerPes": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "audioFramesPerPes",
"documentation": "The number of audio frames to insert for each PES packet."
},
"AudioPids": {
"shape": "ListOf__integer",
"shape": "__listOf__integerMin32Max8182",
"locationName": "audioPids",
"documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation."
},
@ -5263,7 +5646,7 @@
"locationName": "nielsenId3"
},
"PatInterval": {
"shape": "__integer",
"shape": "__integerMin0Max1000",
"locationName": "patInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
},
@ -5272,32 +5655,32 @@
"locationName": "pcrControl"
},
"PcrPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "pcrPid",
"documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID."
},
"PmtInterval": {
"shape": "__integer",
"shape": "__integerMin0Max1000",
"locationName": "pmtInterval",
"documentation": "The number of milliseconds between instances of this table in the output transport stream."
},
"PmtPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "pmtPid",
"documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream."
},
"PrivateMetadataPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "privateMetadataPid",
"documentation": "Packet Identifier (PID) of the private metadata stream in the transport stream."
},
"ProgramNumber": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "programNumber",
"documentation": "The value of the program number field in the Program Map Table."
},
"Scte35Pid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "scte35Pid",
"documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream."
},
@ -5310,59 +5693,23 @@
"locationName": "timedMetadata"
},
"TimedMetadataPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "timedMetadataPid",
"documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream."
},
"TransportStreamId": {
"shape": "__integer",
"shape": "__integerMin0Max65535",
"locationName": "transportStreamId",
"documentation": "The value of the transport stream ID field in the Program Map Table."
},
"VideoPid": {
"shape": "__integer",
"shape": "__integerMin32Max8182",
"locationName": "videoPid",
"documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream."
}
},
"documentation": "Settings for TS segments in HLS"
},
"MapOfAudioSelector": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "AudioSelector"
}
},
"MapOfAudioSelectorGroup": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "AudioSelectorGroup"
}
},
"MapOfCaptionSelector": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "CaptionSelector"
}
},
"MapOf__string": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "__string"
}
},
"MovClapAtom": {
"type": "string",
"documentation": "When enabled, include 'clap' atom if appropriate for the video output settings.",
@ -5433,17 +5780,17 @@
"type": "structure",
"members": {
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin32000Max384000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second."
},
"Channels": {
"shape": "__integer",
"shape": "__integerMin1Max2",
"locationName": "channels",
"documentation": "Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2."
},
"SampleRate": {
"shape": "__integer",
"shape": "__integerMin32000Max48000",
"locationName": "sampleRate",
"documentation": "Sample rate in hz."
}
@ -5528,7 +5875,7 @@
},
"Mpeg2FramerateControl": {
"type": "string",
"documentation": "Using the API, set FramerateControl to INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Using the console, do this by choosing INITIALIZE_FROM_SOURCE for Framerate.",
"documentation": "If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.",
"enum": [
"INITIALIZE_FROM_SOURCE",
"SPECIFIED"
@ -5552,7 +5899,7 @@
},
"Mpeg2InterlaceMode": {
"type": "string",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOw_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"enum": [
"PROGRESSIVE",
"TOP_FIELD",
@ -5612,9 +5959,9 @@
"locationName": "adaptiveQuantization"
},
"Bitrate": {
"shape": "__integer",
"shape": "__integerMin1000Max288000000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Required for VBR, CBR, and ABR. Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000."
"documentation": "Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000."
},
"CodecLevel": {
"shape": "Mpeg2CodecLevel",
@ -5633,22 +5980,22 @@
"locationName": "framerateConversionAlgorithm"
},
"FramerateDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max1001",
"locationName": "framerateDenominator",
"documentation": "Framerate denominator."
},
"FramerateNumerator": {
"shape": "__integer",
"shape": "__integerMin24Max60000",
"locationName": "framerateNumerator",
"documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
},
"GopClosedCadence": {
"shape": "__integer",
"shape": "__integerMin0Max2147483647",
"locationName": "gopClosedCadence",
"documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
},
"GopSize": {
"shape": "__double",
"shape": "__doubleMin0",
"locationName": "gopSize",
"documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero."
},
@ -5657,14 +6004,14 @@
"locationName": "gopSizeUnits"
},
"HrdBufferInitialFillPercentage": {
"shape": "__integer",
"shape": "__integerMin0Max100",
"locationName": "hrdBufferInitialFillPercentage",
"documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)."
},
"HrdBufferSize": {
"shape": "__integer",
"shape": "__integerMin0Max47185920",
"locationName": "hrdBufferSize",
"documentation": "Size of buffer (HRD buffer model). Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m."
"documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000."
},
"InterlaceMode": {
"shape": "Mpeg2InterlaceMode",
@ -5675,17 +6022,17 @@
"locationName": "intraDcPrecision"
},
"MaxBitrate": {
"shape": "__integer",
"shape": "__integerMin1000Max300000000",
"locationName": "maxBitrate",
"documentation": "Maximum bitrate in bits/second (for VBR mode only). Five megabits can be entered as 5000000 or 5m. Five hundred kilobits can be entered as 500000 or 0.5m."
"documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000."
},
"MinIInterval": {
"shape": "__integer",
"shape": "__integerMin0Max30",
"locationName": "minIInterval",
"documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
},
"NumberBFramesBetweenReferenceFrames": {
"shape": "__integer",
"shape": "__integerMin0Max7",
"locationName": "numberBFramesBetweenReferenceFrames",
"documentation": "Number of B-frames between reference frames."
},
@ -5694,12 +6041,12 @@
"locationName": "parControl"
},
"ParDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parDenominator",
"documentation": "Pixel Aspect Ratio denominator."
},
"ParNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parNumerator",
"documentation": "Pixel Aspect Ratio numerator."
},
@ -5720,7 +6067,7 @@
"locationName": "slowPal"
},
"Softness": {
"shape": "__integer",
"shape": "__integerMin0Max128",
"locationName": "softness",
"documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image."
},
@ -5800,7 +6147,10 @@
"locationName": "spekeKeyProvider"
}
},
"documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider."
"documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.",
"required": [
"SpekeKeyProvider"
]
},
"MsSmoothGroupSettings": {
"type": "structure",
@ -5810,7 +6160,7 @@
"locationName": "audioDeduplication"
},
"Destination": {
"shape": "__string",
"shape": "__stringPatternS3",
"locationName": "destination",
"documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file."
},
@ -5819,7 +6169,7 @@
"locationName": "encryption"
},
"FragmentLength": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "fragmentLength",
"documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and framerate."
},
@ -5828,7 +6178,10 @@
"locationName": "manifestEncoding"
}
},
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS."
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.",
"required": [
"FragmentLength"
]
},
"MsSmoothManifestEncoding": {
"type": "string",
@ -5842,7 +6195,7 @@
"type": "structure",
"members": {
"BreakoutCode": {
"shape": "__integer",
"shape": "__integerMin0Max9",
"locationName": "breakoutCode",
"documentation": "Use Nielsen Configuration (NielsenConfiguration) to set the Nielsen measurement system breakout code. Supported values are 0, 3, 7, and 9."
},
@ -5870,11 +6223,14 @@
"locationName": "spatialFilterSettings"
}
},
"documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. When you enable Noise reducer (NoiseReducer), you must also select a value for Noise reducer filter (NoiseReducerFilter)."
"documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. When you enable Noise reducer (NoiseReducer), you must also select a value for Noise reducer filter (NoiseReducerFilter).",
"required": [
"Filter"
]
},
"NoiseReducerFilter": {
"type": "string",
"documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters * Conserve is a min/max noise reduction filter * Spatial is frequency-domain filter based on JND principles.",
"documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles.",
"enum": [
"BILATERAL",
"MEAN",
@ -5889,7 +6245,7 @@
"type": "structure",
"members": {
"Strength": {
"shape": "__integer",
"shape": "__integerMin0Max3",
"locationName": "strength",
"documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering."
}
@ -5900,17 +6256,17 @@
"type": "structure",
"members": {
"PostFilterSharpenStrength": {
"shape": "__integer",
"shape": "__integerMin0Max3",
"locationName": "postFilterSharpenStrength",
"documentation": "Specify strength of post noise reduction sharpening filter, with 0 disabling the filter and 3 enabling it at maximum strength."
},
"Speed": {
"shape": "__integer",
"shape": "__integerMinNegative2Max3",
"locationName": "speed",
"documentation": "The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value."
},
"Strength": {
"shape": "__integer",
"shape": "__integerMin0Max16",
"locationName": "strength",
"documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering."
}
@ -5943,12 +6299,12 @@
"type": "structure",
"members": {
"AudioDescriptions": {
"shape": "ListOfAudioDescription",
"shape": "__listOfAudioDescription",
"locationName": "audioDescriptions",
"documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings."
},
"CaptionDescriptions": {
"shape": "ListOfCaptionDescription",
"shape": "__listOfCaptionDescription",
"locationName": "captionDescriptions",
"documentation": "(CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings."
},
@ -5962,7 +6318,7 @@
"documentation": "Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)"
},
"NameModifier": {
"shape": "__string",
"shape": "__stringMin1",
"locationName": "nameModifier",
"documentation": "Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify the base filename as part of your destination URI. When you create multiple outputs in the same output group, Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output group."
},
@ -5971,7 +6327,7 @@
"locationName": "outputSettings"
},
"Preset": {
"shape": "__string",
"shape": "__stringMin0",
"locationName": "preset",
"documentation": "Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both."
},
@ -5987,12 +6343,15 @@
"type": "structure",
"members": {
"InputChannels": {
"shape": "ListOf__integer",
"shape": "__listOf__integerMinNegative60Max6",
"locationName": "inputChannels",
"documentation": "List of input channels"
}
},
"documentation": "OutputChannel mapping settings."
"documentation": "OutputChannel mapping settings.",
"required": [
"InputChannels"
]
},
"OutputDetail": {
"type": "structure",
@ -6027,18 +6386,22 @@
"locationName": "outputGroupSettings"
},
"Outputs": {
"shape": "ListOfOutput",
"shape": "__listOfOutput",
"locationName": "outputs",
"documentation": "This object holds groups of encoding settings, one group of settings per output."
}
},
"documentation": "Group of outputs"
"documentation": "Group of outputs",
"required": [
"Outputs",
"OutputGroupSettings"
]
},
"OutputGroupDetail": {
"type": "structure",
"members": {
"OutputDetails": {
"shape": "ListOfOutputDetail",
"shape": "__listOfOutputDetail",
"locationName": "outputDetails",
"documentation": "Details about the output"
}
@ -6048,6 +6411,10 @@
"OutputGroupSettings": {
"type": "structure",
"members": {
"CmafGroupSettings": {
"shape": "CmafGroupSettings",
"locationName": "cmafGroupSettings"
},
"DashIsoGroupSettings": {
"shape": "DashIsoGroupSettings",
"locationName": "dashIsoGroupSettings"
@ -6069,16 +6436,20 @@
"locationName": "type"
}
},
"documentation": "Output Group settings, including type"
"documentation": "Output Group settings, including type",
"required": [
"Type"
]
},
"OutputGroupType": {
"type": "string",
"documentation": "Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming)",
"documentation": "Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)",
"enum": [
"HLS_GROUP_SETTINGS",
"DASH_ISO_GROUP_SETTINGS",
"FILE_GROUP_SETTINGS",
"MS_SMOOTH_GROUP_SETTINGS"
"MS_SMOOTH_GROUP_SETTINGS",
"CMAF_GROUP_SETTINGS"
]
},
"OutputSdt": {
@ -6115,7 +6486,7 @@
"documentation": "An optional category you create to organize your presets."
},
"CreatedAt": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "createdAt",
"documentation": "The timestamp in epoch seconds for preset creation."
},
@ -6125,7 +6496,7 @@
"documentation": "An optional description you create for each preset."
},
"LastUpdated": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "lastUpdated",
"documentation": "The timestamp in epoch seconds when the preset was last updated."
},
@ -6144,7 +6515,11 @@
"documentation": "A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user."
}
},
"documentation": "A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process."
"documentation": "A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.",
"required": [
"Settings",
"Name"
]
},
"PresetListBy": {
"type": "string",
@ -6159,12 +6534,12 @@
"type": "structure",
"members": {
"AudioDescriptions": {
"shape": "ListOfAudioDescription",
"shape": "__listOfAudioDescription",
"locationName": "audioDescriptions",
"documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings."
},
"CaptionDescriptions": {
"shape": "ListOfCaptionDescriptionPreset",
"shape": "__listOfCaptionDescriptionPreset",
"locationName": "captionDescriptions",
"documentation": "Caption settings for this preset. There can be multiple caption settings in a single output."
},
@ -6192,7 +6567,7 @@
},
"ProresFramerateControl": {
"type": "string",
"documentation": "Using the API, set FramerateControl to INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Using the console, do this by choosing INITIALIZE_FROM_SOURCE for Framerate.",
"documentation": "If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.",
"enum": [
"INITIALIZE_FROM_SOURCE",
"SPECIFIED"
@ -6208,7 +6583,7 @@
},
"ProresInterlaceMode": {
"type": "string",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOw_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.",
"enum": [
"PROGRESSIVE",
"TOP_FIELD",
@ -6241,12 +6616,12 @@
"locationName": "framerateConversionAlgorithm"
},
"FramerateDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateDenominator",
"documentation": "Framerate denominator."
},
"FramerateNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "framerateNumerator",
"documentation": "When you use the API for transcode jobs that use framerate conversion, specify the framerate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator."
},
@ -6259,12 +6634,12 @@
"locationName": "parControl"
},
"ParDenominator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parDenominator",
"documentation": "Pixel Aspect Ratio denominator."
},
"ParNumerator": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "parNumerator",
"documentation": "Pixel Aspect Ratio numerator."
},
@ -6304,7 +6679,7 @@
"documentation": "An identifier for this resource that is unique within all of AWS."
},
"CreatedAt": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "createdAt",
"documentation": "The timestamp in epoch seconds for queue creation."
},
@ -6314,7 +6689,7 @@
"documentation": "An optional description you create for each queue."
},
"LastUpdated": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "lastUpdated",
"documentation": "The timestamp in epoch seconds when the queue was last updated."
},
@ -6323,17 +6698,30 @@
"locationName": "name",
"documentation": "A name you create for each queue. Each name must be unique within your account."
},
"ProgressingJobsCount": {
"shape": "__integer",
"locationName": "progressingJobsCount",
"documentation": "Estimated number of jobs in PROGRESSING status."
},
"Status": {
"shape": "QueueStatus",
"locationName": "status"
},
"SubmittedJobsCount": {
"shape": "__integer",
"locationName": "submittedJobsCount",
"documentation": "Estimated number of jobs in SUBMITTED status."
},
"Type": {
"shape": "Type",
"locationName": "type",
"documentation": "A queue can be of two types: system or custom. System or built-in queues can't be modified or deleted by the user."
}
},
"documentation": "MediaConvert jobs are submitted to a queue. Unless specified otherwise jobs are submitted to a built-in default queue. User can create additional queues to separate the jobs of different categories or priority."
"documentation": "MediaConvert jobs are submitted to a queue. Unless specified otherwise jobs are submitted to a built-in default queue. User can create additional queues to separate the jobs of different categories or priority.",
"required": [
"Name"
]
},
"QueueListBy": {
"type": "string",
@ -6355,27 +6743,33 @@
"type": "structure",
"members": {
"Height": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "height",
"documentation": "Height of rectangle in pixels."
},
"Width": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "width",
"documentation": "Width of rectangle in pixels."
},
"X": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "x",
"documentation": "The distance, in pixels, between the rectangle and the left edge of the video frame."
},
"Y": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "y",
"documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame."
}
},
"documentation": "Use Rectangle to identify a specific area of the video frame."
"documentation": "Use Rectangle to identify a specific area of the video frame.",
"required": [
"X",
"Y",
"Height",
"Width"
]
},
"RemixSettings": {
"type": "structure",
@ -6385,17 +6779,38 @@
"locationName": "channelMapping"
},
"ChannelsIn": {
"shape": "__integer",
"shape": "__integerMin1Max16",
"locationName": "channelsIn",
"documentation": "Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different."
},
"ChannelsOut": {
"shape": "__integer",
"shape": "__integerMin1Max8",
"locationName": "channelsOut",
"documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8"
}
},
"documentation": "Use Manual audio remixing (RemixSettings) to adjust audio levels for each output channel. With audio remixing, you can output more or fewer audio channels than your input audio source provides."
"documentation": "Use Manual audio remixing (RemixSettings) to adjust audio levels for each audio channel in each output of your job. With audio remixing, you can output more or fewer audio channels than your input audio source provides.",
"required": [
"ChannelsOut",
"ChannelMapping",
"ChannelsIn"
]
},
"ResourceTags": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "The Amazon Resource Name (ARN) of the resource."
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
"documentation": "The tags for the resource."
}
},
"documentation": "The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource."
},
"RespondToAfd": {
"type": "string",
@ -6443,33 +6858,38 @@
"documentation": "The SPEKE-compliant server uses Resource ID (ResourceId) to identify content."
},
"SystemIds": {
"shape": "ListOf__string",
"shape": "__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12",
"locationName": "systemIds",
"documentation": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id."
},
"Url": {
"shape": "__string",
"shape": "__stringPatternHttps",
"locationName": "url",
"documentation": "Use URL (Url) to specify the SPEKE-compliant server that will provide keys for content."
}
},
"documentation": "Settings for use with a SPEKE key provider"
"documentation": "Settings for use with a SPEKE key provider",
"required": [
"ResourceId",
"SystemIds",
"Url"
]
},
"StaticKeyProvider": {
"type": "structure",
"members": {
"KeyFormat": {
"shape": "__string",
"shape": "__stringPatternIdentityAZaZ26AZaZ09163",
"locationName": "keyFormat",
"documentation": "Relates to DRM implementation. Sets the value of the KEYFORMAT attribute. Must be 'identity' or a reverse DNS string. May be omitted to indicate an implicit value of 'identity'."
},
"KeyFormatVersions": {
"shape": "__string",
"shape": "__stringPatternDD",
"locationName": "keyFormatVersions",
"documentation": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3)."
},
"StaticKeyValue": {
"shape": "__string",
"shape": "__stringPatternAZaZ0932",
"locationName": "staticKeyValue",
"documentation": "Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue)."
},
@ -6479,13 +6899,41 @@
"documentation": "Relates to DRM implementation. The location of the license server used for protecting content."
}
},
"documentation": "Settings for use with a SPEKE key provider."
"documentation": "Settings for use with a SPEKE key provider.",
"required": [
"Url",
"StaticKeyValue"
]
},
"TagResourceRequest": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name."
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
"documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key."
}
},
"required": [
"Arn",
"Tags"
]
},
"TagResourceResponse": {
"type": "structure",
"members": {
}
},
"TeletextDestinationSettings": {
"type": "structure",
"members": {
"PageNumber": {
"shape": "__string",
"shape": "__stringMin3Max3Pattern1809aFAF09aEAE",
"locationName": "pageNumber",
"documentation": "Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field."
}
@ -6496,7 +6944,7 @@
"type": "structure",
"members": {
"PageNumber": {
"shape": "__string",
"shape": "__stringMin3Max3Pattern1809aFAF09aEAE",
"locationName": "pageNumber",
"documentation": "Use Page Number (PageNumber) to specify the three-digit hexadecimal page number that will be used for Teletext captions. Do not use this setting if you are passing through teletext from the input source to output."
}
@ -6507,7 +6955,7 @@
"type": "structure",
"members": {
"FontSize": {
"shape": "__integer",
"shape": "__integerMin10Max48",
"locationName": "fontSize",
"documentation": "Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48."
},
@ -6516,7 +6964,7 @@
"locationName": "position"
},
"Prefix": {
"shape": "__string",
"shape": "__stringPattern",
"locationName": "prefix",
"documentation": "Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of \"EZ-\" will result in the timecode \"EZ-00:00:00:00\". Provide either the characters themselves or the ASCII code equivalents. The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters represented on a standard English keyboard."
}
@ -6542,30 +6990,30 @@
"type": "structure",
"members": {
"Anchor": {
"shape": "__string",
"shape": "__stringPattern010920405090509092",
"locationName": "anchor",
"documentation": "If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores framerate conversion. System behavior for Anchor Timecode varies depending on your setting for Timecode source (TimecodeSource). * If Timecode source (TimecodeSource) is set to Specified Start (specifiedstart), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Timecode source (TimecodeSource) is set to Start at 0 (zerobased) the first frame is 00:00:00:00. * If Timecode source (TimecodeSource) is set to Embedded (embedded), the first frame is the timecode value on the first input frame of the input."
"documentation": "If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores framerate conversion. System behavior for Anchor Timecode varies depending on your setting for Source (TimecodeSource). * If Source (TimecodeSource) is set to Specified Start (SPECIFIEDSTART), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first frame is 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the first frame is the timecode value on the first input frame of the input."
},
"Source": {
"shape": "TimecodeSource",
"locationName": "source"
},
"Start": {
"shape": "__string",
"shape": "__stringPattern010920405090509092",
"locationName": "start",
"documentation": "Only use when you set Timecode Source (TimecodeSource) to Specified Start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF)."
"documentation": "Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF)."
},
"TimestampOffset": {
"shape": "__string",
"shape": "__stringPattern0940191020191209301",
"locationName": "timestampOffset",
"documentation": "Only applies to outputs that support program-date-time stamp. Use Time stamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings."
"documentation": "Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25."
}
},
"documentation": "Contains settings used to acquire and adjust timecode information from inputs."
"documentation": "These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping."
},
"TimecodeSource": {
"type": "string",
"documentation": "Use Timecode source (TimecodeSource) to set how timecodes are handled within this input. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.",
"documentation": "Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.",
"enum": [
"EMBEDDED",
"ZEROBASED",
@ -6574,7 +7022,7 @@
},
"TimedMetadata": {
"type": "string",
"documentation": "If PASSTHROUGH, inserts ID3 timed metadata from the timed_metadata REST command into this output.",
"documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.",
"enum": [
"PASSTHROUGH",
"NONE"
@ -6584,28 +7032,31 @@
"type": "structure",
"members": {
"Id3Insertions": {
"shape": "ListOfId3Insertion",
"shape": "__listOfId3Insertion",
"locationName": "id3Insertions",
"documentation": "Id3Insertions contains the array of Id3Insertion instances."
}
},
"documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects."
"documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.",
"required": [
"Id3Insertions"
]
},
"Timing": {
"type": "structure",
"members": {
"FinishTime": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "finishTime",
"documentation": "The time, in Unix epoch format, that the transcoding job finished"
},
"StartTime": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "startTime",
"documentation": "The time, in Unix epoch format, that transcoding for the job began."
},
"SubmitTime": {
"shape": "__timestamp",
"shape": "__timestampIso8601",
"locationName": "submitTime",
"documentation": "The time, in Unix epoch format, that you submitted the job."
}
@ -6651,6 +7102,26 @@
"CUSTOM"
]
},
"UntagResourceRequest": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name."
},
"TagKeys": {
"shape": "__listOf__string",
"locationName": "tagKeys",
"documentation": "The keys of the tags that you want to remove from the resource."
}
}
},
"UntagResourceResponse": {
"type": "structure",
"members": {
}
},
"UpdateJobTemplateRequest": {
"type": "structure",
"members": {
@ -6801,7 +7272,10 @@
"locationName": "proresSettings"
}
},
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value you choose for Video codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings"
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value you choose for Video codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings",
"required": [
"Codec"
]
},
"VideoDescription": {
"type": "structure",
@ -6832,12 +7306,12 @@
"locationName": "dropFrameTimecode"
},
"FixedAfd": {
"shape": "__integer",
"shape": "__integerMin0Max15",
"locationName": "fixedAfd",
"documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output."
},
"Height": {
"shape": "__integer",
"shape": "__integerMin32Max2160",
"locationName": "height",
"documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height."
},
@ -6855,7 +7329,7 @@
"locationName": "scalingBehavior"
},
"Sharpness": {
"shape": "__integer",
"shape": "__integerMin0Max100",
"locationName": "sharpness",
"documentation": "Use Sharpness (Sharpness)setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution, and if you set Anti-alias (AntiAlias) to ENABLED. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content."
},
@ -6869,12 +7343,15 @@
"documentation": "Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default."
},
"Width": {
"shape": "__integer",
"shape": "__integerMin32Max4096",
"locationName": "width",
"documentation": "Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width."
}
},
"documentation": "Settings for video outputs"
"documentation": "Settings for video outputs",
"required": [
"CodecSettings"
]
},
"VideoDetail": {
"type": "structure",
@ -6939,12 +7416,12 @@
"locationName": "hdr10Metadata"
},
"Pid": {
"shape": "__integer",
"shape": "__integerMin1Max2147483647",
"locationName": "pid",
"documentation": "Use PID (Pid) to select specific video data from an input file. Specify this value as an integer; the system automatically converts it to the hexidecimal value. For example, 257 selects PID 0x101. A PID, or packet identifier, is an identifier for a set of data in an MPEG-2 transport stream container."
},
"ProgramNumber": {
"shape": "__integer",
"shape": "__integerMinNegative2147483648Max2147483647",
"locationName": "programNumber",
"documentation": "Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported."
}
@ -6953,27 +7430,39 @@
},
"VideoTimecodeInsertion": {
"type": "string",
"documentation": "Enable Timecode insertion to include timecode information in this output. Do this in the API by setting (VideoTimecodeInsertion) to (PIC_TIMING_SEI). To get timecodes to appear correctly in your output, also set up the timecode configuration for your job in the input settings. Only enable Timecode insertion when the input framerate is identical to output framerate. Disable this setting to remove the timecode from the output. Default is disabled.",
"documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input framerate is identical to the output framerate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.",
"enum": [
"DISABLED",
"PIC_TIMING_SEI"
]
},
"WavFormat": {
"type": "string",
"documentation": "The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.",
"enum": [
"RIFF",
"RF64"
]
},
"WavSettings": {
"type": "structure",
"members": {
"BitDepth": {
"shape": "__integer",
"shape": "__integerMin16Max24",
"locationName": "bitDepth",
"documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track."
},
"Channels": {
"shape": "__integer",
"shape": "__integerMin1Max8",
"locationName": "channels",
"documentation": "Set Channels to specify the number of channels in this output audio track. With WAV, valid values 1, 2, 4, and 8. In the console, these values are Mono, Stereo, 4-Channel, and 8-Channel, respectively."
},
"Format": {
"shape": "WavFormat",
"locationName": "format"
},
"SampleRate": {
"shape": "__integer",
"shape": "__integerMin8000Max192000",
"locationName": "sampleRate",
"documentation": "Sample rate in Hz."
}
@ -6986,14 +7475,648 @@
"__double": {
"type": "double"
},
"__doubleMin0": {
"type": "double"
},
"__doubleMinNegative59Max0": {
"type": "double"
},
"__doubleMinNegative60Max3": {
"type": "double"
},
"__doubleMinNegative60MaxNegative1": {
"type": "double"
},
"__integer": {
"type": "integer"
},
"__integerMin0Max10": {
"type": "integer",
"min": 0,
"max": 10
},
"__integerMin0Max100": {
"type": "integer",
"min": 0,
"max": 100
},
"__integerMin0Max1000": {
"type": "integer",
"min": 0,
"max": 1000
},
"__integerMin0Max10000": {
"type": "integer",
"min": 0,
"max": 10000
},
"__integerMin0Max1152000000": {
"type": "integer",
"min": 0,
"max": 1152000000
},
"__integerMin0Max128": {
"type": "integer",
"min": 0,
"max": 128
},
"__integerMin0Max1466400000": {
"type": "integer",
"min": 0,
"max": 1466400000
},
"__integerMin0Max15": {
"type": "integer",
"min": 0,
"max": 15
},
"__integerMin0Max16": {
"type": "integer",
"min": 0,
"max": 16
},
"__integerMin0Max2147483647": {
"type": "integer",
"min": 0,
"max": 2147483647
},
"__integerMin0Max255": {
"type": "integer",
"min": 0,
"max": 255
},
"__integerMin0Max3": {
"type": "integer",
"min": 0,
"max": 3
},
"__integerMin0Max30": {
"type": "integer",
"min": 0,
"max": 30
},
"__integerMin0Max3600": {
"type": "integer",
"min": 0,
"max": 3600
},
"__integerMin0Max47185920": {
"type": "integer",
"min": 0,
"max": 47185920
},
"__integerMin0Max500": {
"type": "integer",
"min": 0,
"max": 500
},
"__integerMin0Max50000": {
"type": "integer",
"min": 0,
"max": 50000
},
"__integerMin0Max65535": {
"type": "integer",
"min": 0,
"max": 65535
},
"__integerMin0Max7": {
"type": "integer",
"min": 0,
"max": 7
},
"__integerMin0Max8": {
"type": "integer",
"min": 0,
"max": 8
},
"__integerMin0Max9": {
"type": "integer",
"min": 0,
"max": 9
},
"__integerMin0Max96": {
"type": "integer",
"min": 0,
"max": 96
},
"__integerMin0Max99": {
"type": "integer",
"min": 0,
"max": 99
},
"__integerMin1000Max1152000000": {
"type": "integer",
"min": 1000,
"max": 1152000000
},
"__integerMin1000Max1466400000": {
"type": "integer",
"min": 1000,
"max": 1466400000
},
"__integerMin1000Max288000000": {
"type": "integer",
"min": 1000,
"max": 288000000
},
"__integerMin1000Max30000": {
"type": "integer",
"min": 1000,
"max": 30000
},
"__integerMin1000Max300000000": {
"type": "integer",
"min": 1000,
"max": 300000000
},
"__integerMin10Max48": {
"type": "integer",
"min": 10,
"max": 48
},
"__integerMin16Max24": {
"type": "integer",
"min": 16,
"max": 24
},
"__integerMin1Max1": {
"type": "integer",
"min": 1,
"max": 1
},
"__integerMin1Max100": {
"type": "integer",
"min": 1,
"max": 100
},
"__integerMin1Max10000000": {
"type": "integer",
"min": 1,
"max": 10000000
},
"__integerMin1Max1001": {
"type": "integer",
"min": 1,
"max": 1001
},
"__integerMin1Max16": {
"type": "integer",
"min": 1,
"max": 16
},
"__integerMin1Max2": {
"type": "integer",
"min": 1,
"max": 2
},
"__integerMin1Max20": {
"type": "integer",
"min": 1,
"max": 20
},
"__integerMin1Max2147483647": {
"type": "integer",
"min": 1,
"max": 2147483647
},
"__integerMin1Max31": {
"type": "integer",
"min": 1,
"max": 31
},
"__integerMin1Max32": {
"type": "integer",
"min": 1,
"max": 32
},
"__integerMin1Max4": {
"type": "integer",
"min": 1,
"max": 4
},
"__integerMin1Max6": {
"type": "integer",
"min": 1,
"max": 6
},
"__integerMin1Max8": {
"type": "integer",
"min": 1,
"max": 8
},
"__integerMin24Max60000": {
"type": "integer",
"min": 24,
"max": 60000
},
"__integerMin25Max10000": {
"type": "integer",
"min": 25,
"max": 10000
},
"__integerMin25Max2000": {
"type": "integer",
"min": 25,
"max": 2000
},
"__integerMin32000Max384000": {
"type": "integer",
"min": 32000,
"max": 384000
},
"__integerMin32000Max48000": {
"type": "integer",
"min": 32000,
"max": 48000
},
"__integerMin32Max2160": {
"type": "integer",
"min": 32,
"max": 2160
},
"__integerMin32Max4096": {
"type": "integer",
"min": 32,
"max": 4096
},
"__integerMin32Max8182": {
"type": "integer",
"min": 32,
"max": 8182
},
"__integerMin48000Max48000": {
"type": "integer",
"min": 48000,
"max": 48000
},
"__integerMin6000Max1024000": {
"type": "integer",
"min": 6000,
"max": 1024000
},
"__integerMin64000Max640000": {
"type": "integer",
"min": 64000,
"max": 640000
},
"__integerMin8000Max192000": {
"type": "integer",
"min": 8000,
"max": 192000
},
"__integerMin8000Max96000": {
"type": "integer",
"min": 8000,
"max": 96000
},
"__integerMin96Max600": {
"type": "integer",
"min": 96,
"max": 600
},
"__integerMinNegative1000Max1000": {
"type": "integer",
"min": -1000,
"max": 1000
},
"__integerMinNegative180Max180": {
"type": "integer",
"min": -180,
"max": 180
},
"__integerMinNegative2147483648Max2147483647": {
"type": "integer",
"min": -2147483648,
"max": 2147483647
},
"__integerMinNegative2Max3": {
"type": "integer",
"min": -2,
"max": 3
},
"__integerMinNegative5Max5": {
"type": "integer",
"min": -5,
"max": 5
},
"__integerMinNegative60Max6": {
"type": "integer",
"min": -60,
"max": 6
},
"__integerMinNegative70Max0": {
"type": "integer",
"min": -70,
"max": 0
},
"__listOfAudioDescription": {
"type": "list",
"member": {
"shape": "AudioDescription"
}
},
"__listOfCaptionDescription": {
"type": "list",
"member": {
"shape": "CaptionDescription"
}
},
"__listOfCaptionDescriptionPreset": {
"type": "list",
"member": {
"shape": "CaptionDescriptionPreset"
}
},
"__listOfEndpoint": {
"type": "list",
"member": {
"shape": "Endpoint"
}
},
"__listOfHlsAdMarkers": {
"type": "list",
"member": {
"shape": "HlsAdMarkers"
}
},
"__listOfHlsCaptionLanguageMapping": {
"type": "list",
"member": {
"shape": "HlsCaptionLanguageMapping"
}
},
"__listOfId3Insertion": {
"type": "list",
"member": {
"shape": "Id3Insertion"
}
},
"__listOfInput": {
"type": "list",
"member": {
"shape": "Input"
}
},
"__listOfInputClipping": {
"type": "list",
"member": {
"shape": "InputClipping"
}
},
"__listOfInputTemplate": {
"type": "list",
"member": {
"shape": "InputTemplate"
}
},
"__listOfInsertableImage": {
"type": "list",
"member": {
"shape": "InsertableImage"
}
},
"__listOfJob": {
"type": "list",
"member": {
"shape": "Job"
}
},
"__listOfJobTemplate": {
"type": "list",
"member": {
"shape": "JobTemplate"
}
},
"__listOfOutput": {
"type": "list",
"member": {
"shape": "Output"
}
},
"__listOfOutputChannelMapping": {
"type": "list",
"member": {
"shape": "OutputChannelMapping"
}
},
"__listOfOutputDetail": {
"type": "list",
"member": {
"shape": "OutputDetail"
}
},
"__listOfOutputGroup": {
"type": "list",
"member": {
"shape": "OutputGroup"
}
},
"__listOfOutputGroupDetail": {
"type": "list",
"member": {
"shape": "OutputGroupDetail"
}
},
"__listOfPreset": {
"type": "list",
"member": {
"shape": "Preset"
}
},
"__listOfQueue": {
"type": "list",
"member": {
"shape": "Queue"
}
},
"__listOf__integerMin1Max2147483647": {
"type": "list",
"member": {
"shape": "__integerMin1Max2147483647"
}
},
"__listOf__integerMin32Max8182": {
"type": "list",
"member": {
"shape": "__integerMin32Max8182"
}
},
"__listOf__integerMinNegative60Max6": {
"type": "list",
"member": {
"shape": "__integerMinNegative60Max6"
}
},
"__listOf__string": {
"type": "list",
"member": {
"shape": "__string"
}
},
"__listOf__stringMin1": {
"type": "list",
"member": {
"shape": "__stringMin1"
}
},
"__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": {
"type": "list",
"member": {
"shape": "__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"
}
},
"__long": {
"type": "long"
},
"__mapOfAudioSelector": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "AudioSelector"
}
},
"__mapOfAudioSelectorGroup": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "AudioSelectorGroup"
}
},
"__mapOfCaptionSelector": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "CaptionSelector"
}
},
"__mapOf__string": {
"type": "map",
"key": {
"shape": "__string"
},
"value": {
"shape": "__string"
}
},
"__string": {
"type": "string"
},
"__timestamp": {
"type": "timestamp"
"__stringMin0": {
"type": "string",
"min": 0
},
"__stringMin1": {
"type": "string",
"min": 1
},
"__stringMin14PatternS3BmpBMPPngPNG": {
"type": "string",
"min": 14,
"pattern": "^(s3:\\/\\/)(.*?)\\.(bmp|BMP|png|PNG)$"
},
"__stringMin14PatternS3BmpBMPPngPNGTgaTGA": {
"type": "string",
"min": 14,
"pattern": "^(s3:\\/\\/)(.*?)\\.(bmp|BMP|png|PNG|tga|TGA)$"
},
"__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI": {
"type": "string",
"min": 14,
"pattern": "^(s3:\\/\\/)(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|smi|SMI)$"
},
"__stringMin1Max256": {
"type": "string",
"min": 1,
"max": 256
},
"__stringMin32Max32Pattern09aFAF32": {
"type": "string",
"min": 32,
"max": 32,
"pattern": "^[0-9a-fA-F]{32}$"
},
"__stringMin3Max3Pattern1809aFAF09aEAE": {
"type": "string",
"min": 3,
"max": 3,
"pattern": "^[1-8][0-9a-fA-F][0-9a-eA-E]$"
},
"__stringMin3Max3PatternAZaZ3": {
"type": "string",
"min": 3,
"max": 3,
"pattern": "^[A-Za-z]{3}$"
},
"__stringPattern": {
"type": "string",
"pattern": "^[ -~]+$"
},
"__stringPattern010920405090509092": {
"type": "string",
"pattern": "^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$"
},
"__stringPattern01D20305D205D": {
"type": "string",
"pattern": "^((([0-1]\\d)|(2[0-3]))(:[0-5]\\d){2}([:;][0-5]\\d))$"
},
"__stringPattern0940191020191209301": {
"type": "string",
"pattern": "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$"
},
"__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"__stringPatternAZaZ0902": {
"type": "string",
"pattern": "^[A-Za-z0-9+\\/]+={0,2}$"
},
"__stringPatternAZaZ0932": {
"type": "string",
"pattern": "^[A-Za-z0-9]{32}$"
},
"__stringPatternDD": {
"type": "string",
"pattern": "^(\\d+(\\/\\d+)*)$"
},
"__stringPatternHttps": {
"type": "string",
"pattern": "^https:\\/\\/"
},
"__stringPatternIdentityAZaZ26AZaZ09163": {
"type": "string",
"pattern": "^(identity|[A-Za-z]{2,6}(\\.[A-Za-z0-9-]{1,63})+)$"
},
"__stringPatternS3": {
"type": "string",
"pattern": "^s3:\\/\\/"
},
"__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MM": {
"type": "string",
"pattern": "^(s3:\\/\\/)([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM])))$"
},
"__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
"type": "string",
"pattern": "^(s3:\\/\\/)([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$"
},
"__stringPatternWS": {
"type": "string",
"pattern": "^[\\w\\s]*$"
},
"__timestampIso8601": {
"type": "timestamp",
"timestampFormat": "iso8601"
},
"__timestampUnix": {
"type": "timestamp",
"timestampFormat": "unixTimestamp"
}
},
"documentation": "AWS Elemental MediaConvert"

12
botocore/data/medialive/2017-10-14/paginators-1.json
View file

@ -17,6 +17,18 @@
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "InputSecurityGroups"
},
"ListOfferings": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Offerings"
},
"ListReservations": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Reservations"
}
}
}

1193
botocore/data/medialive/2017-10-14/service-2.json
View file

@ -27,14 +27,14 @@
"documentation": "Creation of channel is started."
},
"errors": [
{
"shape": "UnprocessableEntityException",
"documentation": "The Channel failed validation and could not be created."
},
{
"shape": "BadRequestException",
"documentation": "This request was invalid."
},
{
"shape": "UnprocessableEntityException",
"documentation": "The Channel failed validation and could not be created."
},
{
"shape": "InternalServerErrorException",
"documentation": "Unexpected internal service error."
@ -292,6 +292,56 @@
],
"documentation": "Deletes an Input Security Group"
},
"DeleteReservation": {
"name": "DeleteReservation",
"http": {
"method": "DELETE",
"requestUri": "/prod/reservations/{reservationId}",
"responseCode": 200
},
"input": {
"shape": "DeleteReservationRequest"
},
"output": {
"shape": "DeleteReservationResponse",
"documentation": "Deleted reservation"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal service error"
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to delete reservation"
},
{
"shape": "BadGatewayException",
"documentation": "Bad gateway error"
},
{
"shape": "NotFoundException",
"documentation": "Reservation you're attempting to delete does not exist"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway timeout error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Request limit exceeded on delete reservation request"
},
{
"shape": "ConflictException",
"documentation": "The reservation could not be deleted because it is currently active."
}
],
"documentation": "Delete an expired reservation."
},
"DescribeChannel": {
"name": "DescribeChannel",
"http": {
@ -430,6 +480,98 @@
],
"documentation": "Produces a summary of an Input Security Group"
},
"DescribeOffering": {
"name": "DescribeOffering",
"http": {
"method": "GET",
"requestUri": "/prod/offerings/{offeringId}",
"responseCode": 200
},
"input": {
"shape": "DescribeOfferingRequest"
},
"output": {
"shape": "DescribeOfferingResponse",
"documentation": "Offering details"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal service error"
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to describe offering"
},
{
"shape": "BadGatewayException",
"documentation": "Bad gateway error"
},
{
"shape": "NotFoundException",
"documentation": "Offering you're attempting to describe does not exist"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway timeout error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Request limit exceeded on describe offering request"
}
],
"documentation": "Get details for an offering."
},
"DescribeReservation": {
"name": "DescribeReservation",
"http": {
"method": "GET",
"requestUri": "/prod/reservations/{reservationId}",
"responseCode": 200
},
"input": {
"shape": "DescribeReservationRequest"
},
"output": {
"shape": "DescribeReservationResponse",
"documentation": "Reservation details"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal service error"
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to describe reservation"
},
{
"shape": "BadGatewayException",
"documentation": "Bad gateway error"
},
{
"shape": "NotFoundException",
"documentation": "Reservation you're attempting to describe does not exist"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway timeout error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Request limit exceeded on describe reservation request"
}
],
"documentation": "Get details for a reservation."
},
"ListChannels": {
"name": "ListChannels",
"http": {
@ -556,6 +698,140 @@
],
"documentation": "Produces list of inputs that have been created"
},
"ListOfferings": {
"name": "ListOfferings",
"http": {
"method": "GET",
"requestUri": "/prod/offerings",
"responseCode": 200
},
"input": {
"shape": "ListOfferingsRequest"
},
"output": {
"shape": "ListOfferingsResponse",
"documentation": "List of offerings"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal service error"
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to list offerings"
},
{
"shape": "BadGatewayException",
"documentation": "Bad gateway error"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway timeout error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Request limit exceeded on list offerings request"
}
],
"documentation": "List offerings available for purchase."
},
"ListReservations": {
"name": "ListReservations",
"http": {
"method": "GET",
"requestUri": "/prod/reservations",
"responseCode": 200
},
"input": {
"shape": "ListReservationsRequest"
},
"output": {
"shape": "ListReservationsResponse",
"documentation": "List of reservations"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal service error"
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to list reservations"
},
{
"shape": "BadGatewayException",
"documentation": "Bad gateway error"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway timeout error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Request limit exceeded on list reservations request"
}
],
"documentation": "List purchased reservations."
},
"PurchaseOffering": {
"name": "PurchaseOffering",
"http": {
"method": "POST",
"requestUri": "/prod/offerings/{offeringId}/purchase",
"responseCode": 201
},
"input": {
"shape": "PurchaseOfferingRequest"
},
"output": {
"shape": "PurchaseOfferingResponse",
"documentation": "Purchased reservation"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal service error"
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to purchase the offering"
},
{
"shape": "BadGatewayException",
"documentation": "Bad gateway error"
},
{
"shape": "NotFoundException",
"documentation": "Offering you're attempting to purchase does not exist"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway timeout error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Request limit exceeded on purchase offering request"
},
{
"shape": "ConflictException",
"documentation": "Offering purchase prevented by service resource issue"
}
],
"documentation": "Purchase an offering and create a reservation."
},
"StartChannel": {
"name": "StartChannel",
"http": {
@ -671,14 +947,14 @@
"documentation": "Channel is successfully updated."
},
"errors": [
{
"shape": "UnprocessableEntityException",
"documentation": "The channel configuration failed validation and could not be updated."
},
{
"shape": "BadRequestException",
"documentation": "This request was invalid."
},
{
"shape": "UnprocessableEntityException",
"documentation": "The channel configuration failed validation and could not be updated."
},
{
"shape": "InternalServerErrorException",
"documentation": "Unexpected internal service error."
@ -1842,6 +2118,11 @@
"shape": "InputSpecification",
"locationName": "inputSpecification"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -1937,6 +2218,11 @@
"shape": "InputSpecification",
"locationName": "inputSpecification"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -1994,6 +2280,11 @@
"locationName": "inputSpecification",
"documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -2040,6 +2331,11 @@
"locationName": "inputSpecification",
"documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -2259,6 +2555,11 @@
"shape": "InputSpecification",
"locationName": "inputSpecification"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -2323,6 +2624,112 @@
},
"documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse"
},
"DeleteReservationRequest": {
"type": "structure",
"members": {
"ReservationId": {
"shape": "__string",
"location": "uri",
"locationName": "reservationId",
"documentation": "Unique reservation ID, e.g. '1234567'"
}
},
"required": [
"ReservationId"
],
"documentation": "Placeholder documentation for DeleteReservationRequest"
},
"DeleteReservationResponse": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
},
"Count": {
"shape": "__integer",
"locationName": "count",
"documentation": "Number of reserved resources"
},
"CurrencyCode": {
"shape": "__string",
"locationName": "currencyCode",
"documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
"Duration": {
"shape": "__integer",
"locationName": "duration",
"documentation": "Lease duration, e.g. '12'"
},
"DurationUnits": {
"shape": "OfferingDurationUnits",
"locationName": "durationUnits",
"documentation": "Units for duration, e.g. 'MONTHS'"
},
"End": {
"shape": "__string",
"locationName": "end",
"documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
},
"FixedPrice": {
"shape": "__double",
"locationName": "fixedPrice",
"documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "User specified reservation name"
},
"OfferingDescription": {
"shape": "__string",
"locationName": "offeringDescription",
"documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
"OfferingId": {
"shape": "__string",
"locationName": "offeringId",
"documentation": "Unique offering ID, e.g. '87654321'"
},
"OfferingType": {
"shape": "OfferingType",
"locationName": "offeringType",
"documentation": "Offering type, e.g. 'NO_UPFRONT'"
},
"Region": {
"shape": "__string",
"locationName": "region",
"documentation": "AWS region, e.g. 'us-west-2'"
},
"ReservationId": {
"shape": "__string",
"locationName": "reservationId",
"documentation": "Unique reservation ID, e.g. '1234567'"
},
"ResourceSpecification": {
"shape": "ReservationResourceSpecification",
"locationName": "resourceSpecification",
"documentation": "Resource configuration details"
},
"Start": {
"shape": "__string",
"locationName": "start",
"documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
},
"State": {
"shape": "ReservationState",
"locationName": "state",
"documentation": "Current state of reservation, e.g. 'ACTIVE'"
},
"UsagePrice": {
"shape": "__double",
"locationName": "usagePrice",
"documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
"documentation": "Placeholder documentation for DeleteReservationResponse"
},
"DescribeChannelRequest": {
"type": "structure",
"members": {
@ -2374,6 +2781,11 @@
"shape": "InputSpecification",
"locationName": "inputSpecification"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -2506,6 +2918,188 @@
},
"documentation": "Placeholder documentation for DescribeInputSecurityGroupResponse"
},
"DescribeOfferingRequest": {
"type": "structure",
"members": {
"OfferingId": {
"shape": "__string",
"location": "uri",
"locationName": "offeringId",
"documentation": "Unique offering ID, e.g. '87654321'"
}
},
"required": [
"OfferingId"
],
"documentation": "Placeholder documentation for DescribeOfferingRequest"
},
"DescribeOfferingResponse": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'"
},
"CurrencyCode": {
"shape": "__string",
"locationName": "currencyCode",
"documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
"Duration": {
"shape": "__integer",
"locationName": "duration",
"documentation": "Lease duration, e.g. '12'"
},
"DurationUnits": {
"shape": "OfferingDurationUnits",
"locationName": "durationUnits",
"documentation": "Units for duration, e.g. 'MONTHS'"
},
"FixedPrice": {
"shape": "__double",
"locationName": "fixedPrice",
"documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
"OfferingDescription": {
"shape": "__string",
"locationName": "offeringDescription",
"documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
"OfferingId": {
"shape": "__string",
"locationName": "offeringId",
"documentation": "Unique offering ID, e.g. '87654321'"
},
"OfferingType": {
"shape": "OfferingType",
"locationName": "offeringType",
"documentation": "Offering type, e.g. 'NO_UPFRONT'"
},
"Region": {
"shape": "__string",
"locationName": "region",
"documentation": "AWS region, e.g. 'us-west-2'"
},
"ResourceSpecification": {
"shape": "ReservationResourceSpecification",
"locationName": "resourceSpecification",
"documentation": "Resource configuration details"
},
"UsagePrice": {
"shape": "__double",
"locationName": "usagePrice",
"documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
"documentation": "Placeholder documentation for DescribeOfferingResponse"
},
"DescribeReservationRequest": {
"type": "structure",
"members": {
"ReservationId": {
"shape": "__string",
"location": "uri",
"locationName": "reservationId",
"documentation": "Unique reservation ID, e.g. '1234567'"
}
},
"required": [
"ReservationId"
],
"documentation": "Placeholder documentation for DescribeReservationRequest"
},
"DescribeReservationResponse": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
},
"Count": {
"shape": "__integer",
"locationName": "count",
"documentation": "Number of reserved resources"
},
"CurrencyCode": {
"shape": "__string",
"locationName": "currencyCode",
"documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
"Duration": {
"shape": "__integer",
"locationName": "duration",
"documentation": "Lease duration, e.g. '12'"
},
"DurationUnits": {
"shape": "OfferingDurationUnits",
"locationName": "durationUnits",
"documentation": "Units for duration, e.g. 'MONTHS'"
},
"End": {
"shape": "__string",
"locationName": "end",
"documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
},
"FixedPrice": {
"shape": "__double",
"locationName": "fixedPrice",
"documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "User specified reservation name"
},
"OfferingDescription": {
"shape": "__string",
"locationName": "offeringDescription",
"documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
"OfferingId": {
"shape": "__string",
"locationName": "offeringId",
"documentation": "Unique offering ID, e.g. '87654321'"
},
"OfferingType": {
"shape": "OfferingType",
"locationName": "offeringType",
"documentation": "Offering type, e.g. 'NO_UPFRONT'"
},
"Region": {
"shape": "__string",
"locationName": "region",
"documentation": "AWS region, e.g. 'us-west-2'"
},
"ReservationId": {
"shape": "__string",
"locationName": "reservationId",
"documentation": "Unique reservation ID, e.g. '1234567'"
},
"ResourceSpecification": {
"shape": "ReservationResourceSpecification",
"locationName": "resourceSpecification",
"documentation": "Resource configuration details"
},
"Start": {
"shape": "__string",
"locationName": "start",
"documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
},
"State": {
"shape": "ReservationState",
"locationName": "state",
"documentation": "Current state of reservation, e.g. 'ACTIVE'"
},
"UsagePrice": {
"shape": "__double",
"locationName": "usagePrice",
"documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
"documentation": "Placeholder documentation for DescribeReservationResponse"
},
"DvbNitSettings": {
"type": "structure",
"members": {
@ -4789,6 +5383,203 @@
},
"documentation": "Placeholder documentation for ListInputsResultModel"
},
"ListOfferingsRequest": {
"type": "structure",
"members": {
"ChannelConfiguration": {
"shape": "__string",
"location": "querystring",
"locationName": "channelConfiguration",
"documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)\n"
},
"Codec": {
"shape": "__string",
"location": "querystring",
"locationName": "codec",
"documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'"
},
"MaxResults": {
"shape": "MaxResults",
"location": "querystring",
"locationName": "maxResults"
},
"MaximumBitrate": {
"shape": "__string",
"location": "querystring",
"locationName": "maximumBitrate",
"documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'\n"
},
"MaximumFramerate": {
"shape": "__string",
"location": "querystring",
"locationName": "maximumFramerate",
"documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken"
},
"Resolution": {
"shape": "__string",
"location": "querystring",
"locationName": "resolution",
"documentation": "Filter by resolution, 'SD', 'HD', or 'UHD'"
},
"ResourceType": {
"shape": "__string",
"location": "querystring",
"locationName": "resourceType",
"documentation": "Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'"
},
"SpecialFeature": {
"shape": "__string",
"location": "querystring",
"locationName": "specialFeature",
"documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'\n"
},
"VideoQuality": {
"shape": "__string",
"location": "querystring",
"locationName": "videoQuality",
"documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'\n"
}
},
"documentation": "Placeholder documentation for ListOfferingsRequest"
},
"ListOfferingsResponse": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"locationName": "nextToken",
"documentation": "Token to retrieve the next page of results"
},
"Offerings": {
"shape": "__listOfOffering",
"locationName": "offerings",
"documentation": "List of offerings"
}
},
"documentation": "Placeholder documentation for ListOfferingsResponse"
},
"ListOfferingsResultModel": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"locationName": "nextToken",
"documentation": "Token to retrieve the next page of results"
},
"Offerings": {
"shape": "__listOfOffering",
"locationName": "offerings",
"documentation": "List of offerings"
}
},
"documentation": "ListOfferings response"
},
"ListReservationsRequest": {
"type": "structure",
"members": {
"Codec": {
"shape": "__string",
"location": "querystring",
"locationName": "codec",
"documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'"
},
"MaxResults": {
"shape": "MaxResults",
"location": "querystring",
"locationName": "maxResults"
},
"MaximumBitrate": {
"shape": "__string",
"location": "querystring",
"locationName": "maximumBitrate",
"documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'\n"
},
"MaximumFramerate": {
"shape": "__string",
"location": "querystring",
"locationName": "maximumFramerate",
"documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken"
},
"Resolution": {
"shape": "__string",
"location": "querystring",
"locationName": "resolution",
"documentation": "Filter by resolution, 'SD', 'HD', or 'UHD'"
},
"ResourceType": {
"shape": "__string",
"location": "querystring",
"locationName": "resourceType",
"documentation": "Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'"
},
"SpecialFeature": {
"shape": "__string",
"location": "querystring",
"locationName": "specialFeature",
"documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'\n"
},
"VideoQuality": {
"shape": "__string",
"location": "querystring",
"locationName": "videoQuality",
"documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'\n"
}
},
"documentation": "Placeholder documentation for ListReservationsRequest"
},
"ListReservationsResponse": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"locationName": "nextToken",
"documentation": "Token to retrieve the next page of results"
},
"Reservations": {
"shape": "__listOfReservation",
"locationName": "reservations",
"documentation": "List of reservations"
}
},
"documentation": "Placeholder documentation for ListReservationsResponse"
},
"ListReservationsResultModel": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"locationName": "nextToken",
"documentation": "Token to retrieve the next page of results"
},
"Reservations": {
"shape": "__listOfReservation",
"locationName": "reservations",
"documentation": "List of reservations"
}
},
"documentation": "ListReservations response"
},
"LogLevel": {
"type": "string",
"enum": [
"ERROR",
"WARNING",
"INFO",
"DEBUG",
"DISABLED"
],
"documentation": "The log level the user wants for their channel."
},
"M2tsAbsentInputAudioBehavior": {
"type": "string",
"enum": [
@ -5471,6 +6262,81 @@
},
"documentation": "Placeholder documentation for NotFoundException"
},
"Offering": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'"
},
"CurrencyCode": {
"shape": "__string",
"locationName": "currencyCode",
"documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
"Duration": {
"shape": "__integer",
"locationName": "duration",
"documentation": "Lease duration, e.g. '12'"
},
"DurationUnits": {
"shape": "OfferingDurationUnits",
"locationName": "durationUnits",
"documentation": "Units for duration, e.g. 'MONTHS'"
},
"FixedPrice": {
"shape": "__double",
"locationName": "fixedPrice",
"documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
"OfferingDescription": {
"shape": "__string",
"locationName": "offeringDescription",
"documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
"OfferingId": {
"shape": "__string",
"locationName": "offeringId",
"documentation": "Unique offering ID, e.g. '87654321'"
},
"OfferingType": {
"shape": "OfferingType",
"locationName": "offeringType",
"documentation": "Offering type, e.g. 'NO_UPFRONT'"
},
"Region": {
"shape": "__string",
"locationName": "region",
"documentation": "AWS region, e.g. 'us-west-2'"
},
"ResourceSpecification": {
"shape": "ReservationResourceSpecification",
"locationName": "resourceSpecification",
"documentation": "Resource configuration details"
},
"UsagePrice": {
"shape": "__double",
"locationName": "usagePrice",
"documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
"documentation": "Reserved resources available for purchase"
},
"OfferingDurationUnits": {
"type": "string",
"documentation": "Units for duration, e.g. 'MONTHS'",
"enum": [
"MONTHS"
]
},
"OfferingType": {
"type": "string",
"documentation": "Offering type, e.g. 'NO_UPFRONT'",
"enum": [
"NO_UPFRONT"
]
},
"Output": {
"type": "structure",
"members": {
@ -5639,6 +6505,79 @@
},
"documentation": "Placeholder documentation for PassThroughSettings"
},
"PurchaseOffering": {
"type": "structure",
"members": {
"Count": {
"shape": "__integerMin1",
"locationName": "count",
"documentation": "Number of resources"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "Name for the new reservation"
},
"RequestId": {
"shape": "__string",
"locationName": "requestId",
"documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.",
"idempotencyToken": true
}
},
"documentation": "PurchaseOffering request"
},
"PurchaseOfferingRequest": {
"type": "structure",
"members": {
"Count": {
"shape": "__integerMin1",
"locationName": "count",
"documentation": "Number of resources"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "Name for the new reservation"
},
"OfferingId": {
"shape": "__string",
"location": "uri",
"locationName": "offeringId",
"documentation": "Offering to purchase, e.g. '87654321'"
},
"RequestId": {
"shape": "__string",
"locationName": "requestId",
"documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.",
"idempotencyToken": true
}
},
"required": [
"OfferingId"
],
"documentation": "Placeholder documentation for PurchaseOfferingRequest"
},
"PurchaseOfferingResponse": {
"type": "structure",
"members": {
"Reservation": {
"shape": "Reservation",
"locationName": "reservation"
}
},
"documentation": "Placeholder documentation for PurchaseOfferingResponse"
},
"PurchaseOfferingResultModel": {
"type": "structure",
"members": {
"Reservation": {
"shape": "Reservation",
"locationName": "reservation"
}
},
"documentation": "PurchaseOffering response"
},
"RemixSettings": {
"type": "structure",
"members": {
@ -5663,6 +6602,210 @@
],
"documentation": "Placeholder documentation for RemixSettings"
},
"Reservation": {
"type": "structure",
"members": {
"Arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'"
},
"Count": {
"shape": "__integer",
"locationName": "count",
"documentation": "Number of reserved resources"
},
"CurrencyCode": {
"shape": "__string",
"locationName": "currencyCode",
"documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'"
},
"Duration": {
"shape": "__integer",
"locationName": "duration",
"documentation": "Lease duration, e.g. '12'"
},
"DurationUnits": {
"shape": "OfferingDurationUnits",
"locationName": "durationUnits",
"documentation": "Units for duration, e.g. 'MONTHS'"
},
"End": {
"shape": "__string",
"locationName": "end",
"documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'"
},
"FixedPrice": {
"shape": "__double",
"locationName": "fixedPrice",
"documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "User specified reservation name"
},
"OfferingDescription": {
"shape": "__string",
"locationName": "offeringDescription",
"documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'"
},
"OfferingId": {
"shape": "__string",
"locationName": "offeringId",
"documentation": "Unique offering ID, e.g. '87654321'"
},
"OfferingType": {
"shape": "OfferingType",
"locationName": "offeringType",
"documentation": "Offering type, e.g. 'NO_UPFRONT'"
},
"Region": {
"shape": "__string",
"locationName": "region",
"documentation": "AWS region, e.g. 'us-west-2'"
},
"ReservationId": {
"shape": "__string",
"locationName": "reservationId",
"documentation": "Unique reservation ID, e.g. '1234567'"
},
"ResourceSpecification": {
"shape": "ReservationResourceSpecification",
"locationName": "resourceSpecification",
"documentation": "Resource configuration details"
},
"Start": {
"shape": "__string",
"locationName": "start",
"documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'"
},
"State": {
"shape": "ReservationState",
"locationName": "state",
"documentation": "Current state of reservation, e.g. 'ACTIVE'"
},
"UsagePrice": {
"shape": "__double",
"locationName": "usagePrice",
"documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'"
}
},
"documentation": "Reserved resources available to use"
},
"ReservationCodec": {
"type": "string",
"documentation": "Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'",
"enum": [
"MPEG2",
"AVC",
"HEVC",
"AUDIO"
]
},
"ReservationMaximumBitrate": {
"type": "string",
"documentation": "Maximum bitrate in megabits per second",
"enum": [
"MAX_10_MBPS",
"MAX_20_MBPS",
"MAX_50_MBPS"
]
},
"ReservationMaximumFramerate": {
"type": "string",
"documentation": "Maximum framerate in frames per second (Outputs only)",
"enum": [
"MAX_30_FPS",
"MAX_60_FPS"
]
},
"ReservationResolution": {
"type": "string",
"documentation": "Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines\n",
"enum": [
"SD",
"HD",
"UHD"
]
},
"ReservationResourceSpecification": {
"type": "structure",
"members": {
"Codec": {
"shape": "ReservationCodec",
"locationName": "codec",
"documentation": "Codec, e.g. 'AVC'"
},
"MaximumBitrate": {
"shape": "ReservationMaximumBitrate",
"locationName": "maximumBitrate",
"documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'"
},
"MaximumFramerate": {
"shape": "ReservationMaximumFramerate",
"locationName": "maximumFramerate",
"documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)"
},
"Resolution": {
"shape": "ReservationResolution",
"locationName": "resolution",
"documentation": "Resolution, e.g. 'HD'"
},
"ResourceType": {
"shape": "ReservationResourceType",
"locationName": "resourceType",
"documentation": "Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'"
},
"SpecialFeature": {
"shape": "ReservationSpecialFeature",
"locationName": "specialFeature",
"documentation": "Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)"
},
"VideoQuality": {
"shape": "ReservationVideoQuality",
"locationName": "videoQuality",
"documentation": "Video quality, e.g. 'STANDARD' (Outputs only)"
}
},
"documentation": "Resource configuration (codec, resolution, bitrate, ...)"
},
"ReservationResourceType": {
"type": "string",
"documentation": "Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'",
"enum": [
"INPUT",
"OUTPUT",
"CHANNEL"
]
},
"ReservationSpecialFeature": {
"type": "string",
"documentation": "Special features, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'",
"enum": [
"ADVANCED_AUDIO",
"AUDIO_NORMALIZATION"
]
},
"ReservationState": {
"type": "string",
"documentation": "Current reservation state",
"enum": [
"ACTIVE",
"EXPIRED",
"CANCELED",
"DELETED"
]
},
"ReservationVideoQuality": {
"type": "string",
"documentation": "Video quality, e.g. 'STANDARD' (Outputs only)",
"enum": [
"STANDARD",
"ENHANCED",
"PREMIUM"
]
},
"ResourceConflict": {
"type": "structure",
"members": {
@ -6035,6 +7178,11 @@
"shape": "InputSpecification",
"locationName": "inputSpecification"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -6127,6 +7275,11 @@
"shape": "InputSpecification",
"locationName": "inputSpecification"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level being written to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -6337,6 +7490,11 @@
"locationName": "inputSpecification",
"documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -6378,6 +7536,11 @@
"locationName": "inputSpecification",
"documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)"
},
"LogLevel": {
"shape": "LogLevel",
"locationName": "logLevel",
"documentation": "The log level to write to CloudWatch Logs."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -7080,6 +8243,13 @@
},
"documentation": "Placeholder documentation for __listOfInputWhitelistRuleCidr"
},
"__listOfOffering": {
"type": "list",
"member": {
"shape": "Offering"
},
"documentation": "Placeholder documentation for __listOfOffering"
},
"__listOfOutput": {
"type": "list",
"member": {
@ -7108,6 +8278,13 @@
},
"documentation": "Placeholder documentation for __listOfOutputGroup"
},
"__listOfReservation": {
"type": "list",
"member": {
"shape": "Reservation"
},
"documentation": "Placeholder documentation for __listOfReservation"
},
"__listOfValidationError": {
"type": "list",
"member": {

3
botocore/data/mediatailor/2018-04-23/paginators-1.json Normal file
View file

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

320
botocore/data/mediatailor/2018-04-23/service-2.json Normal file
View file

@ -0,0 +1,320 @@
{
"metadata" : {
"apiVersion" : "2018-04-23",
"endpointPrefix" : "api.mediatailor",
"signingName" : "mediatailor",
"serviceFullName" : "AWS MediaTailor",
"serviceId" : "MediaTailor",
"protocol" : "rest-json",
"jsonVersion" : "1.1",
"uid" : "mediatailor-2018-04-23",
"signatureVersion" : "v4",
"serviceAbbreviation": "MediaTailor"
},
"operations" : {
"DeletePlaybackConfiguration" : {
"name" : "DeletePlaybackConfiguration",
"http" : {
"method" : "DELETE",
"requestUri" : "/playbackConfiguration/{Name}",
"responseCode" : 204
},
"input" : {
"shape" : "DeletePlaybackConfigurationRequest"
},
"output" : {
"shape" : "DeletePlaybackConfigurationResponse"
},
"errors" : [ ],
"documentation" : "<p>Deletes the configuration for the specified name. </p>"
},
"GetPlaybackConfiguration" : {
"name" : "GetPlaybackConfiguration",
"http" : {
"method" : "GET",
"requestUri" : "/playbackConfiguration/{Name}",
"responseCode" : 200
},
"input" : {
"shape" : "GetPlaybackConfigurationRequest"
},
"output" : {
"shape" : "GetPlaybackConfigurationResponse"
},
"errors" : [ ],
"documentation" : "<p>Returns the configuration for the specified name. </p>"
},
"ListPlaybackConfigurations" : {
"name" : "ListPlaybackConfigurations",
"http" : {
"method" : "GET",
"requestUri" : "/playbackConfigurations",
"responseCode" : 200
},
"input" : {
"shape" : "ListPlaybackConfigurationsRequest"
},
"output" : {
"shape" : "ListPlaybackConfigurationsResponse"
},
"errors" : [ ],
"documentation" : "<p>Returns a list of the configurations defined in AWS Elemental MediaTailor. You can specify a max number of configurations to return at a time. The default max is 50. Results are returned in pagefuls. If AWS Elemental MediaTailor has more configurations than the specified max, it provides parameters in the response that you can use to retrieve the next pageful. </p>"
},
"PutPlaybackConfiguration" : {
"name" : "PutPlaybackConfiguration",
"http" : {
"method" : "PUT",
"requestUri" : "/playbackConfiguration",
"responseCode" : 200
},
"input" : {
"shape" : "PutPlaybackConfigurationRequest"
},
"output" : {
"shape" : "PutPlaybackConfigurationResponse"
},
"errors" : [ ],
"documentation" : "<p>Adds a new configuration to AWS Elemental MediaTailor.</p>"
}
},
"shapes" : {
"CdnConfiguration" : {
"type" : "structure",
"members" : {
"AdSegmentUrlPrefix" : {
"shape" : "__string",
"documentation" : "<p>A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.</p>"
},
"ContentSegmentUrlPrefix" : {
"shape" : "__string",
"documentation" : "<p>A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.</p>"
}
},
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
},
"HlsConfiguration": {
"type" : "structure",
"members" : {
"ManifestEndpointPrefix" : {
"shape" : "__string",
"documentation" : "<p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>"
}
},
"documentation" : "<p>The configuration for HLS content. </p>"
},
"DeletePlaybackConfigurationRequest" : {
"type" : "structure",
"members" : {
"Name" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "Name",
"documentation" : "<p>The identifier for the configuration.</p>"
}
},
"required" : [ "Name" ]
},
"DeletePlaybackConfigurationResponse" : {
"type" : "structure",
"members" : { }
},
"Empty" : {
"type" : "structure",
"members" : { }
},
"GetPlaybackConfigurationRequest" : {
"type" : "structure",
"members" : {
"Name" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "Name",
"documentation" : "<p>The identifier for the configuration.</p>"
}
},
"required" : [ "Name" ]
},
"GetPlaybackConfigurationResponse" : {
"type" : "structure",
"members" : {
"AdDecisionServerUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25000 characters.</p>"
},
"CdnConfiguration" : {
"shape" : "CdnConfiguration",
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
},
"HlsConfiguration" : {
"shape" : "HlsConfiguration",
"documentation" : "<p>The configuration for HLS content. </p>"
},
"Name" : {
"shape" : "__string",
"documentation" : "<p>The identifier for the configuration.</p>"
},
"PlaybackEndpointPrefix" : {
"shape" : "__string",
"documentation" : "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>"
},
"SessionInitializationEndpointPrefix" : {
"shape" : "__string",
"documentation" : "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>"
},
"SlateAdUrl" : {
"shape" : "__string",
"documentation" : "<p>URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because AWS Elemental MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>"
},
"VideoContentSourceUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
}
}
},
"PlaybackConfiguration" : {
"type" : "structure",
"documentation": "<p>The AWSMediaTailor configuration.</p>",
"members" : {
"AdDecisionServerUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25000 characters.</p>"
},
"CdnConfiguration" : {
"shape" : "CdnConfiguration",
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
},
"Name" : {
"shape" : "__string",
"documentation" : "<p>The identifier for the configuration.</p>"
},
"SlateAdUrl" : {
"shape" : "__string",
"documentation" : "<p>URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because AWS Elemental MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>"
},
"VideoContentSourceUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
}
}
},
"ListPlaybackConfigurationsRequest" : {
"type" : "structure",
"members" : {
"MaxResults" : {
"shape" : "__integerMin1Max100",
"location" : "querystring",
"locationName" : "MaxResults",
"documentation" : "<p>Maximum number of records to return. </p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "NextToken",
"documentation" : "<p>Pagination token returned by the GET list request when results overrun the meximum allowed. Use the token to fetch the next page of results.</p>"
}
}
},
"ListPlaybackConfigurationsResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfPlaybackConfigurations",
"documentation" : "<p>Array of playback configurations. This may be all of the available configurations or a subset, depending on the settings you provide and on the total number of configurations stored. </p>"
},
"NextToken" : {
"shape" : "__string",
"documentation" : "<p>Pagination token returned by the GET list request when results overrun the meximum allowed. Use the token to fetch the next page of results.</p>"
}
}
},
"PutPlaybackConfigurationRequest" : {
"type" : "structure",
"members" : {
"AdDecisionServerUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25000 characters.</p>"
},
"CdnConfiguration" : {
"shape" : "CdnConfiguration",
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
},
"Name" : {
"shape" : "__string",
"documentation" : "<p>The identifier for the configuration.</p>"
},
"SlateAdUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because AWS Elemental MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>"
},
"VideoContentSourceUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
}
}
},
"PutPlaybackConfigurationResponse" : {
"type" : "structure",
"members" : {
"AdDecisionServerUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25000 characters.</p>"
},
"CdnConfiguration" : {
"shape" : "CdnConfiguration",
"documentation" : "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>"
},
"HlsConfiguration" : {
"shape" : "HlsConfiguration",
"documentation" : "<p>The configuration for HLS content. </p>"
},
"Name" : {
"shape" : "__string",
"documentation" : "<p>The identifier for the configuration.</p>"
},
"PlaybackEndpointPrefix" : {
"shape" : "__string",
"documentation" : "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>"
},
"SessionInitializationEndpointPrefix" : {
"shape" : "__string",
"documentation" : "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>"
},
"SlateAdUrl" : {
"shape" : "__string",
"documentation" : "<p>URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because AWS Elemental MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>"
},
"VideoContentSourceUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>"
}
}
},
"__boolean" : {
"type" : "boolean"
},
"__double" : {
"type" : "double"
},
"__integer" : {
"type" : "integer"
},
"__listOfPlaybackConfigurations" : {
"type" : "list",
"member": {
"shape" : "PlaybackConfiguration"
}
},
"__long" : {
"type" : "long"
},
"__string" : {
"type" : "string"
},
"__integerMin1Max100" : {
"type": "integer",
"min": 1,
"max": 100
}
},
"documentation" : "<p>Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.<p>Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>"
}

1
botocore/data/meteringmarketplace/2016-01-14/service-2.json
View file

@ -7,6 +7,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWSMarketplace Metering",
"serviceId":"Marketplace Metering",
"signatureVersion":"v4",
"signingName":"aws-marketplace",
"targetPrefix":"AWSMPMeteringService"

5
botocore/data/mgh/2017-05-31/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Migration Hub",
"serviceId":"Migration Hub",
"signatureVersion":"v4",
"targetPrefix":"AWSMigrationHub",
"uid":"AWSMigrationHub-2017-05-31"
@ -303,7 +304,7 @@
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns.</p> <important> <ul> <li> <p>Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address.</p> </li> <li> <p>Note the instructions regarding the special use case of the <code>ResourceAttributeList</code> parameter when specifying any \"VM\" related value.</p> </li> </ul> </important> <note> <p>Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListDiscoveredResources</code>.</p> </note>"
"documentation":"<p>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns.</p> <important> <ul> <li> <p>Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address.</p> </li> <li> <p>Note the instructions regarding the special use case of the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList\"> <code>ResourceAttributeList</code> </a> parameter when specifying any \"VM\" related value. </p> </li> </ul> </important> <note> <p>Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListDiscoveredResources</code>.</p> </note>"
}
},
"shapes":{
@ -995,7 +996,7 @@
},
"ResourceAttributeList":{
"shape":"ResourceAttributeList",
"documentation":"<p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.</p> <note> <p>In the <code>ResourceAttribute</code> object array, the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code>, and the identifying value can be a string up to 256 characters.</p> </note> <important> <p>If any \"VM\" related value is used for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always used. If it is not used, the server will not be associated in the Application Discovery Service (ADS)'s repository using any of the other \"VM\" related values, and you will experience data loss. See the Example section below for a use case of specifying \"VM\" related values.</p> </important>"
"documentation":"<p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.</p> <note> <p>Takes the object array of <code>ResourceAttribute</code> where the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code> where the identifying value can be a string up to 256 characters.</p> </note> <important> <ul> <li> <p>If any \"VM\" related value is set for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always set. If <code>VM_MANAGER_ID</code> is not set, then all \"VM\" fields will be discarded and \"VM\" fields will not be used for matching the migration task to a server in Application Discovery Service (ADS)'s repository. See the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples\">Example</a> section below for a use case of specifying \"VM\" related values.</p> </li> <li> <p> If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the <code>ResourceAttributeList</code> parameter to maximize the chances of matching.</p> </li> </ul> </important>"
},
"DryRun":{
"shape":"DryRun",

1
botocore/data/mobile/2017-07-01/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Mobile",
"serviceId":"Mobile",
"signatureVersion":"v4",
"signingName":"AWSMobileHubService",
"uid":"mobile-2017-07-01"

58
botocore/data/neptune/2014-10-31/paginators-1.json Normal file
View file

@ -0,0 +1,58 @@
{
"pagination": {
"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"
},
"DescribeDBParameterGroups": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBParameterGroups"
},
"DescribeDBParameters": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "Parameters"
},
"DescribeDBSubnetGroups": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBSubnetGroups"
},
"DescribeEngineDefaultParameters": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "EngineDefaults.Marker",
"result_key": "EngineDefaults.Parameters"
},
"DescribeEventSubscriptions": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "EventSubscriptionsList"
},
"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"
}
}
}

5513
botocore/data/neptune/2014-10-31/service-2.json Normal file
View file

@ -0,0 +1,5513 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2014-10-31",
"endpointPrefix":"rds",
"protocol":"query",
"serviceAbbreviation":"Amazon Neptune",
"serviceFullName":"Amazon Neptune",
"serviceId":"Neptune",
"signatureVersion":"v4",
"signingName":"rds",
"uid":"neptune-2014-10-31",
"xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/"
},
"operations":{
"AddRoleToDBCluster":{
"name":"AddRoleToDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddRoleToDBClusterMessage"},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"DBClusterRoleAlreadyExistsFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBClusterRoleQuotaExceededFault"}
],
"documentation":"<p>Associates an Identity and Access Management (IAM) role from an Neptune DB cluster. </p>"
},
"AddSourceIdentifierToSubscription":{
"name":"AddSourceIdentifierToSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddSourceIdentifierToSubscriptionMessage"},
"output":{
"shape":"AddSourceIdentifierToSubscriptionResult",
"resultWrapper":"AddSourceIdentifierToSubscriptionResult"
},
"errors":[
{"shape":"SubscriptionNotFoundFault"},
{"shape":"SourceNotFoundFault"}
],
"documentation":"<p>Adds a source identifier to an existing event notification subscription.</p>"
},
"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 Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.</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>You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the <code>CopyDBClusterSnapshot</code> action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.</p> </li> <li> <p> <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.</p> <p>The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The 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 pre-signed 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:neptune-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL. </p> </li> </ul> <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in \"copying\" status.</p>"
},
"CopyDBParameterGroup":{
"name":"CopyDBParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CopyDBParameterGroupMessage"},
"output":{
"shape":"CopyDBParameterGroupResult",
"resultWrapper":"CopyDBParameterGroupResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"},
{"shape":"DBParameterGroupQuotaExceededFault"}
],
"documentation":"<p>Copies the specified DB parameter group.</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 Neptune DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance. For cross-region replication where the DB cluster identified by <code>ReplicationSourceIdentifier</code> is encrypted, you must also specify the <code>PreSignedUrl</code> parameter.</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 creating it using <a>ModifyDBClusterParameterGroup</a>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <a>ModifyDBCluster</a>. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. </p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon Neptune console</a> or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified.</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":"ProvisionedIopsNotAvailableInAZFault"},
{"shape":"OptionGroupNotFoundFault"},
{"shape":"DBClusterNotFoundFault"},
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DomainNotFoundFault"}
],
"documentation":"<p>Creates a new DB instance.</p>"
},
"CreateDBParameterGroup":{
"name":"CreateDBParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBParameterGroupMessage"},
"output":{
"shape":"CreateDBParameterGroupResult",
"resultWrapper":"CreateDBParameterGroupResult"
},
"errors":[
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
"documentation":"<p>Creates a new DB parameter group.</p> <p> A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <i>ModifyDBParameterGroup</i>. Once you've created a DB parameter group, you need to associate it with your DB instance using <i>ModifyDBInstance</i>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. </p> <important> <p>After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the Amazon Neptune console or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
},
"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 AZs in the AWS Region.</p>"
},
"CreateEventSubscription":{
"name":"CreateEventSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEventSubscriptionMessage"},
"output":{
"shape":"CreateEventSubscriptionResult",
"resultWrapper":"CreateEventSubscriptionResult"
},
"errors":[
{"shape":"EventSubscriptionQuotaExceededFault"},
{"shape":"SubscriptionAlreadyExistFault"},
{"shape":"SNSInvalidTopicFault"},
{"shape":"SNSNoAuthorizationFault"},
{"shape":"SNSTopicArnNotFoundFault"},
{"shape":"SubscriptionCategoryNotFoundFault"},
{"shape":"SourceNotFoundFault"}
],
"documentation":"<p>Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.</p> <p>You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.</p> <p>If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.</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>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p/>"
},
"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>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p> <p> If you request a final DB snapshot the status of the Amazon Neptune DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. </p> <p>Note that when a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when the <code>SkipFinalSnapshot</code> parameter is set to <code>true</code>.</p> <p>If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true:</p> <ul> <li> <p>The DB cluster is a Read Replica of another DB cluster.</p> </li> <li> <p>The DB instance is the only instance in the DB cluster.</p> </li> </ul> <p>To delete a DB instance in this case, first call the <a>PromoteReadReplicaDBCluster</a> API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster.</p>"
},
"DeleteDBParameterGroup":{
"name":"DeleteDBParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBParameterGroupMessage"},
"errors":[
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.</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>"
},
"DeleteEventSubscription":{
"name":"DeleteEventSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEventSubscriptionMessage"},
"output":{
"shape":"DeleteEventSubscriptionResult",
"resultWrapper":"DeleteEventSubscriptionResult"
},
"errors":[
{"shape":"SubscriptionNotFoundFault"},
{"shape":"InvalidEventSubscriptionStateFault"}
],
"documentation":"<p>Deletes an event notification subscription.</p>"
},
"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 will contain 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 sharing 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> <p>To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the <a>ModifyDBClusterSnapshotAttribute</a> API action.</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 action 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 DB clusters. This API 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 instances. This API supports pagination.</p>"
},
"DescribeDBParameterGroups":{
"name":"DescribeDBParameterGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBParameterGroupsMessage"},
"output":{
"shape":"DBParameterGroupsMessage",
"resultWrapper":"DescribeDBParameterGroupsResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p> Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group. </p>"
},
"DescribeDBParameters":{
"name":"DescribeDBParameters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBParametersMessage"},
"output":{
"shape":"DBParameterGroupDetails",
"resultWrapper":"DescribeDBParametersResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Returns the detailed parameter list for a particular DB parameter group.</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 DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.</p> <p>For an overview of CIDR ranges, go to the <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Wikipedia Tutorial</a>. </p>"
},
"DescribeEngineDefaultClusterParameters":{
"name":"DescribeEngineDefaultClusterParameters",
"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>"
},
"DescribeEngineDefaultParameters":{
"name":"DescribeEngineDefaultParameters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEngineDefaultParametersMessage"},
"output":{
"shape":"DescribeEngineDefaultParametersResult",
"resultWrapper":"DescribeEngineDefaultParametersResult"
},
"documentation":"<p>Returns the default engine and system parameter information for the specified 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>"
},
"DescribeEventSubscriptions":{
"name":"DescribeEventSubscriptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventSubscriptionsMessage"},
"output":{
"shape":"EventSubscriptionsMessage",
"resultWrapper":"DescribeEventSubscriptionsResult"
},
"errors":[
{"shape":"SubscriptionNotFoundFault"}
],
"documentation":"<p>Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.</p> <p>If you specify a SubscriptionName, lists the description for that subscription.</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. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events 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>"
},
"DescribeValidDBInstanceModifications":{
"name":"DescribeValidDBInstanceModifications",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeValidDBInstanceModificationsMessage"},
"output":{
"shape":"DescribeValidDBInstanceModificationsResult",
"resultWrapper":"DescribeValidDBInstanceModificationsResult"
},
"errors":[
{"shape":"DBInstanceNotFoundFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
"documentation":"<p>You can call <a>DescribeValidDBInstanceModifications</a> to learn what modifications you can make to your DB instance. You can use this information when you call <a>ModifyDBInstance</a>. </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 Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).</p> <p>Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.</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 Neptune 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>Modify a setting for a 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 without failover to the DB cluster associated with the parameter group 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 Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the Amazon Neptune console or the <a>DescribeDBClusterParameters</a> command to verify that your DB cluster parameter group has been created or modified.</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> <p>To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API action.</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":"ProvisionedIopsNotAvailableInAZFault"},
{"shape":"OptionGroupNotFoundFault"},
{"shape":"DBUpgradeDependencyFailureFault"},
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"CertificateNotFoundFault"},
{"shape":"DomainNotFoundFault"}
],
"documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call <a>DescribeValidDBInstanceModifications</a> before you call <a>ModifyDBInstance</a>. </p>"
},
"ModifyDBParameterGroup":{
"name":"ModifyDBParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBParameterGroupMessage"},
"output":{
"shape":"DBParameterGroupNameMessage",
"resultWrapper":"ModifyDBParameterGroupResult"
},
"errors":[
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"InvalidDBParameterGroupStateFault"}
],
"documentation":"<p> Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <note> <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.</p> </note> <important> <p>After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the Amazon Neptune console or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>"
},
"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 AZs in the AWS Region.</p>"
},
"ModifyEventSubscription":{
"name":"ModifyEventSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyEventSubscriptionMessage"},
"output":{
"shape":"ModifyEventSubscriptionResult",
"resultWrapper":"ModifyEventSubscriptionResult"
},
"errors":[
{"shape":"EventSubscriptionQuotaExceededFault"},
{"shape":"SubscriptionNotFoundFault"},
{"shape":"SNSInvalidTopicFault"},
{"shape":"SNSNoAuthorizationFault"},
{"shape":"SNSTopicArnNotFoundFault"},
{"shape":"SubscriptionCategoryNotFoundFault"}
],
"documentation":"<p>Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the <a>AddSourceIdentifierToSubscription</a> and <a>RemoveSourceIdentifierFromSubscription</a> calls.</p> <p>You can see a list of the event categories for a given SourceType by using the <b>DescribeEventCategories</b> action.</p>"
},
"PromoteReadReplicaDBCluster":{
"name":"PromoteReadReplicaDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PromoteReadReplicaDBClusterMessage"},
"output":{
"shape":"PromoteReadReplicaDBClusterResult",
"resultWrapper":"PromoteReadReplicaDBClusterResult"
},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"}
],
"documentation":"<p>Promotes a Read Replica DB cluster to a standalone DB cluster.</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 modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. </p>"
},
"RemoveRoleFromDBCluster":{
"name":"RemoveRoleFromDBCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveRoleFromDBClusterMessage"},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"DBClusterRoleNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"}
],
"documentation":"<p>Disassociates an Identity and Access Management (IAM) role from a DB cluster. </p>"
},
"RemoveSourceIdentifierFromSubscription":{
"name":"RemoveSourceIdentifierFromSubscription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"},
"output":{
"shape":"RemoveSourceIdentifierFromSubscriptionResult",
"resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult"
},
"errors":[
{"shape":"SubscriptionNotFoundFault"},
{"shape":"SourceNotFoundFault"}
],
"documentation":"<p>Removes a source identifier from an existing event notification subscription.</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 Neptune 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 resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <a>RebootDBInstance</a> request. You must call <a>RebootDBInstance</a> for every DB instance in your DB cluster that you want the updated static parameter to apply to.</p>"
},
"ResetDBParameterGroup":{
"name":"ResetDBParameterGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetDBParameterGroupMessage"},
"output":{
"shape":"DBParameterGroupNameMessage",
"resultWrapper":"ResetDBParameterGroupResult"
},
"errors":[
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. </p>"
},
"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":"OptionGroupNotFoundFault"},
{"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":"OptionGroupNotFoundFault"},
{"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> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <a>CreateDBInstance</a> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB cluster is available.</p> </note>"
}
},
"shapes":{
"AddRoleToDBClusterMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"RoleArn"
],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The name of the DB cluster to associate the IAM role with.</p>"
},
"RoleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example <code>arn:aws:iam::123456789012:role/NeptuneAccessRole</code>.</p>"
}
}
},
"AddSourceIdentifierToSubscriptionMessage":{
"type":"structure",
"required":[
"SubscriptionName",
"SourceIdentifier"
],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"<p>The name of the event notification subscription you want to add a source identifier to.</p>"
},
"SourceIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the event source to be added.</p> <p>Constraints:</p> <ul> <li> <p>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</p> </li> <li> <p>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</p> </li> </ul>"
}
},
"documentation":"<p/>"
},
"AddSourceIdentifierToSubscriptionResult":{
"type":"structure",
"members":{
"EventSubscription":{"shape":"EventSubscription"}
}
},
"AddTagsToResourceMessage":{
"type":"structure",
"required":[
"ResourceName",
"Tags"
],
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing\"> Constructing an Amazon Resource Name (ARN)</a>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the Amazon Neptune resource.</p>"
}
},
"documentation":"<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. For information about creating an ARN, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing\"> Constructing an Amazon Resource Name (ARN)</a>.</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/>"
},
"ApplyPendingMaintenanceActionResult":{
"type":"structure",
"members":{
"ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"}
}
},
"AttributeValueList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"AttributeValue"
}
},
"AuthorizationNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.</p> <p>Neptune may not also be authorized via IAM to perform necessary actions on your behalf.</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>Contains Availability Zone information.</p> <p> This data type is used as an element in the following data type:</p> <ul> <li> <p> <a>OrderableDBInstanceOption</a> </p> </li> </ul>",
"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> <i>CertificateIdentifier</i> does not refer to an existing certificate. </p>",
"error":{
"code":"CertificateNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"CharacterSet":{
"type":"structure",
"members":{
"CharacterSetName":{
"shape":"String",
"documentation":"<p>The name of the character set.</p>"
},
"CharacterSetDescription":{
"shape":"String",
"documentation":"<p>The description of the character set.</p>"
}
},
"documentation":"<p> This data type is used as a response element in the action <a>DescribeDBEngineVersions</a>. </p>"
},
"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 CloudWatch Logs for a specific DB instance or DB cluster.</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. For information about creating an ARN, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing\"> Constructing an Amazon Resource Name (ARN)</a>. </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>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"}
}
},
"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>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 AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. </p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, Amazon Neptune encrypts the target DB cluster snapshot using the specified 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 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 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, you must set <code>KmsKeyId</code> to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.</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. The <code>PreSignedUrl</code> parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.</p> <p>The pre-signed 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 pre-signed 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 pre-signed 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:neptune-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p>"
},
"CopyTags":{
"shape":"BooleanOptional",
"documentation":"<p>True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.</p>"
},
"Tags":{"shape":"TagList"}
},
"documentation":"<p/>"
},
"CopyDBClusterSnapshotResult":{
"type":"structure",
"members":{
"DBClusterSnapshot":{"shape":"DBClusterSnapshot"}
}
},
"CopyDBParameterGroupMessage":{
"type":"structure",
"required":[
"SourceDBParameterGroupIdentifier",
"TargetDBParameterGroupIdentifier",
"TargetDBParameterGroupDescription"
],
"members":{
"SourceDBParameterGroupIdentifier":{
"shape":"String",
"documentation":"<p> The identifier or ARN for the source DB parameter group. For information about creating an ARN, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing\"> Constructing an Amazon Resource Name (ARN)</a>. </p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB parameter group.</p> </li> <li> <p>Must specify a valid DB parameter group identifier, for example <code>my-db-param-group</code>, or a valid ARN.</p> </li> </ul>"
},
"TargetDBParameterGroupIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the copied DB 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>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-db-parameter-group</code> </p>"
},
"TargetDBParameterGroupDescription":{
"shape":"String",
"documentation":"<p>A description for the copied DB parameter group.</p>"
},
"Tags":{"shape":"TagList"}
},
"documentation":"<p/>"
},
"CopyDBParameterGroupResult":{
"type":"structure",
"members":{
"DBParameterGroup":{"shape":"DBParameterGroup"}
}
},
"CreateDBClusterMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"Engine"
],
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>A list of 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>"
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>A value that indicates that the DB cluster should be associated with the specified CharacterSet.</p>"
},
"DatabaseName":{
"shape":"String",
"documentation":"<p>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.</p>"
},
"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>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-cluster1</code> </p>"
},
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p> The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"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 DBSubnetGroup. 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>neptune</code> </p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</p> <p>Example: <code>1.0.1</code> </p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the instances in the DB cluster accept connections.</p> <p> Default: <code>8182</code> </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 1 to 16 letters or numbers.</p> </li> <li> <p>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>"
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>A value that indicates that the DB cluster should be associated with the specified option group.</p> <p>Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.</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. To see the time blocks available, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html\"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon Neptune User Guide.</i> </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html\"> Adjusting the Preferred Maintenance Window</a> in the <i>Amazon Neptune User Guide.</i> </p> <p>Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> <p>Constraints: Minimum 30-minute window.</p>"
},
"ReplicationSourceIdentifier":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.</p>"
},
"Tags":{"shape":"TagList"},
"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 KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the 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 Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is true and <code>ReplicationSourceIdentifier</code> is not specified, then Amazon Neptune will use 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 Read 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 Read Replica in that AWS Region.</p>"
},
"PreSignedUrl":{
"shape":"String",
"documentation":"<p>A URL that contains a Signature Version 4 signed request for the <code>CreateDBCluster</code> action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify <code>PreSignedUrl</code> when you are performing cross-region replication from an encrypted DB cluster.</p> <p>The pre-signed URL must be a valid request for the <code>CreateDBCluster</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.</p> <p>The pre-signed 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 in the destination AWS Region. This should refer to the same KMS key for both the <code>CreateDBCluster</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that Read Replica will be created in.</p> </li> <li> <p> <code>ReplicationSourceIdentifier</code> - The DB cluster identifier for the encrypted DB cluster 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 from the us-west-2 AWS Region, then your <code>ReplicationSourceIdentifier</code> would look like Example: <code>arn:aws:rds:us-west-2:123456789012:cluster:neptune-cluster1</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.</p> <p>Default: <code>false</code> </p>"
}
},
"documentation":"<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 DBClusterParameterGroup.</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. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description for the DB cluster parameter group.</p>"
},
"Tags":{"shape":"TagList"}
},
"documentation":"<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>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-cluster1-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 DBCluster.</p> </li> </ul> <p>Example: <code>my-cluster1</code> </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster snapshot.</p>"
}
},
"documentation":"<p/>"
},
"CreateDBClusterSnapshotResult":{
"type":"structure",
"members":{
"DBClusterSnapshot":{"shape":"DBClusterSnapshot"}
}
},
"CreateDBInstanceMessage":{
"type":"structure",
"required":[
"DBInstanceIdentifier",
"DBInstanceClass",
"Engine"
],
"members":{
"DBName":{
"shape":"String",
"documentation":"<p>The database name. </p> <p>Type: String</p>"
},
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p>The amount of storage (in gibibytes) to allocate for the DB instance.</p> <p>Type: Integer</p> <p>Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.</p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The 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>"
},
"Engine":{
"shape":"String",
"documentation":"<p>The name of the database engine to be used for this instance. </p> <p>Valid Values: <code>neptune</code> </p>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>The name for the master user. Not used.</p>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p> Not used. </p>"
},
"DBSecurityGroups":{
"shape":"DBSecurityGroupNameList",
"documentation":"<p>A list of DB security groups to associate with this DB instance.</p> <p>Default: The default DB security group for the database engine.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of EC2 VPC security groups to associate with this DB instance.</p> <p>Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p> <p>Default: The default EC2 VPC security group for the DB subnet group's VPC.</p>"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p> The 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 AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>A DB subnet group to associate with this DB instance.</p> <p>If there is no DB subnet group, then it is a non-VPC DB instance.</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>"
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days for which automated backups are retained.</p> <p>Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 0 to 35</p> </li> <li> <p>Cannot be set to 0 if the DB instance is a source to Read Replicas</p> </li> </ul>"
},
"PreferredBackupWindow":{
"shape":"String",
"documentation":"<p> The daily time range during which automated backups are created. </p> <p>Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the database accepts connections.</p> <p>Not applicable. The port is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p> <p> Default: <code>8182</code> </p> <p>Type: Integer</p>"
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</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>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>License model information for this DB instance.</p> <p> Valid values: <code>license-included</code> | <code>bring-your-own-license</code> | <code>general-public-license</code> </p>"
},
"Iops":{
"shape":"IntegerOptional",
"documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. </p>"
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>Indicates that the DB instance should be associated with the specified option group.</p> <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance</p>"
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>Indicates that the DB instance should be associated with the specified CharacterSet.</p> <p>Not applicable. The character set is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>This parameter is not supported.</p>",
"deprecated":true
},
"Tags":{"shape":"TagList"},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster that the instance will belong to.</p> <p>For information on creating a DB cluster, see <a>CreateDBCluster</a>.</p> <p>Type: String</p>"
},
"StorageType":{
"shape":"String",
"documentation":"<p>Specifies the storage type to be associated with the DB instance.</p> <p>Not applicable. Storage is managed by the DB Cluster.</p>"
},
"TdeCredentialArn":{
"shape":"String",
"documentation":"<p>The ARN from the key store with which to associate the instance for TDE encryption.</p>"
},
"TdeCredentialPassword":{
"shape":"String",
"documentation":"<p>The password for the given ARN from the key store in order to access the device.</p>"
},
"StorageEncrypted":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies whether the DB instance is encrypted.</p> <p>Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p> <p>Default: false</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for an encrypted DB instance.</p> <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.</p> <p>Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p> <p>If the <code>StorageEncrypted</code> parameter is true, and you do not specify a value for the <code>KmsKeyId</code> parameter, then Amazon Neptune will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p>"
},
"Domain":{
"shape":"String",
"documentation":"<p>Specify the Active Directory Domain to create the instance in.</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
"documentation":"<p>True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.</p>"
},
"MonitoringInterval":{
"shape":"IntegerOptional",
"documentation":"<p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.</p> <p>If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0.</p> <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </p>"
},
"MonitoringRoleArn":{
"shape":"String",
"documentation":"<p>The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>.</p> <p>If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value.</p>"
},
"DomainIAMRoleName":{
"shape":"String",
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Read 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>"
},
"Timezone":{
"shape":"String",
"documentation":"<p>The time zone of the DB instance. </p>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable AWS Identity and Access Management (IAM) authentication for Neptune.</p> <p>Default: <code>false</code> </p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable Performance Insights for the DB instance, and otherwise false. </p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p>"
}
},
"documentation":"<p/>"
},
"CreateDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"CreateDBParameterGroupMessage":{
"type":"structure",
"required":[
"DBParameterGroupName",
"DBParameterGroupFamily",
"Description"
],
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>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>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description for the DB parameter group.</p>"
},
"Tags":{"shape":"TagList"}
},
"documentation":"<p/>"
},
"CreateDBParameterGroupResult":{
"type":"structure",
"members":{
"DBParameterGroup":{"shape":"DBParameterGroup"}
}
},
"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 EC2 Subnet IDs for the DB subnet group.</p>"
},
"Tags":{"shape":"TagList"}
},
"documentation":"<p/>"
},
"CreateDBSubnetGroupResult":{
"type":"structure",
"members":{
"DBSubnetGroup":{"shape":"DBSubnetGroup"}
}
},
"CreateEventSubscriptionMessage":{
"type":"structure",
"required":[
"SubscriptionName",
"SnsTopicArn"
],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"<p>The name of the subscription.</p> <p>Constraints: The name must be less than 255 characters.</p>"
},
"SnsTopicArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>"
},
"SourceType":{
"shape":"String",
"documentation":"<p>The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.</p> <p>Valid values: <code>db-instance</code> | <code>db-cluster</code> | <code>db-parameter-group</code> | <code>db-security-group</code> | <code>db-snapshot</code> | <code>db-cluster-snapshot</code> </p>"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"<p> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the <b>DescribeEventCategories</b> action. </p>"
},
"SourceIds":{
"shape":"SourceIdsList",
"documentation":"<p>The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p> <p>Constraints:</p> <ul> <li> <p>If SourceIds are supplied, SourceType must also be provided.</p> </li> <li> <p>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</p> </li> <li> <p>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</p> </li> </ul>"
},
"Enabled":{
"shape":"BooleanOptional",
"documentation":"<p> A Boolean value; set to <b>true</b> to activate the subscription, set to <b>false</b> to create the subscription but not active it. </p>"
},
"Tags":{"shape":"TagList"}
},
"documentation":"<p/>"
},
"CreateEventSubscriptionResult":{
"type":"structure",
"members":{
"EventSubscription":{"shape":"EventSubscription"}
}
},
"DBCluster":{
"type":"structure",
"members":{
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p> <code>AllocatedStorage</code> always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of 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>"
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>If present, specifies the name of the character set that this cluster is associated with.</p>"
},
"DatabaseName":{
"shape":"String",
"documentation":"<p>Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.</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 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>Specifies 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 Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster. </p> <p>If a failover occurs, and the Read 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 Read 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 username for the DB cluster.</p>"
},
"DBClusterOptionGroupMemberships":{
"shape":"DBClusterOptionGroupMemberships",
"documentation":"<p>Provides the list of option group memberships for this 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>"
},
"ReplicationSourceIdentifier":{
"shape":"String",
"documentation":"<p>Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.</p>"
},
"ReadReplicaIdentifiers":{
"shape":"ReadReplicaIdentifierList",
"documentation":"<p>Contains one or more identifiers of the Read Replicas associated with this DB cluster.</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 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 true, 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>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p>"
},
"CloneGroupId":{
"shape":"String",
"documentation":"<p>Identifies the clone group to which the DB cluster is associated.</p>"
},
"ClusterCreateTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"
}
},
"documentation":"<p>Contains the details of an Amazon Neptune DB cluster. </p> <p>This data type is used as a response element in the <a>DescribeDBClusters</a> action. </p>",
"wrapper":true
},
"DBClusterAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>User already has 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>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 a Read 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>A pagination token that can be used in a subsequent DescribeDBClusters request.</p>"
},
"DBClusters":{
"shape":"DBClusterList",
"documentation":"<p>Contains a list of DB clusters for the user.</p>"
}
},
"documentation":"<p>Contains the result of a successful invocation of the <a>DescribeDBClusters</a> action.</p>"
},
"DBClusterNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster. </p>",
"error":{
"code":"DBClusterNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBClusterOptionGroupMemberships":{
"type":"list",
"member":{
"shape":"DBClusterOptionGroupStatus",
"locationName":"DBClusterOptionGroup"
}
},
"DBClusterOptionGroupStatus":{
"type":"structure",
"members":{
"DBClusterOptionGroupName":{
"shape":"String",
"documentation":"<p>Specifies the name of the DB cluster option group.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Specifies the status of the DB cluster option group.</p>"
}
},
"documentation":"<p>Contains status information for a DB cluster option group.</p>"
},
"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>Contains the details of an Amazon Neptune DB cluster parameter group. </p> <p>This data type is used as a response element in the <a>DescribeDBClusterParameterGroups</a> action. </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 DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </p>"
}
},
"documentation":"<p>Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.</p>"
},
"DBClusterParameterGroupList":{
"type":"list",
"member":{
"shape":"DBClusterParameterGroup",
"locationName":"DBClusterParameterGroup"
}
},
"DBClusterParameterGroupNameMessage":{
"type":"structure",
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters or numbers.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>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/>"
},
"DBClusterParameterGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBClusterParameterGroupName</i> does not 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 <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
},
"DBClusterParameterGroups":{
"shape":"DBClusterParameterGroupList",
"documentation":"<p>A list of DB cluster parameter groups.</p>"
}
},
"documentation":"<p/>"
},
"DBClusterQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.</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 Status 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 is unable to assume the IAM role in order 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>"
},
"DBClusterRoleAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.</p>",
"error":{
"code":"DBClusterRoleAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBClusterRoleNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.</p>",
"error":{
"code":"DBClusterRoleNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBClusterRoleQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.</p>",
"error":{
"code":"DBClusterRoleQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBClusterRoles":{
"type":"list",
"member":{
"shape":"DBClusterRole",
"locationName":"DBClusterRole"
}
},
"DBClusterSnapshot":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of 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 Universal Coordinated Time (UTC).</p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>Specifies the name of the database engine.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>Specifies the allocated storage size in gibibytes (GiB).</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 VPC ID 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 username for the DB cluster snapshot.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>Provides the version of the database engine for this DB cluster snapshot.</p>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>Provides the license model information 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 true, 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 Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.</p>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p>"
}
},
"documentation":"<p>Contains the details for an Amazon Neptune DB cluster snapshot </p> <p>This data type is used as a response element in the <a>DescribeDBClusterSnapshots</a> action. </p>",
"wrapper":true
},
"DBClusterSnapshotAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>User already has 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. For more information, see the <a>ModifyDBClusterSnapshotAttribute</a> API action.</p>"
},
"AttributeValues":{
"shape":"AttributeValueList",
"documentation":"<p>The value(s) 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. For more information, see the <a>ModifyDBClusterSnapshotAttribute</a> API action.</p>"
},
"DBClusterSnapshotAttributeList":{
"type":"list",
"member":{
"shape":"DBClusterSnapshotAttribute",
"locationName":"DBClusterSnapshotAttribute"
}
},
"DBClusterSnapshotAttributesResult":{
"type":"structure",
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the manual DB cluster snapshot that the attributes apply to.</p>"
},
"DBClusterSnapshotAttributes":{
"shape":"DBClusterSnapshotAttributeList",
"documentation":"<p>The list of attributes and values for the manual DB cluster snapshot.</p>"
}
},
"documentation":"<p>Contains the results of a successful call to the <a>DescribeDBClusterSnapshotAttributes</a> API action.</p> <p>Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the <a>ModifyDBClusterSnapshotAttribute</a> API action.</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 <a>DescribeDBClusterSnapshots</a> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
},
"DBClusterSnapshots":{
"shape":"DBClusterSnapshotList",
"documentation":"<p>Provides a list of DB cluster snapshots for the user.</p>"
}
},
"documentation":"<p> Provides a list of DB cluster snapshots for the user as the result of a call to the <a>DescribeDBClusterSnapshots</a> action. </p>"
},
"DBClusterSnapshotNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBClusterSnapshotIdentifier</i> does not 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>"
},
"DefaultCharacterSet":{
"shape":"CharacterSet",
"documentation":"<p> The default character set for new instances of this engine version, if the <code>CharacterSetName</code> parameter of the CreateDBInstance API is not specified. </p>"
},
"SupportedCharacterSets":{
"shape":"SupportedCharacterSetsList",
"documentation":"<p> A list of the character sets supported by this engine for the <code>CharacterSetName</code> parameter of the <code>CreateDBInstance</code> action. </p>"
},
"ValidUpgradeTarget":{
"shape":"ValidUpgradeTargetList",
"documentation":"<p>A list of engine versions that this database engine version can be upgraded to.</p>"
},
"SupportedTimezones":{
"shape":"SupportedTimezonesList",
"documentation":"<p>A list of the time zones supported by this engine for the <code>Timezone</code> parameter of the <code>CreateDBInstance</code> action. </p>"
},
"ExportableLogTypes":{
"shape":"LogTypeList",
"documentation":"<p>The types of logs that the database engine has available for export to CloudWatch Logs.</p>"
},
"SupportsLogExportsToCloudwatchLogs":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.</p>"
},
"SupportsReadReplica":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the database engine version supports read replicas.</p>"
}
},
"documentation":"<p> This data type is used as a response element in the action <a>DescribeDBEngineVersions</a>. </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> A list of <code>DBEngineVersion</code> elements. </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeDBEngineVersions</a> action. </p>"
},
"DBInstance":{
"type":"structure",
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>Contains a user-supplied 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>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>Contains the master username for the DB instance.</p>"
},
"DBName":{
"shape":"String",
"documentation":"<p>The database name.</p>"
},
"Endpoint":{
"shape":"Endpoint",
"documentation":"<p>Specifies the connection endpoint.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
"documentation":"<p>Specifies the allocated storage size specified in gibibytes.</p>"
},
"InstanceCreateTime":{
"shape":"TStamp",
"documentation":"<p>Provides the date and time 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>"
},
"DBSecurityGroups":{
"shape":"DBSecurityGroupMembershipList",
"documentation":"<p> Provides List of DB security group elements containing only <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements. </p>"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
"documentation":"<p>Provides a list of VPC security group elements that the DB instance belongs to.</p>"
},
"DBParameterGroups":{
"shape":"DBParameterGroupStatusList",
"documentation":"<p>Provides the list of DB parameter groups applied to this DB instance.</p>"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>Specifies the name of the Availability Zone the DB instance is located in.</p>"
},
"DBSubnetGroup":{
"shape":"DBSubnetGroup",
"documentation":"<p>Specifies information on the subnet group 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 only included 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>"
},
"MultiAZ":{
"shape":"Boolean",
"documentation":"<p>Specifies if the DB instance is a Multi-AZ deployment.</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>"
},
"ReadReplicaSourceDBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>Contains the identifier of the source DB instance if this DB instance is a Read Replica.</p>"
},
"ReadReplicaDBInstanceIdentifiers":{
"shape":"ReadReplicaDBInstanceIdentifierList",
"documentation":"<p>Contains one or more identifiers of the Read Replicas associated with this DB instance.</p>"
},
"ReadReplicaDBClusterIdentifiers":{
"shape":"ReadReplicaDBClusterIdentifierList",
"documentation":"<p>Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.</p>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>License model information for this DB instance.</p>"
},
"Iops":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the Provisioned IOPS (I/O operations per second) value.</p>"
},
"OptionGroupMemberships":{
"shape":"OptionGroupMembershipList",
"documentation":"<p>Provides the list of option group memberships for this DB instance.</p>"
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>If present, specifies the name of the character set that this instance is associated with.</p>"
},
"SecondaryAvailabilityZone":{
"shape":"String",
"documentation":"<p>If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.</p>"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>This parameter is not supported.</p>",
"deprecated":true
},
"StatusInfos":{
"shape":"DBInstanceStatusInfoList",
"documentation":"<p>The status of a Read Replica. If the instance is not a Read Replica, this is blank.</p>"
},
"StorageType":{
"shape":"String",
"documentation":"<p>Specifies the storage type associated with DB instance.</p>"
},
"TdeCredentialArn":{
"shape":"String",
"documentation":"<p>The ARN from the key store with which the instance is associated for TDE encryption.</p>"
},
"DbInstancePort":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB instance is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p> If <code>StorageEncrypted</code> is true, 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>"
},
"CACertificateIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the CA certificate for this DB instance.</p>"
},
"DomainMemberships":{
"shape":"DomainMembershipList",
"documentation":"<p>Not supported</p>"
},
"CopyTagsToSnapshot":{
"shape":"Boolean",
"documentation":"<p>Specifies whether tags are copied from the DB instance to snapshots of the DB instance.</p>"
},
"MonitoringInterval":{
"shape":"IntegerOptional",
"documentation":"<p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.</p>"
},
"EnhancedMonitoringResourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.</p>"
},
"MonitoringRoleArn":{
"shape":"String",
"documentation":"<p>The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which a Read 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>"
},
"Timezone":{
"shape":"String",
"documentation":"<p>Not supported. </p>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.</p>"
},
"PerformanceInsightsEnabled":{
"shape":"BooleanOptional",
"documentation":"<p>True if Performance Insights is enabled for the DB instance, and otherwise false.</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p>"
}
},
"documentation":"<p>Contains the details of an Amazon Neptune DB instance. </p> <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action. </p>",
"wrapper":true
},
"DBInstanceAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>User already has 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> A list of <a>DBInstance</a> instances. </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeDBInstances</a> action. </p>"
},
"DBInstanceNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBInstanceIdentifier</i> does not 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 \"read replication.\"</p>"
},
"Normal":{
"shape":"Boolean",
"documentation":"<p>Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.</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"
}
},
"DBParameterGroup":{
"type":"structure",
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>Provides the name of the DB parameter group.</p>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>Provides the name of the DB parameter group family that this DB parameter group is compatible with.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>Provides the customer-specified description for this DB parameter group.</p>"
},
"DBParameterGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB parameter group.</p>"
}
},
"documentation":"<p>Contains the details of an Amazon Neptune DB parameter group. </p> <p>This data type is used as a response element in the <a>DescribeDBParameterGroups</a> action. </p>",
"wrapper":true
},
"DBParameterGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>A DB parameter group with the same name exists.</p>",
"error":{
"code":"DBParameterGroupAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBParameterGroupDetails":{
"type":"structure",
"members":{
"Parameters":{
"shape":"ParametersList",
"documentation":"<p> A list of <a>Parameter</a> values. </p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeDBParameters</a> action. </p>"
},
"DBParameterGroupList":{
"type":"list",
"member":{
"shape":"DBParameterGroup",
"locationName":"DBParameterGroup"
}
},
"DBParameterGroupNameMessage":{
"type":"structure",
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>Provides the name of the DB parameter group.</p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>ModifyDBParameterGroup</a> or <a>ResetDBParameterGroup</a> action. </p>"
},
"DBParameterGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group. </p>",
"error":{
"code":"DBParameterGroupNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBParameterGroupQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Request would result in user exceeding the allowed number of DB parameter groups.</p>",
"error":{
"code":"DBParameterGroupQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBParameterGroupStatus":{
"type":"structure",
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DP parameter group.</p>"
},
"ParameterApplyStatus":{
"shape":"String",
"documentation":"<p>The status of parameter updates.</p>"
}
},
"documentation":"<p>The status of the DB parameter group.</p> <p>This data type is used as a response element in the following actions:</p> <ul> <li> <p> <a>CreateDBInstance</a> </p> </li> <li> <p> <a>DeleteDBInstance</a> </p> </li> <li> <p> <a>ModifyDBInstance</a> </p> </li> <li> <p> <a>RebootDBInstance</a> </p> </li> </ul>"
},
"DBParameterGroupStatusList":{
"type":"list",
"member":{
"shape":"DBParameterGroupStatus",
"locationName":"DBParameterGroup"
}
},
"DBParameterGroupsMessage":{
"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>"
},
"DBParameterGroups":{
"shape":"DBParameterGroupList",
"documentation":"<p> A list of <a>DBParameterGroup</a> instances. </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeDBParameterGroups</a> action. </p>"
},
"DBSecurityGroupMembership":{
"type":"structure",
"members":{
"DBSecurityGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB security group.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the DB security group.</p>"
}
},
"documentation":"<p>This data type is used as a response element in the following actions:</p> <ul> <li> <p> <a>ModifyDBInstance</a> </p> </li> <li> <p> <a>RebootDBInstance</a> </p> </li> </ul>"
},
"DBSecurityGroupMembershipList":{
"type":"list",
"member":{
"shape":"DBSecurityGroupMembership",
"locationName":"DBSecurityGroup"
}
},
"DBSecurityGroupNameList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"DBSecurityGroupName"
}
},
"DBSecurityGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBSecurityGroupName</i> does not refer to an existing DB security group. </p>",
"error":{
"code":"DBSecurityGroupNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBSnapshotAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBSnapshotIdentifier</i> is already used by an existing snapshot. </p>",
"error":{
"code":"DBSnapshotAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBSnapshotNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBSnapshotIdentifier</i> does not 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 VpcId 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> Contains a list of <a>Subnet</a> elements. </p>"
},
"DBSubnetGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB subnet group.</p>"
}
},
"documentation":"<p>Contains the details of an Amazon Neptune DB subnet group. </p> <p>This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action. </p>",
"wrapper":true
},
"DBSubnetGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBSubnetGroupName</i> is already 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> A list of <a>DBSubnetGroup</a> instances. </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeDBSubnetGroups</a> action. </p>"
},
"DBSubnetGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>DBSubnetGroupName</i> does not refer to an existing DB subnet group. </p>",
"error":{
"code":"DBSubnetGroupNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBSubnetGroupQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Request would result in user exceeding 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>Request would result in user exceeding the allowed number of subnets in a DB subnet groups.</p>",
"error":{
"code":"DBSubnetQuotaExceededFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBUpgradeDependencyFailureFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB upgrade failed because a resource the DB depends on could not 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 DBClusterIdentifier.</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>You must specify a <code>FinalDBSnapshotIdentifier</code> parameter if <code>SkipFinalSnapshot</code> is <code>false</code>.</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 true results in an error. </p> </note> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
}
},
"documentation":"<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/>"
},
"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/>"
},
"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>"
},
"SkipFinalSnapshot":{
"shape":"Boolean",
"documentation":"<p> Determines whether a final DB snapshot is created before the DB instance is deleted. If <code>true</code> is specified, no DBSnapshot is created. If <code>false</code> is specified, a DB snapshot is created before the DB instance is deleted. </p> <p>Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to \"true\".</p> <p>Specify <code>true</code> when deleting a Read Replica.</p> <note> <p>The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is <code>false</code>.</p> </note> <p>Default: <code>false</code> </p>"
},
"FinalDBSnapshotIdentifier":{
"shape":"String",
"documentation":"<p> The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to <code>false</code>. </p> <note> <p>Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.</p> </note> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters or numbers.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> <li> <p>Cannot be specified when deleting a Read Replica.</p> </li> </ul>"
}
},
"documentation":"<p/>"
},
"DeleteDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"DeleteDBParameterGroupMessage":{
"type":"structure",
"required":["DBParameterGroupName"],
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing DB parameter group</p> </li> <li> <p>You can't delete a default DB parameter group</p> </li> <li> <p>Cannot be associated with any DB instances</p> </li> </ul>"
}
},
"documentation":"<p/>"
},
"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>Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
}
},
"documentation":"<p/>"
},
"DeleteEventSubscriptionMessage":{
"type":"structure",
"required":["SubscriptionName"],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"<p>The name of the event notification subscription you want to delete.</p>"
}
},
"documentation":"<p/>"
},
"DeleteEventSubscriptionResult":{
"type":"structure",
"members":{
"EventSubscription":{"shape":"EventSubscription"}
}
},
"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 supplied, must match the name of an existing DBClusterParameterGroup.</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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"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 supplied, must match the name of an existing DBClusterParameterGroup.</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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"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/>"
},
"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 in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBCluster.</p> </li> </ul>"
},
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
},
"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 have been automatically taken by Amazon Neptune for my AWS account.</p> </li> <li> <p> <code>manual</code> - Return all DB cluster snapshots that have been taken by my AWS account.</p> </li> <li> <p> <code>shared</code> - Return all manual DB cluster snapshots that have been shared to my 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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
},
"IncludeShared":{
"shape":"Boolean",
"documentation":"<p>True 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 false. The default is <code>false</code>.</p> <p>You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the <a>ModifyDBClusterSnapshotAttribute</a> API action.</p>"
},
"IncludePublic":{
"shape":"Boolean",
"documentation":"<p>True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is <code>false</code>. The default is false.</p> <p>You can share a manual DB cluster snapshot as public by using the <a>ModifyDBClusterSnapshotAttribute</a> API action.</p>"
}
},
"documentation":"<p/>"
},
"DescribeDBClustersMessage":{
"type":"structure",
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DBClusterIdentifier.</p> </li> </ul>"
},
"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 will only include 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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous <a>DescribeDBClusters</a> 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/>"
},
"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 supplied, must match an existing DBParameterGroupFamily.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>Not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following 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>"
}
}
},
"DescribeDBInstancesMessage":{
"type":"structure",
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The user-supplied 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 supplied, must match the identifier of an existing DBInstance.</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 will only include information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that 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 <code>DescribeDBInstances</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"DescribeDBParameterGroupsMessage":{
"type":"structure",
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a specific DB parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"DescribeDBParametersMessage":{
"type":"structure",
"required":["DBParameterGroupName"],
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a specific DB parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> </ul>"
},
"Source":{
"shape":"String",
"documentation":"<p>The parameter types to return.</p> <p>Default: All parameter types returned</p> <p>Valid Values: <code>user | system | engine-default</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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeDBParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
}
},
"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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"DescribeEngineDefaultClusterParametersMessage":{
"type":"structure",
"required":["DBParameterGroupFamily"],
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group family to return 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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeEngineDefaultClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"DescribeEngineDefaultClusterParametersResult":{
"type":"structure",
"members":{
"EngineDefaults":{"shape":"EngineDefaults"}
}
},
"DescribeEngineDefaultParametersMessage":{
"type":"structure",
"required":["DBParameterGroupFamily"],
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group family.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeEngineDefaultParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"DescribeEngineDefaultParametersResult":{
"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: db-instance | db-parameter-group | db-security-group | db-snapshot</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
}
},
"documentation":"<p/>"
},
"DescribeEventSubscriptionsMessage":{
"type":"structure",
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"<p>The name of the event notification subscription you want to describe.</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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </p>"
}
},
"documentation":"<p/>"
},
"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 SourceIdentifier is supplied, SourceType must also be provided.</p> </li> <li> <p>If the source type is <code>DBInstance</code>, then a <code>DBInstanceIdentifier</code> must be supplied.</p> </li> <li> <p>If the source type is <code>DBSecurityGroup</code>, a <code>DBSecurityGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is <code>DBParameterGroup</code>, a <code>DBParameterGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is <code>DBSnapshot</code>, a <code>DBSnapshotIdentifier</code> must be supplied.</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. For more information about ISO 8601, go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <p>Example: 2009-07-08T18:00Z</p>"
},
"EndTime":{
"shape":"TStamp",
"documentation":"<p> The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href=\"http://en.wikipedia.org/wiki/ISO_8601\">ISO8601 Wikipedia page.</a> </p> <p>Example: 2009-07-08T18:00Z</p>"
},
"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 a 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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p/>"
},
"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 matching 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 matching 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 matching the specified license model.</p>"
},
"Vpc":{
"shape":"BooleanOptional",
"documentation":"<p>The 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 called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </p>"
}
},
"documentation":"<p/>"
},
"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 will only include pending maintenance actions for the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. </p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
}
},
"documentation":"<p/>"
},
"DescribeValidDBInstanceModificationsMessage":{
"type":"structure",
"required":["DBInstanceIdentifier"],
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The customer identifier or the ARN of your DB instance. </p>"
}
},
"documentation":"<p/>"
},
"DescribeValidDBInstanceModificationsResult":{
"type":"structure",
"members":{
"ValidDBInstanceModificationsMessage":{"shape":"ValidDBInstanceModificationsMessage"}
}
},
"DomainMembership":{
"type":"structure",
"members":{
"Domain":{
"shape":"String",
"documentation":"<p>The identifier of the Active Directory Domain.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).</p>"
},
"FQDN":{
"shape":"String",
"documentation":"<p>The fully qualified domain name of the Active Directory Domain.</p>"
},
"IAMRoleName":{
"shape":"String",
"documentation":"<p>The name of the IAM role to be used when making API calls to the Directory Service.</p>"
}
},
"documentation":"<p>An Active Directory Domain membership record associated with the DB instance.</p>"
},
"DomainMembershipList":{
"type":"list",
"member":{
"shape":"DomainMembership",
"locationName":"DomainMembership"
},
"documentation":"<p>List of Active Directory Domain membership records associated with a DB instance.</p>"
},
"DomainNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>Domain</i> does not refer to an existing Active Directory Domain. </p>",
"error":{
"code":"DomainNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"Double":{"type":"double"},
"DoubleOptional":{"type":"double"},
"DoubleRange":{
"type":"structure",
"members":{
"From":{
"shape":"Double",
"documentation":"<p>The minimum value in the range.</p>"
},
"To":{
"shape":"Double",
"documentation":"<p>The maximum value in the range.</p>"
}
},
"documentation":"<p>A range of double values.</p>"
},
"DoubleRangeList":{
"type":"list",
"member":{
"shape":"DoubleRange",
"locationName":"DoubleRange"
}
},
"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>This data type is used as a response element in the following actions:</p> <ul> <li> <p> <a>CreateDBInstance</a> </p> </li> <li> <p> <a>DescribeDBInstances</a> </p> </li> <li> <p> <a>DeleteDBInstance</a> </p> </li> </ul>"
},
"EngineDefaults":{
"type":"structure",
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>Specifies the name of the DB parameter group family that the engine default parameters apply to.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>Contains a list of engine default parameters.</p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeEngineDefaultParameters</a> action. </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> This data type is used as a response element in the <a>DescribeEvents</a> action. </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>Contains the results of a successful invocation of the <a>DescribeEventCategories</a> action.</p>",
"wrapper":true
},
"EventCategoriesMapList":{
"type":"list",
"member":{
"shape":"EventCategoriesMap",
"locationName":"EventCategoriesMap"
}
},
"EventCategoriesMessage":{
"type":"structure",
"members":{
"EventCategoriesMapList":{
"shape":"EventCategoriesMapList",
"documentation":"<p>A list of EventCategoriesMap data types.</p>"
}
},
"documentation":"<p>Data returned from the <b>DescribeEventCategories</b> action.</p>"
},
"EventList":{
"type":"list",
"member":{
"shape":"Event",
"locationName":"Event"
}
},
"EventSubscription":{
"type":"structure",
"members":{
"CustomerAwsId":{
"shape":"String",
"documentation":"<p>The AWS customer account associated with the event notification subscription.</p>"
},
"CustSubscriptionId":{
"shape":"String",
"documentation":"<p>The event notification subscription Id.</p>"
},
"SnsTopicArn":{
"shape":"String",
"documentation":"<p>The topic ARN of the event notification subscription.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the event notification subscription.</p> <p>Constraints:</p> <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p> <p>The status \"no-permission\" indicates that Neptune no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>"
},
"SubscriptionCreationTime":{
"shape":"String",
"documentation":"<p>The time the event notification subscription was created.</p>"
},
"SourceType":{
"shape":"String",
"documentation":"<p>The source type for the event notification subscription.</p>"
},
"SourceIdsList":{
"shape":"SourceIdsList",
"documentation":"<p>A list of source IDs for the event notification subscription.</p>"
},
"EventCategoriesList":{
"shape":"EventCategoriesList",
"documentation":"<p>A list of event categories for the event notification subscription.</p>"
},
"Enabled":{
"shape":"Boolean",
"documentation":"<p>A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.</p>"
},
"EventSubscriptionArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the event subscription.</p>"
}
},
"documentation":"<p>Contains the results of a successful invocation of the <a>DescribeEventSubscriptions</a> action.</p>",
"wrapper":true
},
"EventSubscriptionQuotaExceededFault":{
"type":"structure",
"members":{
},
"error":{
"code":"EventSubscriptionQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"EventSubscriptionsList":{
"type":"list",
"member":{
"shape":"EventSubscription",
"locationName":"EventSubscription"
}
},
"EventSubscriptionsMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
},
"EventSubscriptionsList":{
"shape":"EventSubscriptionsList",
"documentation":"<p>A list of EventSubscriptions data types.</p>"
}
},
"documentation":"<p>Data returned by the <b>DescribeEventSubscriptions</b> action.</p>"
},
"EventsMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </p>"
},
"Events":{
"shape":"EventList",
"documentation":"<p> A list of <a>Event</a> instances. </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeEvents</a> action. </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 DBCluster.</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 Read Replica in the DB cluster. For example, <code>mydbcluster-replica1</code>.</p>"
}
},
"documentation":"<p/>"
},
"FailoverDBClusterResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"Filter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"String",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"Values":{
"shape":"FilterValueList",
"documentation":"<p>This parameter is not currently supported.</p>"
}
},
"documentation":"<p>This type is not currently supported.</p>"
},
"FilterList":{
"type":"list",
"member":{
"shape":"Filter",
"locationName":"Filter"
}
},
"FilterValueList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"Value"
}
},
"InstanceQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Request would result in user exceeding 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 does not have enough capacity for the current operation.</p>",
"error":{
"code":"InsufficientDBClusterCapacityFault",
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"InsufficientDBInstanceCapacityFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Specified DB instance class is not available in the specified Availability Zone.</p>",
"error":{
"code":"InsufficientDBInstanceCapacity",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InsufficientStorageClusterCapacityFault":{
"type":"structure",
"members":{
},
"documentation":"<p>There is insufficient storage available for the current action. You may 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 supplied value is not 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 is not in a valid state.</p>",
"error":{
"code":"InvalidDBClusterStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBInstanceStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p> The specified DB instance is not 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 is in an invalid state. If you are attempting to delete the parameter group, you cannot 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 does not allow deletion.</p>",
"error":{
"code":"InvalidDBSecurityGroupState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSnapshotStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The state of the DB snapshot does not allow deletion.</p>",
"error":{
"code":"InvalidDBSnapshotState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSubnetGroupStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet group cannot be deleted because it is in use.</p>",
"error":{
"code":"InvalidDBSubnetGroupStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBSubnetStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p> The DB subnet is not in the <i>available</i> state. </p>",
"error":{
"code":"InvalidDBSubnetStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidEventSubscriptionStateFault":{
"type":"structure",
"members":{
},
"error":{
"code":"InvalidEventSubscriptionState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidRestoreFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Cannot restore from vpc backup to non-vpc DB instance.</p>",
"error":{
"code":"InvalidRestoreFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidSubnet":{
"type":"structure",
"members":{
},
"documentation":"<p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>",
"error":{
"code":"InvalidSubnet",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidVPCNetworkStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>DB subnet group does not cover all Availability Zones after it is created because users' change.</p>",
"error":{
"code":"InvalidVPCNetworkStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"KMSKeyNotAccessibleFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Error accessing 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 Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing\"> Constructing an Amazon Resource Name (ARN)</a>.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
}
},
"documentation":"<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 being modified. This parameter is not case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing DBCluster.</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 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 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 only affects the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set the <code>ApplyImmediately</code> parameter value to false, then 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 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: Value must be <code>1150-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 \"/\", \"\"\", or \"@\".</p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. </p> <p>Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.</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>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.</p> <p>Default: <code>false</code> </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 ApplyImmediately parameter is set to true.</p> <p>For a list of valid engine versions, see <a>CreateDBInstance</a>, or call <a>DescribeDBEngineVersions</a>.</p>"
}
},
"documentation":"<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/>"
},
"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, or <code>all</code> to make the manual DB cluster snapshot restorable by any AWS account. 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.</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, or <code>all</code> to remove authorization for any AWS account to copy or restore the DB cluster snapshot. 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/>"
},
"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 DBInstance.</p> </li> </ul>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p>The new amount of storage (in gibibytes) to allocate for the DB instance. </p> <p>Not applicable. Storage is managed by the DB Cluster.</p>"
},
"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>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. </p> <p>Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify <code>true</code> for the <code>ApplyImmediately</code> parameter. </p> <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p> <p>Example: <code>mySubnetGroup</code> </p>"
},
"DBSecurityGroups":{
"shape":"DBSecurityGroupNameList",
"documentation":"<p>A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match existing DBSecurityGroups.</p> </li> </ul>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.</p> <p>Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match existing VpcSecurityGroupIds.</p> </li> </ul>"
},
"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 call to <a>RebootDBInstance</a>, or the next failure reboot. </p> <p>Default: <code>false</code> </p>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".</p> <p>Not applicable. </p> <p>Default: Uses existing setting</p>"
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.</p> <p>Default: Uses existing setting</p> <p>Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.</p> <p>Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>.</p> <p>Default: Uses existing setting</p>"
},
"PreferredBackupWindow":{
"shape":"String",
"documentation":"<p> The daily time range during which automated backups are created if automated backups are enabled. </p> <p>Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the format hh24:mi-hh24:mi</p> </li> <li> <p>Must be in Universal Time Coordinated (UTC)</p> </li> <li> <p>Must not conflict with the preferred maintenance window</p> </li> <li> <p>Must be at least 30 minutes</p> </li> </ul>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"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, then changing this parameter will cause a reboot of the DB instance. If 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 pending changes are applied.</p> <p>Default: Uses existing setting</p> <p>Format: ddd:hh24:mi-ddd:hh24:mi</p> <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p> <p>Constraints: Must be at least 30 minutes</p>"
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. </p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p> The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. </p> <p>For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.</p>"
},
"AllowMajorVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.</p> <p>Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.</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 will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that 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>The new Provisioned IOPS (I/O operations per second) value for the instance. </p> <p>Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request.</p> <p>Default: Uses existing setting</p>"
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p> Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. </p> <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance</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 will occur immediately if you set <code>Apply Immediately</code> to true, or will occur during the next maintenance window if <code>Apply Immediately</code> to false. 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>"
},
"StorageType":{
"shape":"String",
"documentation":"<p>Specifies the storage type to be associated with the DB instance. </p> <p>If you specify Provisioned IOPS (<code>io1</code>), you must also include a value for the <code>Iops</code> parameter. </p> <p>If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon Neptune operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. </p> <p> Valid values: <code>standard | gp2 | io1</code> </p> <p>Default: <code>io1</code> if the <code>Iops</code> parameter is specified, otherwise <code>standard</code> </p>"
},
"TdeCredentialArn":{
"shape":"String",
"documentation":"<p>The ARN from the key store with which to associate the instance for TDE encryption.</p>"
},
"TdeCredentialPassword":{
"shape":"String",
"documentation":"<p>The password for the given ARN from the key store in order to access the device.</p>"
},
"CACertificateIdentifier":{
"shape":"String",
"documentation":"<p>Indicates the certificate that needs to be associated with the instance.</p>"
},
"Domain":{
"shape":"String",
"documentation":"<p>Not supported. </p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
"documentation":"<p>True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.</p>"
},
"MonitoringInterval":{
"shape":"IntegerOptional",
"documentation":"<p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.</p> <p>If <code>MonitoringRoleArn</code> is specified, then you must also set <code>MonitoringInterval</code> to a value other than 0.</p> <p>Valid Values: <code>0, 1, 5, 10, 15, 30, 60</code> </p>"
},
"DBPortNumber":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the database accepts connections.</p> <p>The value of the <code>DBPortNumber</code> parameter must not match any of the port values specified for options in the option group for the DB instance.</p> <p>Your database will restart when you change the <code>DBPortNumber</code> value regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p> Default: <code>8182</code> </p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>This parameter is not supported.</p>",
"deprecated":true
},
"MonitoringRoleArn":{
"shape":"String",
"documentation":"<p>The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, <code>arn:aws:iam:123456789012:role/emaccess</code>. </p> <p>If <code>MonitoringInterval</code> is set to a value other than 0, then you must supply a <code>MonitoringRoleArn</code> value.</p>"
},
"DomainIAMRoleName":{
"shape":"String",
"documentation":"<p>Not supported</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which a Read 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>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.</p> <p>You can enable IAM database authentication for the following database engines</p> <p>Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see <a>ModifyDBCluster</a>.</p> <p>Default: <code>false</code> </p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable Performance Insights for the DB instance, and otherwise false.</p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p>"
},
"CloudwatchLogsExportConfiguration":{
"shape":"CloudwatchLogsExportConfiguration",
"documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.</p>"
}
},
"documentation":"<p/>"
},
"ModifyDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"ModifyDBParameterGroupMessage":{
"type":"structure",
"required":[
"DBParameterGroupName",
"Parameters"
],
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> </ul>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.</p> <p>Valid Values (for the application method): <code>immediate | pending-reboot</code> </p> <note> <p>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.</p> </note>"
}
},
"documentation":"<p/>"
},
"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 DBSubnetGroup. 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 EC2 subnet IDs for the DB subnet group.</p>"
}
},
"documentation":"<p/>"
},
"ModifyDBSubnetGroupResult":{
"type":"structure",
"members":{
"DBSubnetGroup":{"shape":"DBSubnetGroup"}
}
},
"ModifyEventSubscriptionMessage":{
"type":"structure",
"required":["SubscriptionName"],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"<p>The name of the event notification subscription.</p>"
},
"SnsTopicArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>"
},
"SourceType":{
"shape":"String",
"documentation":"<p>The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.</p> <p>Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot</p>"
},
"EventCategories":{
"shape":"EventCategoriesList",
"documentation":"<p> A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the <b>DescribeEventCategories</b> action. </p>"
},
"Enabled":{
"shape":"BooleanOptional",
"documentation":"<p> A Boolean value; set to <b>true</b> to activate the subscription. </p>"
}
},
"documentation":"<p/>"
},
"ModifyEventSubscriptionResult":{
"type":"structure",
"members":{
"EventSubscription":{"shape":"EventSubscription"}
}
},
"OptionGroupMembership":{
"type":"structure",
"members":{
"OptionGroupName":{
"shape":"String",
"documentation":"<p>The name of the option group that the instance belongs to.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the DB instance's option group membership. Valid values are: <code>in-sync</code>, <code>pending-apply</code>, <code>pending-removal</code>, <code>pending-maintenance-apply</code>, <code>pending-maintenance-removal</code>, <code>applying</code>, <code>removing</code>, and <code>failed</code>. </p>"
}
},
"documentation":"<p>Provides information on the option groups the DB instance is a member of.</p>"
},
"OptionGroupMembershipList":{
"type":"list",
"member":{
"shape":"OptionGroupMembership",
"locationName":"OptionGroupMembership"
}
},
"OptionGroupNotFoundFault":{
"type":"structure",
"members":{
},
"error":{
"code":"OptionGroupNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"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>"
},
"MultiAZCapable":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance is Multi-AZ capable.</p>"
},
"ReadReplicaCapable":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance can have a Read Replica.</p>"
},
"Vpc":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance is in a VPC.</p>"
},
"SupportsStorageEncryption":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance supports encrypted storage.</p>"
},
"StorageType":{
"shape":"String",
"documentation":"<p>Indicates the storage type for a DB instance.</p>"
},
"SupportsIops":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance supports provisioned IOPS.</p>"
},
"SupportsEnhancedMonitoring":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.</p>"
},
"SupportsIAMDatabaseAuthentication":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance supports IAM database authentication.</p>"
},
"SupportsPerformanceInsights":{
"shape":"Boolean",
"documentation":"<p>True if a DB instance supports Performance Insights, otherwise false.</p>"
},
"MinStorageSize":{
"shape":"IntegerOptional",
"documentation":"<p>Minimum storage size for a DB instance.</p>"
},
"MaxStorageSize":{
"shape":"IntegerOptional",
"documentation":"<p>Maximum storage size for a DB instance.</p>"
},
"MinIopsPerDbInstance":{
"shape":"IntegerOptional",
"documentation":"<p>Minimum total provisioned IOPS for a DB instance.</p>"
},
"MaxIopsPerDbInstance":{
"shape":"IntegerOptional",
"documentation":"<p>Maximum total provisioned IOPS for a DB instance.</p>"
},
"MinIopsPerGib":{
"shape":"DoubleOptional",
"documentation":"<p>Minimum provisioned IOPS per GiB for a DB instance.</p>"
},
"MaxIopsPerGib":{
"shape":"DoubleOptional",
"documentation":"<p>Maximum provisioned IOPS per GiB for a DB instance.</p>"
}
},
"documentation":"<p>Contains a list of available options for a DB instance.</p> <p> This data type is used as a response element in the <a>DescribeOrderableDBInstanceOptions</a> action. </p>",
"wrapper":true
},
"OrderableDBInstanceOptionsList":{
"type":"list",
"member":{
"shape":"OrderableDBInstanceOption",
"locationName":"OrderableDBInstanceOption"
}
},
"OrderableDBInstanceOptionsMessage":{
"type":"structure",
"members":{
"OrderableDBInstanceOptions":{
"shape":"OrderableDBInstanceOptionsList",
"documentation":"<p>An <a>OrderableDBInstanceOption</a> structure containing information about orderable options for the DB instance.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code> . </p>"
}
},
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeOrderableDBInstanceOptions</a> action. </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> This data type is used as a request parameter in the <a>ModifyDBParameterGroup</a> and <a>ResetDBParameterGroup</a> actions. </p> <p>This data type is used as a response element in the <a>DescribeEngineDefaultParameters</a> and <a>DescribeDBParameters</a> actions.</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 CloudWatch Logs.</p>"
}
},
"documentation":"<p>A list of the log types whose configuration is still pending. In other words, 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. This date takes into account opt-in requests received from the <a>ApplyPendingMaintenanceAction</a> API, the <code>AutoAppliedAfterDate</code>, and the <code>ForcedApplyDate</code>. This value is blank if an opt-in request has not been received and nothing has been specified as <code>AutoAppliedAfterDate</code> or <code>ForcedApplyDate</code>.</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>A list of the pending maintenance actions for the resource.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous <code>DescribePendingMaintenanceActions</code> request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by <code>MaxRecords</code>. </p>"
}
},
"documentation":"<p>Data returned from the <b>DescribePendingMaintenanceActions</b> action.</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 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> This data type is used as a response element in the <a>ModifyDBInstance</a> action. </p>"
},
"PromoteReadReplicaDBClusterMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing DBCluster Read Replica.</p> </li> </ul> <p>Example: <code>my-cluster-replica1</code> </p>"
}
},
"documentation":"<p/>"
},
"PromoteReadReplicaDBClusterResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"ProvisionedIopsNotAvailableInAZFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Provisioned IOPS not available in the specified Availability Zone.</p>",
"error":{
"code":"ProvisionedIopsNotAvailableInAZFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"Range":{
"type":"structure",
"members":{
"From":{
"shape":"Integer",
"documentation":"<p>The minimum value in the range.</p>"
},
"To":{
"shape":"Integer",
"documentation":"<p>The maximum value in the range.</p>"
},
"Step":{
"shape":"IntegerOptional",
"documentation":"<p>The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000... </p>"
}
},
"documentation":"<p>A range of integer values.</p>"
},
"RangeList":{
"type":"list",
"member":{
"shape":"Range",
"locationName":"Range"
}
},
"ReadReplicaDBClusterIdentifierList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"ReadReplicaDBClusterIdentifier"
}
},
"ReadReplicaDBInstanceIdentifierList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"ReadReplicaDBInstanceIdentifier"
}
},
"ReadReplicaIdentifierList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"ReadReplicaIdentifier"
}
},
"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 DBInstance.</p> </li> </ul>"
},
"ForceFailover":{
"shape":"BooleanOptional",
"documentation":"<p> When <code>true</code>, the reboot is conducted through a MultiAZ failover. </p> <p>Constraint: You can't specify <code>true</code> if the instance is not configured for MultiAZ.</p>"
}
},
"documentation":"<p/>"
},
"RebootDBInstanceResult":{
"type":"structure",
"members":{
"DBInstance":{"shape":"DBInstance"}
}
},
"RemoveRoleFromDBClusterMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"RoleArn"
],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The name of the DB cluster to disassociate the IAM role from.</p>"
},
"RoleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example <code>arn:aws:iam::123456789012:role/NeptuneAccessRole</code>.</p>"
}
}
},
"RemoveSourceIdentifierFromSubscriptionMessage":{
"type":"structure",
"required":[
"SubscriptionName",
"SourceIdentifier"
],
"members":{
"SubscriptionName":{
"shape":"String",
"documentation":"<p>The name of the event notification subscription you want to remove a source identifier from.</p>"
},
"SourceIdentifier":{
"shape":"String",
"documentation":"<p> The source identifier to be removed from the subscription, such as the <b>DB instance identifier</b> for a DB instance or the name of a security group. </p>"
}
},
"documentation":"<p/>"
},
"RemoveSourceIdentifierFromSubscriptionResult":{
"type":"structure",
"members":{
"EventSubscription":{"shape":"EventSubscription"}
}
},
"RemoveTagsFromResourceMessage":{
"type":"structure",
"required":[
"ResourceName",
"TagKeys"
],
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing\"> Constructing an Amazon Resource Name (ARN)</a>.</p>"
},
"TagKeys":{
"shape":"KeyList",
"documentation":"<p>The tag key (name) of the tag to be removed.</p>"
}
},
"documentation":"<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/>"
},
"ResetDBParameterGroupMessage":{
"type":"structure",
"required":["DBParameterGroupName"],
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing DBParameterGroup.</p> </li> </ul>"
},
"ResetAllParameters":{
"shape":"Boolean",
"documentation":"<p> Specifies whether (<code>true</code>) or not (<code>false</code>) to reset all parameters in the DB parameter group to default values. </p> <p>Default: <code>true</code> </p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>To reset the entire DB parameter group, specify the <code>DBParameterGroup</code> name and <code>ResetAllParameters</code> parameters. To reset specific parameters, provide a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request.</p> <p>Valid Values (for Apply method): <code>pending-reboot</code> </p>"
}
},
"documentation":"<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 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>Describes the pending maintenance actions for a resource.</p>",
"wrapper":true
},
"RestoreDBClusterFromSnapshotMessage":{
"type":"structure",
"required":[
"DBClusterIdentifier",
"SnapshotIdentifier",
"Engine"
],
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of 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>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: Value must be <code>1150-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 supplied, must match the name of an existing DBSubnetGroup.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"DatabaseName":{
"shape":"String",
"documentation":"<p>The database name for the restored DB cluster.</p>"
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>The name of the option group to use for the restored DB cluster.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of 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 KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following will occur:</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 KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.</p> </li> <li> <p>If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is not encrypted, then the restored DB cluster is not encrypted.</p> </li> </ul>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.</p> <p>Default: <code>false</code> </p>"
}
},
"documentation":"<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>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
},
"RestoreType":{
"shape":"String",
"documentation":"<p>The type of restore to be performed. You can specify one of the following values:</p> <ul> <li> <p> <code>full-copy</code> - The new DB cluster is restored as a full copy of the source DB cluster.</p> </li> <li> <p> <code>copy-on-write</code> - The new DB cluster is restored as a clone of the source DB cluster.</p> </li> </ul> <p>Constraints: You can't specify <code>copy-on-write</code> if the engine version of the source DB cluster is earlier than 1.11.</p> <p>If you don't specify a <code>RestoreType</code> value, then the new DB cluster is restored as a full copy of the source DB cluster.</p>"
},
"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 DBCluster.</p> </li> </ul>"
},
"RestoreToTime":{
"shape":"TStamp",
"documentation":"<p>The date and time to restore the DB cluster to.</p> <p>Valid Values: Value must be 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 <code>UseLatestRestorableTime</code> parameter is not provided</p> </li> <li> <p>Cannot be specified if <code>UseLatestRestorableTime</code> parameter is true</p> </li> <li> <p>Cannot be specified if <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 <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: Value must be <code>1150-65535</code> </p> <p>Default: The same port as the original DB cluster.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The DB subnet group name to use for the new DB cluster.</p> <p>Constraints: If supplied, must match the name of an existing DBSubnetGroup.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>The name of the option group for the new DB cluster.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of VPC security groups that the new DB cluster belongs to.</p>"
},
"Tags":{"shape":"TagList"},
"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 KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.</p> <p>You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the 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 will occur:</p> <ul> <li> <p>If the DB cluster is encrypted, then the restored DB cluster is encrypted using the 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>"
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.</p> <p>Default: <code>false</code> </p>"
}
},
"documentation":"<p/>"
},
"RestoreDBClusterToPointInTimeResult":{
"type":"structure",
"members":{
"DBCluster":{"shape":"DBCluster"}
}
},
"SNSInvalidTopicFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SNSInvalidTopic",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SNSNoAuthorizationFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SNSNoAuthorization",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SNSTopicArnNotFoundFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SNSTopicArnNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"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>Request would result in user exceeding the allowed number of DB snapshots.</p>",
"error":{
"code":"SnapshotQuotaExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SourceIdsList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"SourceId"
}
},
"SourceNotFoundFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SourceNotFound",
"httpStatusCode":404,
"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>Request would result in user exceeding 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> <i>StorageType</i> specified cannot 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"},
"SubnetStatus":{
"shape":"String",
"documentation":"<p>Specifies the status of the subnet.</p>"
}
},
"documentation":"<p> This data type is used as a response element in the <a>DescribeDBSubnetGroups</a> action. </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"
}
},
"SubscriptionAlreadyExistFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SubscriptionAlreadyExist",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"SubscriptionCategoryNotFoundFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SubscriptionCategoryNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"SubscriptionNotFoundFault":{
"type":"structure",
"members":{
},
"error":{
"code":"SubscriptionNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"SupportedCharacterSetsList":{
"type":"list",
"member":{
"shape":"CharacterSet",
"locationName":"CharacterSet"
}
},
"SupportedTimezonesList":{
"type":"list",
"member":{
"shape":"Timezone",
"locationName":"Timezone"
}
},
"TStamp":{"type":"timestamp"},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"String",
"documentation":"<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
},
"Value":{
"shape":"String",
"documentation":"<p>A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only 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 Neptune resource consisting of a key-value pair.</p>"
},
"TagList":{
"type":"list",
"member":{
"shape":"Tag",
"locationName":"Tag"
},
"documentation":"<p>A list of tags. For more information, see <a href=\"http://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html\">Tagging Amazon Neptune Resources</a>. </p>"
},
"TagListMessage":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"<p>List of tags returned by the ListTagsForResource operation.</p>"
}
},
"documentation":"<p/>"
},
"Timezone":{
"type":"structure",
"members":{
"TimezoneName":{
"shape":"String",
"documentation":"<p>The name of the time zone.</p>"
}
},
"documentation":"<p>A time zone associated with a <a>DBInstance</a>. This data type is an element in the response to the <a>DescribeDBInstances</a>, and the <a>DescribeDBEngineVersions</a> actions. </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 AutoMinorVersionUpgrade set to true.</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>"
},
"ValidDBInstanceModificationsMessage":{
"type":"structure",
"members":{
"Storage":{
"shape":"ValidStorageOptionsList",
"documentation":"<p>Valid storage options for your DB instance. </p>"
}
},
"documentation":"<p>Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the <a>DescribeValidDBInstanceModifications</a> action. You can use this information when you call <a>ModifyDBInstance</a>. </p>",
"wrapper":true
},
"ValidStorageOptions":{
"type":"structure",
"members":{
"StorageType":{
"shape":"String",
"documentation":"<p>The valid storage types for your DB instance. For example, gp2, io1. </p>"
},
"StorageSize":{
"shape":"RangeList",
"documentation":"<p>The valid range of storage in gibibytes. For example, 100 to 16384. </p>"
},
"ProvisionedIops":{
"shape":"RangeList",
"documentation":"<p>The valid range of provisioned IOPS. For example, 1000-20000. </p>"
},
"IopsToStorageRatio":{
"shape":"DoubleRangeList",
"documentation":"<p>The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage. </p>"
}
},
"documentation":"<p>Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the <a>DescribeValidDBInstanceModifications</a> action. </p>"
},
"ValidStorageOptionsList":{
"type":"list",
"member":{
"shape":"ValidStorageOptions",
"locationName":"ValidStorageOptions"
}
},
"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>This data type is used as a response element for queries on VPC security group membership.</p>"
},
"VpcSecurityGroupMembershipList":{
"type":"list",
"member":{
"shape":"VpcSecurityGroupMembership",
"locationName":"VpcSecurityGroupMembership"
}
}
},
"documentation":"<fullname>Amazon Neptune</fullname> <p> </p> <p> Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security. </p> <p>This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon Neptune API Reference</b> </p>"
}

90
botocore/data/neptune/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"
}
]
}
}
}

128
botocore/data/opsworks/2013-02-18/service-2.json
View file

@ -76,7 +76,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates a clone of a specified stack. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html\">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Creates a clone of a specified stack. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html\">Clone a Stack</a>. By default, all parameters are set to the values used by the parent stack.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"CreateApp":{
"name":"CreateApp",
@ -145,7 +145,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new stack. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html\">Create a New Stack</a>.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Creates a new stack. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html\">Create a New Stack</a>.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"CreateUserProfile":{
"name":"CreateUserProfile",
@ -158,7 +158,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Creates a new user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Creates a new user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DeleteApp":{
"name":"DeleteApp",
@ -223,7 +223,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Deletes a user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DeregisterEcsCluster":{
"name":"DeregisterEcsCluster",
@ -262,7 +262,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks Stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DeregisterRdsDbInstance":{
"name":"DeregisterRdsDbInstance",
@ -316,7 +316,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Requests a description of a specified set of apps.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Requests a description of a specified set of apps.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeCommands":{
"name":"DescribeCommands",
@ -330,7 +330,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the results of specified commands.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes the results of specified commands.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeDeployments":{
"name":"DescribeDeployments",
@ -344,7 +344,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Requests a description of a specified set of deployments.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Requests a description of a specified set of deployments.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeEcsClusters":{
"name":"DescribeEcsClusters",
@ -358,7 +358,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p> <p>This call accepts only one resource-identifying parameter.</p>"
"documentation":"<p>Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the <code>MaxResults</code> and <code>NextToken</code> parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p> <p>This call accepts only one resource-identifying parameter.</p>"
},
"DescribeElasticIps":{
"name":"DescribeElasticIps",
@ -372,7 +372,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP addresses</a>.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP addresses</a>.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeElasticLoadBalancers":{
"name":"DescribeElasticLoadBalancers",
@ -386,7 +386,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a stack's Elastic Load Balancing instances.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes a stack's Elastic Load Balancing instances.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeInstances":{
"name":"DescribeInstances",
@ -400,7 +400,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Requests a description of a set of instances.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Requests a description of a set of instances.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeLayers":{
"name":"DescribeLayers",
@ -414,7 +414,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Requests a description of one or more layers in a specified stack.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Requests a description of one or more layers in a specified stack.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeLoadBasedAutoScaling":{
"name":"DescribeLoadBasedAutoScaling",
@ -428,7 +428,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes load-based auto scaling configurations for specified layers.</p> <note> <p>You must specify at least one of the parameters.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes load-based auto scaling configurations for specified layers.</p> <note> <p>You must specify at least one of the parameters.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeMyUserProfile":{
"name":"DescribeMyUserProfile",
@ -437,7 +437,7 @@
"requestUri":"/"
},
"output":{"shape":"DescribeMyUserProfileResult"},
"documentation":"<p>Describes a user's SSH information.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes a user's SSH information.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeOperatingSystems":{
"name":"DescribeOperatingSystems",
@ -474,7 +474,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describe an instance's RAID arrays.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describe an instance's RAID arrays.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeRdsDbInstances":{
"name":"DescribeRdsDbInstances",
@ -488,7 +488,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes Amazon RDS instances.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p> <p>This call accepts only one resource-identifying parameter.</p>"
"documentation":"<p>Describes Amazon RDS instances.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p> <p>This call accepts only one resource-identifying parameter.</p>"
},
"DescribeServiceErrors":{
"name":"DescribeServiceErrors",
@ -502,7 +502,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes AWS OpsWorks Stacks service errors.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p> <p>This call accepts only one resource-identifying parameter.</p>"
"documentation":"<p>Describes AWS OpsWorks Stacks service errors.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p> <p>This call accepts only one resource-identifying parameter.</p>"
},
"DescribeStackProvisioningParameters":{
"name":"DescribeStackProvisioningParameters",
@ -516,7 +516,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Requests a description of a stack's provisioning parameters.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Requests a description of a stack's provisioning parameters.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeStackSummary":{
"name":"DescribeStackSummary",
@ -530,7 +530,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as <code>running_setup</code> or <code>online</code>.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeStacks":{
"name":"DescribeStacks",
@ -544,7 +544,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Requests a description of one or more stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Requests a description of one or more stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeTimeBasedAutoScaling":{
"name":"DescribeTimeBasedAutoScaling",
@ -558,7 +558,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes time-based auto scaling configurations for specified instances.</p> <note> <p>You must specify at least one of the parameters.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes time-based auto scaling configurations for specified instances.</p> <note> <p>You must specify at least one of the parameters.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeUserProfiles":{
"name":"DescribeUserProfiles",
@ -572,7 +572,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describe specified users.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describe specified users.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeVolumes":{
"name":"DescribeVolumes",
@ -586,7 +586,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes an instance's Amazon EBS volumes.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Describes an instance's Amazon EBS volumes.</p> <note> <p>This call accepts only one resource-identifying parameter.</p> </note> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DetachElasticLoadBalancer":{
"name":"DetachElasticLoadBalancer",
@ -852,7 +852,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"UnassignVolume":{
"name":"UnassignVolume",
@ -942,7 +942,7 @@
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Updates a user's SSH public key.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Updates a user's SSH public key.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"UpdateRdsDbInstance":{
"name":"UpdateRdsDbInstance",
@ -981,7 +981,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates a specified user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>Updates a specified user profile.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"UpdateVolume":{
"name":"UpdateVolume",
@ -1173,7 +1173,7 @@
},
"LayerId":{
"shape":"String",
"documentation":"<p>The ID of the layer that the Elastic Load Balancing instance is to be attached to.</p>"
"documentation":"<p>The ID of the layer to which the Elastic Load Balancing instance is to be attached.</p>"
}
}
},
@ -1283,7 +1283,7 @@
},
"VpcId":{
"shape":"String",
"documentation":"<p>The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.</p> <ul> <li> <p>If your account supports EC2 Classic, the default value is no VPC.</p> </li> <li> <p>If your account does not support EC2 Classic, the default value is the default VPC for the specified region.</p> </li> </ul> <p>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. </p> <p>If you specify a nondefault VPC ID, note the following:</p> <ul> <li> <p>It must belong to a VPC in your account that is in the specified region.</p> </li> <li> <p>You must specify a value for <code>DefaultSubnetId</code>.</p> </li> </ul> <p>For more information on how to use AWS OpsWorks Stacks with a VPC, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html\">Running a Stack in a VPC</a>. For more information on default VPC and EC2 Classic, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a>. </p>"
"documentation":"<p>The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.</p> <ul> <li> <p>If your account supports EC2 Classic, the default value is no VPC.</p> </li> <li> <p>If your account does not support EC2 Classic, the default value is the default VPC for the specified region.</p> </li> </ul> <p>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. </p> <p>If you specify a nondefault VPC ID, note the following:</p> <ul> <li> <p>It must belong to a VPC in your account that is in the specified region.</p> </li> <li> <p>You must specify a value for <code>DefaultSubnetId</code>.</p> </li> </ul> <p>For more information about how to use AWS OpsWorks Stacks with a VPC, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html\">Running a Stack in a VPC</a>. For more information about default VPC and EC2 Classic, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a>. </p>"
},
"Attributes":{
"shape":"StackAttributes",
@ -1299,7 +1299,7 @@
},
"DefaultOs":{
"shape":"String",
"documentation":"<p>The stack's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p> <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the parent stack's operating system. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <note> <p>You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
"documentation":"<p>The stack's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p> <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the parent stack's operating system. For more information about supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <note> <p>You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
},
"HostnameTheme":{
"shape":"String",
@ -1315,7 +1315,7 @@
},
"CustomJson":{
"shape":"String",
"documentation":"<p>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information on custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a> </p>"
"documentation":"<p>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information about custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a> </p>"
},
"ConfigurationManager":{
"shape":"StackConfigurationManager",
@ -1700,7 +1700,7 @@
},
"CustomJson":{
"shape":"String",
"documentation":"<p>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information on custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</p>"
"documentation":"<p>A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information about custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</p>"
}
}
},
@ -1744,7 +1744,7 @@
},
"Os":{
"shape":"String",
"documentation":"<p>The instance's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>.</p> </li> </ul> <p>For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>For more information on how to use custom AMIs with AWS OpsWorks Stacks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p>"
"documentation":"<p>The instance's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>.</p> </li> </ul> <p>For more information about the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information about supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>For more information about how to use custom AMIs with AWS OpsWorks Stacks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p>"
},
"AmiId":{
"shape":"String",
@ -1914,11 +1914,11 @@
},
"Region":{
"shape":"String",
"documentation":"<p>The stack's AWS region, such as \"ap-south-1\". For more information about Amazon regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html\">Regions and Endpoints</a>.</p>"
"documentation":"<p>The stack's AWS region, such as <code>ap-south-1</code>. For more information about Amazon regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html\">Regions and Endpoints</a>.</p> <note> <p>In the AWS CLI, this API maps to the <code>--stack-region</code> parameter. If the <code>--stack-region</code> parameter and the AWS CLI common parameter <code>--region</code> are set to the same value, the stack uses a <i>regional</i> endpoint. If the <code>--stack-region</code> parameter is not set, but the AWS CLI <code>--region</code> parameter is, this also results in a stack with a <i>regional</i> endpoint. However, if the <code>--region</code> parameter is set to <code>us-east-1</code>, and the <code>--stack-region</code> parameter is set to one of the following, then the stack uses a legacy or <i>classic</i> region: <code>us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2</code>. In this case, the actual API endpoint of the stack is in <code>us-east-1</code>. Only the preceding regions are supported as classic regions in the <code>us-east-1</code> API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common <code>--region</code> parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.</p> </note>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.</p> <ul> <li> <p>If your account supports EC2-Classic, the default value is <code>no VPC</code>.</p> </li> <li> <p>If your account does not support EC2-Classic, the default value is the default VPC for the specified region.</p> </li> </ul> <p>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.</p> <p>If you specify a nondefault VPC ID, note the following:</p> <ul> <li> <p>It must belong to a VPC in your account that is in the specified region.</p> </li> <li> <p>You must specify a value for <code>DefaultSubnetId</code>.</p> </li> </ul> <p>For more information on how to use AWS OpsWorks Stacks with a VPC, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html\">Running a Stack in a VPC</a>. For more information on default VPC and EC2-Classic, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a>. </p>"
"documentation":"<p>The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.</p> <ul> <li> <p>If your account supports EC2-Classic, the default value is <code>no VPC</code>.</p> </li> <li> <p>If your account does not support EC2-Classic, the default value is the default VPC for the specified region.</p> </li> </ul> <p>If the VPC ID corresponds to a default VPC and you have specified either the <code>DefaultAvailabilityZone</code> or the <code>DefaultSubnetId</code> parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.</p> <p>If you specify a nondefault VPC ID, note the following:</p> <ul> <li> <p>It must belong to a VPC in your account that is in the specified region.</p> </li> <li> <p>You must specify a value for <code>DefaultSubnetId</code>.</p> </li> </ul> <p>For more information about how to use AWS OpsWorks Stacks with a VPC, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html\">Running a Stack in a VPC</a>. For more information about default VPC and EC2-Classic, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a>. </p>"
},
"Attributes":{
"shape":"StackAttributes",
@ -1934,7 +1934,7 @@
},
"DefaultOs":{
"shape":"String",
"documentation":"<p>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\"> Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the current Amazon Linux version. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
"documentation":"<p>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\"> Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the current Amazon Linux version. For more information about supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
},
"HostnameTheme":{
"shape":"String",
@ -1950,11 +1950,11 @@
},
"CustomJson":{
"shape":"String",
"documentation":"<p>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information on custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</p>"
"documentation":"<p>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information about custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</p>"
},
"ConfigurationManager":{
"shape":"StackConfigurationManager",
"documentation":"<p>The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.</p>"
"documentation":"<p>The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.</p>"
},
"ChefConfiguration":{
"shape":"ChefConfiguration",
@ -2209,7 +2209,7 @@
"members":{
"EcsClusterArn":{
"shape":"String",
"documentation":"<p>The cluster's ARN.</p>"
"documentation":"<p>The cluster's Amazon Resource Number (ARN).</p>"
}
}
},
@ -2521,7 +2521,10 @@
"DescribeOperatingSystemsResponse":{
"type":"structure",
"members":{
"OperatingSystems":{"shape":"OperatingSystems"}
"OperatingSystems":{
"shape":"OperatingSystems",
"documentation":"<p>Contains information in response to a <code>DescribeOperatingSystems</code> request.</p>"
}
},
"documentation":"<p>The response to a <code>DescribeOperatingSystems</code> request.</p>"
},
@ -2581,7 +2584,7 @@
"members":{
"StackId":{
"shape":"String",
"documentation":"<p>The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.</p>"
"documentation":"<p>The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.</p>"
},
"RdsDbInstanceArns":{
"shape":"Strings",
@ -2632,7 +2635,7 @@
"members":{
"StackId":{
"shape":"String",
"documentation":"<p>The stack ID</p>"
"documentation":"<p>The stack ID.</p>"
}
}
},
@ -3008,7 +3011,10 @@
"shape":"Architecture",
"documentation":"<p>The instance architecture: \"i386\" or \"x86_64\".</p>"
},
"Arn":{"shape":"String"},
"Arn":{
"shape":"String",
"documentation":"<p>The instance's Amazon Resource Number (ARN).</p>"
},
"AutoScalingType":{
"shape":"AutoScalingType",
"documentation":"<p>For load-based or time-based instances, the type.</p>"
@ -3237,7 +3243,10 @@
"shape":"Integer",
"documentation":"<p>The number of instances with <code>start_failed</code> status.</p>"
},
"StopFailed":{"shape":"Integer"},
"StopFailed":{
"shape":"Integer",
"documentation":"<p>The number of instances with <code>stop_failed</code> status.</p>"
},
"Stopped":{
"shape":"Integer",
"documentation":"<p>The number of instances with <code>stopped</code> status.</p>"
@ -3268,7 +3277,10 @@
"Layer":{
"type":"structure",
"members":{
"Arn":{"shape":"String"},
"Arn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Number (ARN) of a layer.</p>"
},
"StackId":{
"shape":"String",
"documentation":"<p>The layer stack ID.</p>"
@ -4013,7 +4025,7 @@
},
"Level":{
"shape":"String",
"documentation":"<p>The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.</p> <ul> <li> <p> <code>deny</code> </p> </li> <li> <p> <code>show</code> </p> </li> <li> <p> <code>deploy</code> </p> </li> <li> <p> <code>manage</code> </p> </li> <li> <p> <code>iam_only</code> </p> </li> </ul> <p>For more information on the permissions associated with these levels, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
"documentation":"<p>The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.</p> <ul> <li> <p> <code>deny</code> </p> </li> <li> <p> <code>show</code> </p> </li> <li> <p> <code>deploy</code> </p> </li> <li> <p> <code>manage</code> </p> </li> <li> <p> <code>iam_only</code> </p> </li> </ul> <p>For more information about the permissions associated with these levels, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
}
}
},
@ -4282,7 +4294,10 @@
"shape":"String",
"documentation":"<p>The instance ID.</p>"
},
"Force":{"shape":"Boolean"}
"Force":{
"shape":"Boolean",
"documentation":"<p>Specifies whether to force an instance to stop.</p>"
}
}
},
"StopStackRequest":{
@ -4462,7 +4477,7 @@
"members":{
"ElasticIp":{
"shape":"String",
"documentation":"<p>The address.</p>"
"documentation":"<p>The IP address for which you want to update the name.</p>"
},
"Name":{
"shape":"String",
@ -4496,7 +4511,7 @@
},
"Os":{
"shape":"String",
"documentation":"<p>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> </ul> <p>For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> <note> <p>You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
"documentation":"<p>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> </ul> <p>For more information about supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>. For more information about how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> <note> <p>You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
},
"AmiId":{
"shape":"String",
@ -4651,7 +4666,7 @@
},
"DefaultOs":{
"shape":"String",
"documentation":"<p>The stack's operating system, which must be set to one of the following:</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the stack's current operating system. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
"documentation":"<p>The stack's operating system, which must be set to one of the following:</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the stack's current operating system. For more information about supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
},
"HostnameTheme":{
"shape":"String",
@ -4667,11 +4682,11 @@
},
"CustomJson":{
"shape":"String",
"documentation":"<p>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information on custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</p>"
"documentation":"<p>A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:</p> <p> <code>\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"</code> </p> <p>For more information about custom JSON, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html\">Use Custom JSON to Modify the Stack Configuration Attributes</a>.</p>"
},
"ConfigurationManager":{
"shape":"StackConfigurationManager",
"documentation":"<p>The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.</p>"
"documentation":"<p>The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.</p>"
},
"ChefConfiguration":{
"shape":"ChefConfiguration",
@ -4843,13 +4858,16 @@
},
"VolumeType":{
"shape":"String",
"documentation":"<p>The volume type, standard or PIOPS.</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>.</p> <ul> <li> <p> <code>standard</code> - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.</p> </li> <li> <p> <code>io1</code> - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.</p> </li> <li> <p> <code>gp2</code> - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.</p> </li> <li> <p> <code>st1</code> - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.</p> </li> <li> <p> <code>sc1</code> - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.</p> </li> </ul>"
},
"Iops":{
"shape":"Integer",
"documentation":"<p>For PIOPS volumes, the IOPS per disk.</p>"
},
"Encrypted":{"shape":"Boolean"}
"Encrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether an Amazon EBS volume is encrypted. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a>.</p>"
}
},
"documentation":"<p>Describes an instance's Amazon EBS volume.</p>"
},
@ -4879,7 +4897,7 @@
},
"VolumeType":{
"shape":"String",
"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>.</p> <ul> <li> <p> <code>standard</code> - Magnetic</p> </li> <li> <p> <code>io1</code> - Provisioned IOPS (SSD)</p> </li> <li> <p> <code>gp2</code> - General Purpose (SSD)</p> </li> <li> <p> <code>st1</code> - Throughput Optimized hard disk drive (HDD)</p> </li> <li> <p> <code>sc1</code> - Cold HDD</p> </li> </ul>"
"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>.</p> <ul> <li> <p> <code>standard</code> - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.</p> </li> <li> <p> <code>io1</code> - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.</p> </li> <li> <p> <code>gp2</code> - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.</p> </li> <li> <p> <code>st1</code> - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.</p> </li> <li> <p> <code>sc1</code> - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.</p> </li> </ul>"
},
"Iops":{
"shape":"Integer",

38
botocore/data/organizations/2016-11-28/service-2.json
View file

File diff suppressed because one or more lines are too long

3
botocore/data/pi/2018-02-27/paginators-1.json Normal file
View file

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

401
botocore/data/pi/2018-02-27/service-2.json Normal file
View file

@ -0,0 +1,401 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-02-27",
"endpointPrefix":"pi",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"AWS PI",
"serviceFullName":"AWS Performance Insights",
"serviceId":"PI",
"signatureVersion":"v4",
"signingName":"pi",
"targetPrefix":"PerformanceInsightsv20180227",
"uid":"pi-2018-02-27"
},
"operations":{
"DescribeDimensionKeys":{
"name":"DescribeDimensionKeys",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDimensionKeysRequest"},
"output":{"shape":"DescribeDimensionKeysResponse"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"InternalServiceError"},
{"shape":"NotAuthorizedException"}
],
"documentation":"<p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.</p>"
},
"GetResourceMetrics":{
"name":"GetResourceMetrics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResourceMetricsRequest"},
"output":{"shape":"GetResourceMetricsResponse"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"InternalServiceError"},
{"shape":"NotAuthorizedException"}
],
"documentation":"<p>Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.</p>"
}
},
"shapes":{
"DataPoint":{
"type":"structure",
"required":[
"Timestamp",
"Value"
],
"members":{
"Timestamp":{
"shape":"ISOTimestamp",
"documentation":"<p>The time, in epoch format, associated with a particular <code>Value</code>.</p>"
},
"Value":{
"shape":"Double",
"documentation":"<p>The actual value associated with a particular <code>Timestamp</code>.</p>"
}
},
"documentation":"<p>A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.</p>"
},
"DataPointsList":{
"type":"list",
"member":{"shape":"DataPoint"}
},
"DescribeDimensionKeysRequest":{
"type":"structure",
"required":[
"ServiceType",
"Identifier",
"StartTime",
"EndTime",
"Metric",
"GroupBy"
],
"members":{
"ServiceType":{
"shape":"ServiceType",
"documentation":"<p>The AWS service for which Performance Insights will return metrics. The only valid value for <i>ServiceType</i> is: <code>RDS</code> </p>"
},
"Identifier":{
"shape":"String",
"documentation":"<p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</p> <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value - for example: <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code> </p>"
},
"StartTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The date and time specifying the beginning of the requested time series data. You can't specify a <code>StartTime</code> that's earlier than 7 days ago. The value specified is <i>inclusive</i> - data points equal to or greater than <code>StartTime</code> will be returned.</p> <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>"
},
"EndTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The date and time specifying the end of the requested time series data. The value specified is <i>exclusive</i> - data points less than (but not equal to) <code>EndTime</code> will be returned.</p> <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>"
},
"Metric":{
"shape":"String",
"documentation":"<p>The name of a Performance Insights metric to be measured.</p> <p>Valid values for <code>Metric</code> are:</p> <ul> <li> <p> <code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine.</p> </li> <li> <p> <code>db.sampledload.avg</code> - the raw number of active sessions for the database engine.</p> </li> </ul>"
},
"PeriodInSeconds":{
"shape":"Integer",
"documentation":"<p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p> <ul> <li> <p> <code>1</code> (one second)</p> </li> <li> <p> <code>60</code> (one minute)</p> </li> <li> <p> <code>300</code> (five minutes)</p> </li> <li> <p> <code>3600</code> (one hour)</p> </li> <li> <p> <code>86400</code> (twenty-four hours)</p> </li> </ul> <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>"
},
"GroupBy":{
"shape":"DimensionGroup",
"documentation":"<p>A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.</p>"
},
"PartitionBy":{
"shape":"DimensionGroup",
"documentation":"<p>For each dimension specified in <code>GroupBy</code>, specify a secondary dimension to further subdivide the partition keys in the response.</p>"
},
"Filter":{
"shape":"MetricQueryFilterMap",
"documentation":"<p>One or more filters to apply in the request. Restrictions:</p> <ul> <li> <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or <code>Partition</code> parameters.</p> </li> <li> <p>A single filter for any other dimension in this dimension group.</p> </li> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining results can be retrieved. </p>"
},
"NextToken":{
"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 token, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"DescribeDimensionKeysResponse":{
"type":"structure",
"members":{
"AlignedStartTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>.</p>"
},
"AlignedEndTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The end time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>.</p>"
},
"PartitionKeys":{
"shape":"ResponsePartitionKeyList",
"documentation":"<p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the specified partitions.</p>"
},
"Keys":{
"shape":"DimensionKeyDescriptionList",
"documentation":"<p>The dimension keys that were requested.</p>"
},
"NextToken":{
"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 token, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"DimensionGroup":{
"type":"structure",
"required":["Group"],
"members":{
"Group":{
"shape":"String",
"documentation":"<p>The name of the dimension group. Valid values are:</p> <ul> <li> <p> <code>db.user</code> </p> </li> <li> <p> <code>db.host</code> </p> </li> <li> <p> <code>db.sql</code> </p> </li> <li> <p> <code>db.sql_tokenized</code> </p> </li> <li> <p> <code>db.wait_event</code> </p> </li> <li> <p> <code>db.wait_event_type</code> </p> </li> </ul>"
},
"Dimensions":{
"shape":"StringList",
"documentation":"<p>A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.</p> <p>Valid values for elements in the <code>Dimensions</code> array are:</p> <ul> <li> <p>db.user.id</p> </li> <li> <p>db.user.name</p> </li> <li> <p>db.host.id</p> </li> <li> <p>db.host.name</p> </li> <li> <p>db.sql.id</p> </li> <li> <p>db.sql.db_id</p> </li> <li> <p>db.sql.statement</p> </li> <li> <p>db.sql.tokenized_id</p> </li> <li> <p>db.sql_tokenized.id</p> </li> <li> <p>db.sql_tokenized.db_id</p> </li> <li> <p>db.sql_tokenized.statement</p> </li> <li> <p>db.wait_event.name</p> </li> <li> <p>db.wait_event.type</p> </li> <li> <p>db.wait_event_type.name</p> </li> </ul>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of items to fetch for this dimension group.</p>"
}
},
"documentation":"<p>A logical grouping of Performance Insights metrics for a related subject area. For example, the <code>db.sql</code> dimension group consists of the following dimensions: <code>db.sql.id</code>, <code>db.sql.db_id</code>, <code>db.sql.statement</code>, and <code>db.sql.tokenized_id</code>.</p>"
},
"DimensionKeyDescription":{
"type":"structure",
"members":{
"Dimensions":{
"shape":"DimensionMap",
"documentation":"<p>A map of name-value pairs for the dimensions in the group.</p>"
},
"Total":{
"shape":"Double",
"documentation":"<p>The aggregated metric value for the dimension(s), over the requested time range.</p>"
},
"Partitions":{
"shape":"MetricValuesList",
"documentation":"<p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>"
}
},
"documentation":"<p>An array of descriptions and aggregated values for each dimension within a dimension group.</p>"
},
"DimensionKeyDescriptionList":{
"type":"list",
"member":{"shape":"DimensionKeyDescription"}
},
"DimensionMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"Double":{"type":"double"},
"GetResourceMetricsRequest":{
"type":"structure",
"required":[
"ServiceType",
"Identifier",
"MetricQueries",
"StartTime",
"EndTime"
],
"members":{
"ServiceType":{
"shape":"ServiceType",
"documentation":"<p>The AWS service for which Performance Insights will return metrics. The only valid value for <i>ServiceType</i> is: <code>RDS</code> </p>"
},
"Identifier":{
"shape":"String",
"documentation":"<p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</p> <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value - for example: <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code> </p>"
},
"MetricQueries":{
"shape":"MetricQueryList",
"documentation":"<p>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.</p>"
},
"StartTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The date and time specifying the beginning of the requested time series data. You can't specify a <code>StartTime</code> that's earlier than 7 days ago. The value specified is <i>inclusive</i> - data points equal to or greater than <code>StartTime</code> will be returned.</p> <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>"
},
"EndTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The date and time specifiying the end of the requested time series data. The value specified is <i>exclusive</i> - data points less than (but not equal to) <code>EndTime</code> will be returned.</p> <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>"
},
"PeriodInSeconds":{
"shape":"Integer",
"documentation":"<p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p> <ul> <li> <p> <code>1</code> (one second)</p> </li> <li> <p> <code>60</code> (one minute)</p> </li> <li> <p> <code>300</code> (five minutes)</p> </li> <li> <p> <code>3600</code> (one hour)</p> </li> <li> <p> <code>86400</code> (twenty-four hours)</p> </li> </ul> <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining results can be retrieved. </p>"
},
"NextToken":{
"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 token, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"GetResourceMetricsResponse":{
"type":"structure",
"members":{
"AlignedStartTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The start time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>.</p>"
},
"AlignedEndTime":{
"shape":"ISOTimestamp",
"documentation":"<p>The end time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>.</p>"
},
"Identifier":{
"shape":"String",
"documentation":"<p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.</p> <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value - for example: <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code> </p>"
},
"MetricList":{
"shape":"MetricKeyDataPointsList",
"documentation":"<p>An array of metric results,, where each array element contains all of the data points for a particular dimension.</p>"
},
"NextToken":{
"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 token, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"ISOTimestamp":{"type":"timestamp"},
"Integer":{"type":"integer"},
"InternalServiceError":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The request failed due to an unknown error.</p>",
"exception":true,
"fault":true
},
"InvalidArgumentException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>One of the arguments provided is invalid for this request.</p>",
"exception":true
},
"Limit":{
"type":"integer",
"max":10,
"min":1
},
"MaxResults":{
"type":"integer",
"max":20,
"min":0
},
"MetricKeyDataPoints":{
"type":"structure",
"members":{
"Key":{
"shape":"ResponseResourceMetricKey",
"documentation":"<p>The dimension(s) to which the data points apply.</p>"
},
"DataPoints":{
"shape":"DataPointsList",
"documentation":"<p>An array of timestamp-value pairs, representing measurements over a period of time.</p>"
}
},
"documentation":"<p>A time-ordered series of data points, correpsonding to a dimension of a Performance Insights metric.</p>"
},
"MetricKeyDataPointsList":{
"type":"list",
"member":{"shape":"MetricKeyDataPoints"}
},
"MetricQuery":{
"type":"structure",
"required":["Metric"],
"members":{
"Metric":{
"shape":"String",
"documentation":"<p>The name of a Performance Insights metric to be measured.</p> <p>Valid values for <code>Metric</code> are:</p> <ul> <li> <p> <code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine.</p> </li> <li> <p> <code>db.sampledload.avg</code> - the raw number of active sessions for the database engine.</p> </li> </ul>"
},
"GroupBy":{
"shape":"DimensionGroup",
"documentation":"<p>A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.</p>"
},
"Filter":{
"shape":"MetricQueryFilterMap",
"documentation":"<p>One or more filters to apply in the request. Restrictions:</p> <ul> <li> <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> parameter.</p> </li> <li> <p>A single filter for any other dimension in this dimension group.</p> </li> </ul>"
}
},
"documentation":"<p>A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( <code>GroupBy</code>), and return only those data points that match your criteria (<code>Filter</code>).</p>"
},
"MetricQueryFilterMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"MetricQueryList":{
"type":"list",
"member":{"shape":"MetricQuery"},
"max":15,
"min":1
},
"MetricValuesList":{
"type":"list",
"member":{"shape":"Double"}
},
"NotAuthorizedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The user is not authorized to perform this request.</p>",
"exception":true
},
"ResponsePartitionKey":{
"type":"structure",
"required":["Dimensions"],
"members":{
"Dimensions":{
"shape":"DimensionMap",
"documentation":"<p>A dimension map that contains the dimension(s) for this partition.</p>"
}
},
"documentation":"<p>If <code>PartitionBy</code> was specified in a <code>DescribeDimensionKeys</code> request, the dimensions are returned in an array. Each element in the array specifies one dimension. </p>"
},
"ResponsePartitionKeyList":{
"type":"list",
"member":{"shape":"ResponsePartitionKey"}
},
"ResponseResourceMetricKey":{
"type":"structure",
"required":["Metric"],
"members":{
"Metric":{
"shape":"String",
"documentation":"<p>The name of a Performance Insights metric to be measured.</p> <p>Valid values for <code>Metric</code> are:</p> <ul> <li> <p> <code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine.</p> </li> <li> <p> <code>db.sampledload.avg</code> - the raw number of active sessions for the database engine.</p> </li> </ul>"
},
"Dimensions":{
"shape":"DimensionMap",
"documentation":"<p>The valid dimensions for the metric.</p>"
}
},
"documentation":"<p>An object describing a Performance Insights metric and one or more dimensions for that metric.</p>"
},
"ServiceType":{
"type":"string",
"enum":["RDS"]
},
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"},
"max":10,
"min":1
}
},
"documentation":"<p>AWS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running RDS instance. The guide provides detailed information about Performance Insights data types, parameters and errors. For more information about Performance Insights capabilities see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html\">Using Amazon RDS Performance Insights </a> in the <i>Amazon RDS User Guide</i>.</p> <p> The AWS Performance Insights API provides visibility into the performance of your RDS instance, when Performance Insights is enabled for supported engine types. While Amazon CloudWatch provides the authoritative source for AWS service vended monitoring metrics, AWS Performance Insights offers a domain-specific view of database load measured as Average Active Sessions and provided to API consumers as a 2-dimensional time-series dataset. The time dimension of the data provides DB load data for each time point in the queried time range, and each time point decomposes overall load in relation to the requested dimensions, such as SQL, Wait-event, User or Host, measured at that time point.</p>"
}

2900
botocore/data/pinpoint/2016-12-01/service-2.json
View file

@ -4,11 +4,13 @@
"endpointPrefix" : "pinpoint",
"signingName" : "mobiletargeting",
"serviceFullName" : "Amazon Pinpoint",
"serviceId" : "Pinpoint",
"protocol" : "rest-json",
"jsonVersion" : "1.1",
"uid" : "pinpoint-2016-12-01",
"signatureVersion" : "v4"
},
"documentation" : "Amazon Pinpoint",
"operations" : {
"CreateApp" : {
"name" : "CreateApp",
@ -21,20 +23,27 @@
"shape" : "CreateAppRequest"
},
"output" : {
"shape" : "CreateAppResponse"
"shape" : "CreateAppResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Creates or updates an app."
},
@ -49,20 +58,27 @@
"shape" : "CreateCampaignRequest"
},
"output" : {
"shape" : "CreateCampaignResponse"
"shape" : "CreateCampaignResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Creates or updates a campaign."
},
@ -77,20 +93,27 @@
"shape" : "CreateExportJobRequest"
},
"output" : {
"shape" : "CreateExportJobResponse"
"shape" : "CreateExportJobResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Creates an export job."
},
@ -105,20 +128,27 @@
"shape" : "CreateImportJobRequest"
},
"output" : {
"shape" : "CreateImportJobResponse"
"shape" : "CreateImportJobResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Creates or updates an import job."
},
@ -133,20 +163,27 @@
"shape" : "CreateSegmentRequest"
},
"output" : {
"shape" : "CreateSegmentResponse"
"shape" : "CreateSegmentResponse",
"documentation" : "201 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to create or update a segment."
},
@ -161,22 +198,29 @@
"shape" : "DeleteAdmChannelRequest"
},
"output" : {
"shape" : "DeleteAdmChannelResponse"
"shape" : "DeleteAdmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete an ADM channel"
"documentation" : "Delete an ADM channel."
},
"DeleteApnsChannel" : {
"name" : "DeleteApnsChannel",
@ -189,20 +233,27 @@
"shape" : "DeleteApnsChannelRequest"
},
"output" : {
"shape" : "DeleteApnsChannelResponse"
"shape" : "DeleteApnsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes the APNs channel for an app."
},
@ -217,22 +268,29 @@
"shape" : "DeleteApnsSandboxChannelRequest"
},
"output" : {
"shape" : "DeleteApnsSandboxChannelResponse"
"shape" : "DeleteApnsSandboxChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete an APNS sandbox channel"
"documentation" : "Delete an APNS sandbox channel."
},
"DeleteApnsVoipChannel" : {
"name" : "DeleteApnsVoipChannel",
@ -245,20 +303,27 @@
"shape" : "DeleteApnsVoipChannelRequest"
},
"output" : {
"shape" : "DeleteApnsVoipChannelResponse"
"shape" : "DeleteApnsVoipChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete an APNS VoIP channel"
},
@ -273,20 +338,27 @@
"shape" : "DeleteApnsVoipSandboxChannelRequest"
},
"output" : {
"shape" : "DeleteApnsVoipSandboxChannelResponse"
"shape" : "DeleteApnsVoipSandboxChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete an APNS VoIP sandbox channel"
},
@ -301,20 +373,27 @@
"shape" : "DeleteAppRequest"
},
"output" : {
"shape" : "DeleteAppResponse"
"shape" : "DeleteAppResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes an app."
},
@ -329,20 +408,27 @@
"shape" : "DeleteBaiduChannelRequest"
},
"output" : {
"shape" : "DeleteBaiduChannelResponse"
"shape" : "DeleteBaiduChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete a BAIDU GCM channel"
},
@ -357,20 +443,27 @@
"shape" : "DeleteCampaignRequest"
},
"output" : {
"shape" : "DeleteCampaignResponse"
"shape" : "DeleteCampaignResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes a campaign."
},
@ -385,22 +478,29 @@
"shape" : "DeleteEmailChannelRequest"
},
"output" : {
"shape" : "DeleteEmailChannelResponse"
"shape" : "DeleteEmailChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete an email channel"
"documentation" : "Delete an email channel."
},
"DeleteEndpoint" : {
"name" : "DeleteEndpoint",
@ -448,20 +548,27 @@
"shape" : "DeleteEventStreamRequest"
},
"output" : {
"shape" : "DeleteEventStreamResponse"
"shape" : "DeleteEventStreamResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes the event stream for an app."
},
@ -476,20 +583,27 @@
"shape" : "DeleteGcmChannelRequest"
},
"output" : {
"shape" : "DeleteGcmChannelResponse"
"shape" : "DeleteGcmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes the GCM channel for an app."
},
@ -504,20 +618,27 @@
"shape" : "DeleteSegmentRequest"
},
"output" : {
"shape" : "DeleteSegmentResponse"
"shape" : "DeleteSegmentResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes a segment."
},
@ -532,22 +653,64 @@
"shape" : "DeleteSmsChannelRequest"
},
"output" : {
"shape" : "DeleteSmsChannelResponse"
"shape" : "DeleteSmsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Delete an SMS channel"
"documentation" : "Delete an SMS channel."
},
"DeleteUserEndpoints" : {
"name" : "DeleteUserEndpoints",
"http" : {
"method" : "DELETE",
"requestUri" : "/v1/apps/{application-id}/users/{user-id}",
"responseCode" : 202
},
"input" : {
"shape" : "DeleteUserEndpointsRequest"
},
"output" : {
"shape" : "DeleteUserEndpointsResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes endpoints associated with an user id."
},
"GetAdmChannel" : {
"name" : "GetAdmChannel",
@ -560,22 +723,29 @@
"shape" : "GetAdmChannelRequest"
},
"output" : {
"shape" : "GetAdmChannelResponse"
"shape" : "GetAdmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get an ADM channel"
"documentation" : "Get an ADM channel."
},
"GetApnsChannel" : {
"name" : "GetApnsChannel",
@ -588,20 +758,27 @@
"shape" : "GetApnsChannelRequest"
},
"output" : {
"shape" : "GetApnsChannelResponse"
"shape" : "GetApnsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the APNs channel for an app."
},
@ -616,22 +793,29 @@
"shape" : "GetApnsSandboxChannelRequest"
},
"output" : {
"shape" : "GetApnsSandboxChannelResponse"
"shape" : "GetApnsSandboxChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get an APNS sandbox channel"
"documentation" : "Get an APNS sandbox channel."
},
"GetApnsVoipChannel" : {
"name" : "GetApnsVoipChannel",
@ -644,20 +828,27 @@
"shape" : "GetApnsVoipChannelRequest"
},
"output" : {
"shape" : "GetApnsVoipChannelResponse"
"shape" : "GetApnsVoipChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get an APNS VoIP channel"
},
@ -672,20 +863,27 @@
"shape" : "GetApnsVoipSandboxChannelRequest"
},
"output" : {
"shape" : "GetApnsVoipSandboxChannelResponse"
"shape" : "GetApnsVoipSandboxChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get an APNS VoIPSandbox channel"
},
@ -700,20 +898,27 @@
"shape" : "GetAppRequest"
},
"output" : {
"shape" : "GetAppResponse"
"shape" : "GetAppResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about an app."
},
@ -728,20 +933,27 @@
"shape" : "GetApplicationSettingsRequest"
},
"output" : {
"shape" : "GetApplicationSettingsResponse"
"shape" : "GetApplicationSettingsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to request the settings for an app."
},
@ -756,20 +968,27 @@
"shape" : "GetAppsRequest"
},
"output" : {
"shape" : "GetAppsResponse"
"shape" : "GetAppsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your apps."
},
@ -784,20 +1003,27 @@
"shape" : "GetBaiduChannelRequest"
},
"output" : {
"shape" : "GetBaiduChannelResponse"
"shape" : "GetBaiduChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get a BAIDU GCM channel"
},
@ -812,20 +1038,27 @@
"shape" : "GetCampaignRequest"
},
"output" : {
"shape" : "GetCampaignResponse"
"shape" : "GetCampaignResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a campaign."
},
@ -840,20 +1073,27 @@
"shape" : "GetCampaignActivitiesRequest"
},
"output" : {
"shape" : "GetCampaignActivitiesResponse"
"shape" : "GetCampaignActivitiesResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the activity performed by a campaign."
},
@ -868,20 +1108,27 @@
"shape" : "GetCampaignVersionRequest"
},
"output" : {
"shape" : "GetCampaignVersionResponse"
"shape" : "GetCampaignVersionResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a specific version of a campaign."
},
@ -896,20 +1143,27 @@
"shape" : "GetCampaignVersionsRequest"
},
"output" : {
"shape" : "GetCampaignVersionsResponse"
"shape" : "GetCampaignVersionsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your campaign versions."
},
@ -924,23 +1178,65 @@
"shape" : "GetCampaignsRequest"
},
"output" : {
"shape" : "GetCampaignsResponse"
"shape" : "GetCampaignsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your campaigns."
},
"GetChannels" : {
"name" : "GetChannels",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/channels",
"responseCode" : 200
},
"input" : {
"shape" : "GetChannelsRequest"
},
"output" : {
"shape" : "GetChannelsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get all channels."
},
"GetEmailChannel" : {
"name" : "GetEmailChannel",
"http" : {
@ -952,22 +1248,29 @@
"shape" : "GetEmailChannelRequest"
},
"output" : {
"shape" : "GetEmailChannelResponse"
"shape" : "GetEmailChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get an email channel"
"documentation" : "Get an email channel."
},
"GetEndpoint" : {
"name" : "GetEndpoint",
@ -980,20 +1283,27 @@
"shape" : "GetEndpointRequest"
},
"output" : {
"shape" : "GetEndpointResponse"
"shape" : "GetEndpointResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about an endpoint."
},
@ -1008,20 +1318,27 @@
"shape" : "GetEventStreamRequest"
},
"output" : {
"shape" : "GetEventStreamResponse"
"shape" : "GetEventStreamResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns the event stream for an app."
},
@ -1036,20 +1353,27 @@
"shape" : "GetExportJobRequest"
},
"output" : {
"shape" : "GetExportJobResponse"
"shape" : "GetExportJobResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about an export job."
},
@ -1064,20 +1388,27 @@
"shape" : "GetExportJobsRequest"
},
"output" : {
"shape" : "GetExportJobsResponse"
"shape" : "GetExportJobsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your export jobs."
},
@ -1092,20 +1423,27 @@
"shape" : "GetGcmChannelRequest"
},
"output" : {
"shape" : "GetGcmChannelResponse"
"shape" : "GetGcmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the GCM channel for an app."
},
@ -1120,20 +1458,27 @@
"shape" : "GetImportJobRequest"
},
"output" : {
"shape" : "GetImportJobResponse"
"shape" : "GetImportJobResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about an import job."
},
@ -1148,20 +1493,27 @@
"shape" : "GetImportJobsRequest"
},
"output" : {
"shape" : "GetImportJobsResponse"
"shape" : "GetImportJobsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your import jobs."
},
@ -1176,20 +1528,27 @@
"shape" : "GetSegmentRequest"
},
"output" : {
"shape" : "GetSegmentResponse"
"shape" : "GetSegmentResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a segment."
},
@ -1204,20 +1563,27 @@
"shape" : "GetSegmentExportJobsRequest"
},
"output" : {
"shape" : "GetSegmentExportJobsResponse"
"shape" : "GetSegmentExportJobsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns a list of export jobs for a specific segment."
},
@ -1232,20 +1598,27 @@
"shape" : "GetSegmentImportJobsRequest"
},
"output" : {
"shape" : "GetSegmentImportJobsResponse"
"shape" : "GetSegmentImportJobsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns a list of import jobs for a specific segment."
},
@ -1260,20 +1633,27 @@
"shape" : "GetSegmentVersionRequest"
},
"output" : {
"shape" : "GetSegmentVersionResponse"
"shape" : "GetSegmentVersionResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about a segment version."
},
@ -1288,20 +1668,27 @@
"shape" : "GetSegmentVersionsRequest"
},
"output" : {
"shape" : "GetSegmentVersionsResponse"
"shape" : "GetSegmentVersionsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about your segment versions."
},
@ -1316,20 +1703,27 @@
"shape" : "GetSegmentsRequest"
},
"output" : {
"shape" : "GetSegmentsResponse"
"shape" : "GetSegmentsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to get information about your segments."
},
@ -1344,22 +1738,99 @@
"shape" : "GetSmsChannelRequest"
},
"output" : {
"shape" : "GetSmsChannelResponse"
"shape" : "GetSmsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Get an SMS channel"
"documentation" : "Get an SMS channel."
},
"GetUserEndpoints" : {
"name" : "GetUserEndpoints",
"http" : {
"method" : "GET",
"requestUri" : "/v1/apps/{application-id}/users/{user-id}",
"responseCode" : 200
},
"input" : {
"shape" : "GetUserEndpointsRequest"
},
"output" : {
"shape" : "GetUserEndpointsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the endpoints associated with an user id."
},
"PhoneNumberValidate" : {
"name" : "PhoneNumberValidate",
"http" : {
"method" : "POST",
"requestUri" : "/v1/phone/number/validate",
"responseCode" : 200
},
"input" : {
"shape" : "PhoneNumberValidateRequest"
},
"output" : {
"shape" : "PhoneNumberValidateResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the specified phone number."
},
"PutEventStream" : {
"name" : "PutEventStream",
@ -1372,23 +1843,65 @@
"shape" : "PutEventStreamRequest"
},
"output" : {
"shape" : "PutEventStreamResponse"
"shape" : "PutEventStreamResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to create or update the event stream for an app."
},
"RemoveAttributes" : {
"name" : "RemoveAttributes",
"http" : {
"method" : "PUT",
"requestUri" : "/v1/apps/{application-id}/attributes/{attribute-type}",
"responseCode" : 200
},
"input" : {
"shape" : "RemoveAttributesRequest"
},
"output" : {
"shape" : "RemoveAttributesResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to remove the attributes for an app"
},
"SendMessages" : {
"name" : "SendMessages",
"http" : {
@ -1400,22 +1913,29 @@
"shape" : "SendMessagesRequest"
},
"output" : {
"shape" : "SendMessagesResponse"
"shape" : "SendMessagesResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Send a batch of messages"
"documentation" : "Use this resource to send a direct message, which is a one time message that you send to a limited audience without creating a campaign. \n\nYou can send the message to up to 100 recipients. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of sending a direct message.\n\nYou can send a direct message as a push notification to your mobile app or as an SMS message to SMS-enabled devices."
},
"SendUsersMessages" : {
"name" : "SendUsersMessages",
@ -1428,22 +1948,29 @@
"shape" : "SendUsersMessagesRequest"
},
"output" : {
"shape" : "SendUsersMessagesResponse"
"shape" : "SendUsersMessagesResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Send a batch of messages to users"
"documentation" : "Use this resource to message a list of users. Amazon Pinpoint sends the message to all of the endpoints that are associated with each user.\n\nA user represents an individual who is assigned a unique user ID, and this ID is assigned to one or more endpoints. For example, if an individual uses your app on multiple devices, your app could assign that person's user ID to the endpoint for each device.\n\nWith the users-messages resource, you specify the message recipients as user IDs. For each user ID, Amazon Pinpoint delivers the message to all of the user's endpoints. Within the body of your request, you can specify a default message, and you can tailor your message for different channels, including those for mobile push and SMS.\n\nWith this resource, you send a direct message, which is a one time message that you send to a limited audience without creating a campaign. You can send the message to up to 100 users per request. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of using the users-messages resource."
},
"UpdateAdmChannel" : {
"name" : "UpdateAdmChannel",
@ -1456,22 +1983,29 @@
"shape" : "UpdateAdmChannelRequest"
},
"output" : {
"shape" : "UpdateAdmChannelResponse"
"shape" : "UpdateAdmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update an ADM channel"
"documentation" : "Update an ADM channel."
},
"UpdateApnsChannel" : {
"name" : "UpdateApnsChannel",
@ -1484,20 +2018,27 @@
"shape" : "UpdateApnsChannelRequest"
},
"output" : {
"shape" : "UpdateApnsChannelResponse"
"shape" : "UpdateApnsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update the APNs channel for an app."
},
@ -1512,22 +2053,29 @@
"shape" : "UpdateApnsSandboxChannelRequest"
},
"output" : {
"shape" : "UpdateApnsSandboxChannelResponse"
"shape" : "UpdateApnsSandboxChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update an APNS sandbox channel"
"documentation" : "Update an APNS sandbox channel."
},
"UpdateApnsVoipChannel" : {
"name" : "UpdateApnsVoipChannel",
@ -1540,20 +2088,27 @@
"shape" : "UpdateApnsVoipChannelRequest"
},
"output" : {
"shape" : "UpdateApnsVoipChannelResponse"
"shape" : "UpdateApnsVoipChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update an APNS VoIP channel"
},
@ -1568,20 +2123,27 @@
"shape" : "UpdateApnsVoipSandboxChannelRequest"
},
"output" : {
"shape" : "UpdateApnsVoipSandboxChannelResponse"
"shape" : "UpdateApnsVoipSandboxChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update an APNS VoIP sandbox channel"
},
@ -1596,20 +2158,27 @@
"shape" : "UpdateApplicationSettingsRequest"
},
"output" : {
"shape" : "UpdateApplicationSettingsResponse"
"shape" : "UpdateApplicationSettingsResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Used to update the settings for an app."
},
@ -1624,20 +2193,27 @@
"shape" : "UpdateBaiduChannelRequest"
},
"output" : {
"shape" : "UpdateBaiduChannelResponse"
"shape" : "UpdateBaiduChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update a BAIDU GCM channel"
},
@ -1652,20 +2228,27 @@
"shape" : "UpdateCampaignRequest"
},
"output" : {
"shape" : "UpdateCampaignResponse"
"shape" : "UpdateCampaignResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update a campaign."
},
@ -1680,22 +2263,29 @@
"shape" : "UpdateEmailChannelRequest"
},
"output" : {
"shape" : "UpdateEmailChannelResponse"
"shape" : "UpdateEmailChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update an email channel"
"documentation" : "Update an email channel."
},
"UpdateEndpoint" : {
"name" : "UpdateEndpoint",
@ -1708,22 +2298,29 @@
"shape" : "UpdateEndpointRequest"
},
"output" : {
"shape" : "UpdateEndpointResponse"
"shape" : "UpdateEndpointResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update an endpoint."
"documentation" : "Creates or updates an endpoint."
},
"UpdateEndpointsBatch" : {
"name" : "UpdateEndpointsBatch",
@ -1736,20 +2333,27 @@
"shape" : "UpdateEndpointsBatchRequest"
},
"output" : {
"shape" : "UpdateEndpointsBatchResponse"
"shape" : "UpdateEndpointsBatchResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update a batch of endpoints."
},
@ -1764,20 +2368,27 @@
"shape" : "UpdateGcmChannelRequest"
},
"output" : {
"shape" : "UpdateGcmChannelResponse"
"shape" : "UpdateGcmChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update the GCM channel for an app."
},
@ -1792,20 +2403,27 @@
"shape" : "UpdateSegmentRequest"
},
"output" : {
"shape" : "UpdateSegmentResponse"
"shape" : "UpdateSegmentResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update a segment."
},
@ -1820,22 +2438,29 @@
"shape" : "UpdateSmsChannelRequest"
},
"output" : {
"shape" : "UpdateSmsChannelResponse"
"shape" : "UpdateSmsChannelResponse",
"documentation" : "200 response"
},
"errors" : [ {
"shape" : "BadRequestException"
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException"
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException"
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException"
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException"
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException"
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Update an SMS channel"
"documentation" : "Update an SMS channel."
}
},
"shapes" : {
@ -1855,7 +2480,8 @@
"documentation" : "If the channel is enabled for sending messages."
}
},
"documentation" : "Amazon Device Messaging channel definition."
"documentation" : "Amazon Device Messaging channel definition.",
"required" : [ ]
},
"ADMChannelResponse" : {
"type" : "structure",
@ -1874,7 +2500,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the channel is configured with ADM credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with ADM. Provide your credentials by setting the ClientId and ClientSecret attributes."
"documentation" : "Not used. Retained for backwards compatibility."
},
"Id" : {
"shape" : "__string",
@ -1901,7 +2527,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Amazon Device Messaging channel definition."
"documentation" : "Amazon Device Messaging channel definition.",
"required" : [ ]
},
"ADMMessage" : {
"type" : "structure",
@ -2009,7 +2636,8 @@
"documentation" : "The token key used for APNs Tokens."
}
},
"documentation" : "Apple Push Notification Service channel definition."
"documentation" : "Apple Push Notification Service channel definition.",
"required" : [ ]
},
"APNSChannelResponse" : {
"type" : "structure",
@ -2032,7 +2660,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the channel is configured with APNs credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with APNs. To use APNs token authentication, set the BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use certificate authentication, set the Certificate and PrivateKey attributes."
"documentation" : "Not used. Retained for backwards compatibility."
},
"HasTokenKey" : {
"shape" : "__boolean",
@ -2063,7 +2691,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Apple Distribution Push Notification Service channel definition."
"documentation" : "Apple Distribution Push Notification Service channel definition.",
"required" : [ ]
},
"APNSMessage" : {
"type" : "structure",
@ -2175,7 +2804,8 @@
"documentation" : "The token key used for APNs Tokens."
}
},
"documentation" : "Apple Development Push Notification Service channel definition."
"documentation" : "Apple Development Push Notification Service channel definition.",
"required" : [ ]
},
"APNSSandboxChannelResponse" : {
"type" : "structure",
@ -2198,7 +2828,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the channel is configured with APNs credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with APNs. To use APNs token authentication, set the BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use certificate authentication, set the Certificate and PrivateKey attributes."
"documentation" : "Not used. Retained for backwards compatibility."
},
"HasTokenKey" : {
"shape" : "__boolean",
@ -2229,7 +2859,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Apple Development Push Notification Service channel definition."
"documentation" : "Apple Development Push Notification Service channel definition.",
"required" : [ ]
},
"APNSVoipChannelRequest" : {
"type" : "structure",
@ -2267,7 +2898,8 @@
"documentation" : "The token key used for APNs Tokens."
}
},
"documentation" : "Apple VoIP Push Notification Service channel definition."
"documentation" : "Apple VoIP Push Notification Service channel definition.",
"required" : [ ]
},
"APNSVoipChannelResponse" : {
"type" : "structure",
@ -2290,7 +2922,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "If the channel is registered with a credential for authentication."
"documentation" : "Not used. Retained for backwards compatibility."
},
"HasTokenKey" : {
"shape" : "__boolean",
@ -2321,7 +2953,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Apple VoIP Push Notification Service channel definition."
"documentation" : "Apple VoIP Push Notification Service channel definition.",
"required" : [ ]
},
"APNSVoipSandboxChannelRequest" : {
"type" : "structure",
@ -2359,7 +2992,8 @@
"documentation" : "The token key used for APNs Tokens."
}
},
"documentation" : "Apple VoIP Developer Push Notification Service channel definition."
"documentation" : "Apple VoIP Developer Push Notification Service channel definition.",
"required" : [ ]
},
"APNSVoipSandboxChannelResponse" : {
"type" : "structure",
@ -2382,7 +3016,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "If the channel is registered with a credential for authentication."
"documentation" : "Not used. Retained for backwards compatibility."
},
"HasTokenKey" : {
"shape" : "__boolean",
@ -2413,7 +3047,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Apple VoIP Developer Push Notification Service channel definition."
"documentation" : "Apple VoIP Developer Push Notification Service channel definition.",
"required" : [ ]
},
"Action" : {
"type" : "string",
@ -2427,7 +3062,8 @@
"documentation" : "List of campaign activities"
}
},
"documentation" : "Activities for campaign."
"documentation" : "Activities for campaign.",
"required" : [ ]
},
"ActivityResponse" : {
"type" : "structure",
@ -2485,7 +3121,8 @@
"documentation" : "The ID of a variation of the campaign used for A/B testing."
}
},
"documentation" : "Activity definition"
"documentation" : "Activity definition",
"required" : [ ]
},
"AddressConfiguration" : {
"type" : "structure",
@ -2529,7 +3166,8 @@
"documentation" : "The display name of the application."
}
},
"documentation" : "Application Response."
"documentation" : "Application Response.",
"required" : [ ]
},
"ApplicationSettingsResource" : {
"type" : "structure",
@ -2555,7 +3193,8 @@
"documentation" : "The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own."
}
},
"documentation" : "Application settings."
"documentation" : "Application settings.",
"required" : [ ]
},
"ApplicationsResponse" : {
"type" : "structure",
@ -2583,18 +3222,38 @@
"documentation" : "The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type."
}
},
"documentation" : "Custom attibute dimension"
"documentation" : "Custom attibute dimension",
"required" : [ ]
},
"AttributeType" : {
"type" : "string",
"enum" : [ "INCLUSIVE", "EXCLUSIVE" ]
},
"AttributesResource" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The unique ID for the application."
},
"AttributeType" : {
"shape" : "__string",
"documentation" : "The attribute type for the application."
},
"Attributes" : {
"shape" : "ListOf__string",
"documentation" : "The attributes for the application."
}
},
"documentation" : "Attributes.",
"required" : [ ]
},
"BadRequestException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -2623,7 +3282,8 @@
"documentation" : "Platform credential Secret key from Baidu."
}
},
"documentation" : "Baidu Cloud Push credentials"
"documentation" : "Baidu Cloud Push credentials",
"required" : [ ]
},
"BaiduChannelResponse" : {
"type" : "structure",
@ -2646,7 +3306,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the channel is configured with Baidu Cloud Push credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with Baidu Cloud Push. Provide your credentials by setting the ApiKey and SecretKey attributes."
"documentation" : "Not used. Retained for backwards compatibility."
},
"Id" : {
"shape" : "__string",
@ -2673,7 +3333,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Baidu Cloud Messaging channel definition"
"documentation" : "Baidu Cloud Messaging channel definition",
"required" : [ ]
},
"BaiduMessage" : {
"type" : "structure",
@ -2722,6 +3383,10 @@
"shape" : "MapOfListOf__string",
"documentation" : "Default message substitutions. Can be overridden by individual address substitutions."
},
"TimeToLive" : {
"shape" : "__integer",
"documentation" : "This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)"
},
"Title" : {
"shape" : "__string",
"documentation" : "The message title that displays above the message on the user's device."
@ -2753,7 +3418,8 @@
"documentation" : "The email title (Or subject)."
}
},
"documentation" : "The email message configuration."
"documentation" : "The email message configuration.",
"required" : [ ]
},
"CampaignHook" : {
"type" : "structure",
@ -2770,7 +3436,8 @@
"shape" : "__string",
"documentation" : "Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request"
}
}
},
"documentation" : "Campaign hook information."
},
"CampaignLimits" : {
"type" : "structure",
@ -2878,7 +3545,8 @@
"documentation" : "The campaign version number."
}
},
"documentation" : "Campaign definition"
"documentation" : "Campaign definition",
"required" : [ ]
},
"CampaignSmsMessage" : {
"type" : "structure",
@ -2910,7 +3578,7 @@
},
"CampaignStatus" : {
"type" : "string",
"enum" : [ "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED" ]
"enum" : [ "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED", "DELETED" ]
},
"CampaignsResponse" : {
"type" : "structure",
@ -2924,12 +3592,66 @@
"documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response."
}
},
"documentation" : "List of available campaigns."
"documentation" : "List of available campaigns.",
"required" : [ ]
},
"ChannelResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "Application id"
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "When was this segment created"
},
"Enabled" : {
"shape" : "__boolean",
"documentation" : "If the channel is enabled for sending messages."
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "Not used. Retained for backwards compatibility."
},
"Id" : {
"shape" : "__string",
"documentation" : "Channel ID. Not used, only for backwards compatibility."
},
"IsArchived" : {
"shape" : "__boolean",
"documentation" : "Is this channel archived"
},
"LastModifiedBy" : {
"shape" : "__string",
"documentation" : "Who made the last change"
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "Last date this was updated"
},
"Version" : {
"shape" : "__integer",
"documentation" : "Version of channel"
}
},
"documentation" : "Base definition for channel response."
},
"ChannelType" : {
"type" : "string",
"enum" : [ "GCM", "APNS", "APNS_SANDBOX", "APNS_VOIP", "APNS_VOIP_SANDBOX", "ADM", "SMS", "EMAIL", "BAIDU", "CUSTOM" ]
},
"ChannelsResponse" : {
"type" : "structure",
"members" : {
"Channels" : {
"shape" : "MapOfChannelResponse",
"documentation" : "A map of channels, with the ChannelType as the key and the Channel as the value."
}
},
"documentation" : "Get channels definition",
"required" : [ ]
},
"CreateAppRequest" : {
"type" : "structure",
"members" : {
@ -2958,7 +3680,8 @@
"documentation" : "The display name of the application. Used in the Amazon Pinpoint console."
}
},
"documentation" : "Application Request."
"documentation" : "Application Request.",
"required" : [ ]
},
"CreateCampaignRequest" : {
"type" : "structure",
@ -2966,7 +3689,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"WriteCampaignRequest" : {
"shape" : "WriteCampaignRequest"
@ -2991,7 +3715,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"ExportJobRequest" : {
"shape" : "ExportJobRequest"
@ -3016,7 +3741,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"ImportJobRequest" : {
"shape" : "ImportJobRequest"
@ -3041,7 +3767,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"WriteSegmentRequest" : {
"shape" : "WriteSegmentRequest"
@ -3114,7 +3841,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3135,7 +3863,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3156,7 +3885,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3177,7 +3907,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3198,7 +3929,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3219,7 +3951,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3240,7 +3973,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3261,12 +3995,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
"locationName" : "campaign-id",
"documentation" : "The unique ID of the campaign."
}
},
"required" : [ "CampaignId", "ApplicationId" ]
@ -3287,7 +4023,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3302,31 +4039,20 @@
"required" : [ "EmailChannelResponse" ],
"payload" : "EmailChannelResponse"
},
"DeleteEventStreamRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "ApplicationId"
}
},
"required" : [ "ApplicationId" ],
"documentation" : "DeleteEventStream Request"
},
"DeleteEndpointRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"EndpointId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "endpoint-id"
"locationName" : "endpoint-id",
"documentation" : "The unique ID of the endpoint."
}
},
"required" : [ "ApplicationId", "EndpointId" ]
@ -3341,6 +4067,18 @@
"required" : [ "EndpointResponse" ],
"payload" : "EndpointResponse"
},
"DeleteEventStreamRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
},
"DeleteEventStreamResponse" : {
"type" : "structure",
"members" : {
@ -3357,7 +4095,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3378,12 +4117,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
}
},
"required" : [ "SegmentId", "ApplicationId" ]
@ -3404,7 +4145,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -3419,6 +4161,34 @@
"required" : [ "SMSChannelResponse" ],
"payload" : "SMSChannelResponse"
},
"DeleteUserEndpointsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"UserId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "user-id",
"documentation" : "The unique ID of the user."
}
},
"required" : [ "ApplicationId", "UserId" ]
},
"DeleteUserEndpointsResponse" : {
"type" : "structure",
"members" : {
"EndpointsResponse" : {
"shape" : "EndpointsResponse"
}
},
"required" : [ "EndpointsResponse" ],
"payload" : "EndpointsResponse"
},
"DeliveryStatus" : {
"type" : "string",
"enum" : [ "SUCCESSFUL", "THROTTLED", "TEMPORARY_FAILURE", "PERMANENT_FAILURE", "UNKNOWN_FAILURE", "OPT_OUT", "DUPLICATE" ]
@ -3459,7 +4229,8 @@
"documentation" : "The message to SMS channels. Overrides the default message."
}
},
"documentation" : "The message configuration."
"documentation" : "Message definitions for the default message and any messages that are tailored for specific channels.",
"required" : [ ]
},
"Duration" : {
"type" : "string",
@ -3485,7 +4256,8 @@
"documentation" : "The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service"
}
},
"documentation" : "Email Channel Request"
"documentation" : "Email Channel Request",
"required" : [ ]
},
"EmailChannelResponse" : {
"type" : "structure",
@ -3508,7 +4280,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "If the channel is registered with a credential for authentication."
"documentation" : "Not used. Retained for backwards compatibility."
},
"Id" : {
"shape" : "__string",
@ -3530,6 +4302,10 @@
"shape" : "__string",
"documentation" : "Last date this was updated"
},
"MessagesPerSecond" : {
"shape" : "__integer",
"documentation" : "Messages per second that can be sent"
},
"Platform" : {
"shape" : "__string",
"documentation" : "Platform type. Will be \"EMAIL\""
@ -3543,14 +4319,15 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Email Channel Response."
"documentation" : "Email Channel Response.",
"required" : [ ]
},
"EndpointBatchItem" : {
"type" : "structure",
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId)."
"documentation" : "The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +1206XXX5550100. For the email channel, use an email address."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
@ -3570,7 +4347,7 @@
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated."
"documentation" : "Unused."
},
"Id" : {
"shape" : "__string",
@ -3607,7 +4384,8 @@
"documentation" : "List of items to update. Maximum 100 items"
}
},
"documentation" : "Endpoint batch update request."
"documentation" : "Endpoint batch update request.",
"required" : [ ]
},
"EndpointDemographic" : {
"type" : "structure",
@ -3688,6 +4466,10 @@
"shape" : "DeliveryStatus",
"documentation" : "Delivery status of message."
},
"MessageId" : {
"shape" : "__string",
"documentation" : "Unique message identifier associated with the message that was sent."
},
"StatusCode" : {
"shape" : "__integer",
"documentation" : "Downstream service status code."
@ -3701,14 +4483,15 @@
"documentation" : "If token was updated as part of delivery. (This is GCM Specific)"
}
},
"documentation" : "The result from sending a message to an endpoint."
"documentation" : "The result from sending a message to an endpoint.",
"required" : [ ]
},
"EndpointRequest" : {
"type" : "structure",
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId)."
"documentation" : "The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +1206XXX5550100. For the email channel, use an email address."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
@ -3728,7 +4511,7 @@
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated."
"documentation" : "Unused."
},
"Location" : {
"shape" : "EndpointLocation",
@ -3790,7 +4573,7 @@
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated."
"documentation" : "Unused."
},
"Id" : {
"shape" : "__string",
@ -3859,6 +4642,17 @@
},
"documentation" : "Endpoint user specific custom userAttributes"
},
"EndpointsResponse" : {
"type" : "structure",
"members" : {
"Item" : {
"shape" : "ListOfEndpointResponse",
"documentation" : "The list of endpoints."
}
},
"documentation" : "List of endpoints",
"required" : [ ]
},
"EventStream" : {
"type" : "structure",
"members" : {
@ -3887,7 +4681,8 @@
"documentation" : "The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account."
}
},
"documentation" : "Model for an event publishing subscription export."
"documentation" : "Model for an event publishing subscription export.",
"required" : [ ]
},
"ExportJobRequest" : {
"type" : "structure",
@ -3898,13 +4693,19 @@
},
"S3UrlPrefix" : {
"shape" : "__string",
"documentation" : "A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files.\nThe URL should follow this format: s3://bucket-name/folder-name/\n\nAmazon Pinpoint will export endpoints to this location."
"documentation" : "A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files.\n\nThe URL should follow this format: s3://bucket-name/folder-name/\n\nAmazon Pinpoint will export endpoints to this location."
},
"SegmentId" : {
"shape" : "__string",
"documentation" : "The ID of the segment to export endpoints from. If not present all endpoints will be exported."
"documentation" : "The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application."
},
"SegmentVersion" : {
"shape" : "__integer",
"documentation" : "The version of the segment to export if specified."
}
}
},
"documentation" : "Export job request.",
"required" : [ ]
},
"ExportJobResource" : {
"type" : "structure",
@ -3915,13 +4716,19 @@
},
"S3UrlPrefix" : {
"shape" : "__string",
"documentation" : "A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files.\nThe URL should follow this format: s3://bucket-name/folder-name/\n\nAmazon Pinpoint will export endpoints to this location."
"documentation" : "A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files.\n\nThe URL should follow this format: s3://bucket-name/folder-name/\n\nAmazon Pinpoint will export endpoints to this location."
},
"SegmentId" : {
"shape" : "__string",
"documentation" : "The ID of the segment to export endpoints from. If not present, all endpoints are exported."
"documentation" : "The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application."
},
"SegmentVersion" : {
"shape" : "__integer",
"documentation" : "The version of the segment to export if specified."
}
}
},
"documentation" : "Export job resource.",
"required" : [ ]
},
"ExportJobResponse" : {
"type" : "structure",
@ -3978,7 +4785,9 @@
"shape" : "__string",
"documentation" : "The job type. Will be 'EXPORT'."
}
}
},
"documentation" : "Export job response.",
"required" : [ ]
},
"ExportJobsResponse" : {
"type" : "structure",
@ -3992,14 +4801,15 @@
"documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response."
}
},
"documentation" : "Export job list."
"documentation" : "Export job list.",
"required" : [ ]
},
"ForbiddenException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -4032,7 +4842,8 @@
"documentation" : "If the channel is enabled for sending messages."
}
},
"documentation" : "Google Cloud Messaging credentials"
"documentation" : "Google Cloud Messaging credentials",
"required" : [ ]
},
"GCMChannelResponse" : {
"type" : "structure",
@ -4055,7 +4866,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "Indicates whether the channel is configured with FCM or GCM credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with FCM or GCM. Provide your credentials by setting the ApiKey attribute."
"documentation" : "Not used. Retained for backwards compatibility."
},
"Id" : {
"shape" : "__string",
@ -4082,7 +4893,8 @@
"documentation" : "Version of channel"
}
},
"documentation" : "Google Cloud Messaging channel definition"
"documentation" : "Google Cloud Messaging channel definition",
"required" : [ ]
},
"GCMMessage" : {
"type" : "structure",
@ -4158,13 +4970,44 @@
},
"documentation" : "GCM Message."
},
"GPSCoordinates" : {
"type" : "structure",
"members" : {
"Latitude" : {
"shape" : "__double",
"documentation" : "Latitude"
},
"Longitude" : {
"shape" : "__double",
"documentation" : "Longitude"
}
},
"documentation" : "GPS coordinates",
"required" : [ ]
},
"GPSPointDimension" : {
"type" : "structure",
"members" : {
"Coordinates" : {
"shape" : "GPSCoordinates",
"documentation" : "Coordinate to measure distance from."
},
"RangeInKilometers" : {
"shape" : "__double",
"documentation" : "Range in kilometers from the coordinate."
}
},
"documentation" : "GPS point location dimension",
"required" : [ ]
},
"GetAdmChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4185,7 +5028,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4206,7 +5050,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4227,7 +5072,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4248,7 +5094,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4269,7 +5116,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4290,7 +5138,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4311,12 +5160,14 @@
"PageSize" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "page-size"
"locationName" : "page-size",
"documentation" : "The number of entries you want on each page in the response."
},
"Token" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "token"
"locationName" : "token",
"documentation" : "The NextToken string returned on a previous page that you use to get the next page of results in a paginated response."
}
}
},
@ -4336,7 +5187,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4357,12 +5209,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
"locationName" : "campaign-id",
"documentation" : "The unique ID of the campaign."
},
"PageSize" : {
"shape" : "__string",
@ -4395,12 +5249,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
"locationName" : "campaign-id",
"documentation" : "The unique ID of the campaign."
}
},
"required" : [ "CampaignId", "ApplicationId" ]
@ -4421,17 +5277,20 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
"locationName" : "campaign-id",
"documentation" : "The unique ID of the campaign."
},
"Version" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "version"
"locationName" : "version",
"documentation" : "The version of the campaign."
}
},
"required" : [ "Version", "ApplicationId", "CampaignId" ]
@ -4452,12 +5311,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
"locationName" : "campaign-id",
"documentation" : "The unique ID of the campaign."
},
"PageSize" : {
"shape" : "__string",
@ -4490,7 +5351,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4517,13 +5379,36 @@
"required" : [ "CampaignsResponse" ],
"payload" : "CampaignsResponse"
},
"GetChannelsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
},
"GetChannelsResponse" : {
"type" : "structure",
"members" : {
"ChannelsResponse" : {
"shape" : "ChannelsResponse"
}
},
"required" : [ "ChannelsResponse" ],
"payload" : "ChannelsResponse"
},
"GetEmailChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4544,12 +5429,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"EndpointId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "endpoint-id"
"locationName" : "endpoint-id",
"documentation" : "The unique ID of the endpoint."
}
},
"required" : [ "ApplicationId", "EndpointId" ]
@ -4571,11 +5458,10 @@
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "ApplicationId"
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ],
"documentation" : "GetEventStreamRequest"
"required" : [ "ApplicationId" ]
},
"GetEventStreamResponse" : {
"type" : "structure",
@ -4593,12 +5479,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"JobId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "job-id"
"locationName" : "job-id",
"documentation" : "The unique ID of the job."
}
},
"required" : [ "ApplicationId", "JobId" ]
@ -4619,7 +5507,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4652,7 +5541,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4673,12 +5563,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"JobId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "job-id"
"locationName" : "job-id",
"documentation" : "The unique ID of the job."
}
},
"required" : [ "ApplicationId", "JobId" ]
@ -4699,7 +5591,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4732,7 +5625,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4743,7 +5637,8 @@
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
},
"Token" : {
"shape" : "__string",
@ -4770,7 +5665,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4781,7 +5677,8 @@
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
},
"Token" : {
"shape" : "__string",
@ -4808,12 +5705,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
}
},
"required" : [ "SegmentId", "ApplicationId" ]
@ -4834,17 +5733,20 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
},
"Version" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "version"
"locationName" : "version",
"documentation" : "The segment version."
}
},
"required" : [ "SegmentId", "Version", "ApplicationId" ]
@ -4865,7 +5767,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4876,7 +5779,8 @@
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
},
"Token" : {
"shape" : "__string",
@ -4903,7 +5807,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"PageSize" : {
"shape" : "__string",
@ -4936,7 +5841,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId" ]
@ -4951,6 +5857,34 @@
"required" : [ "SMSChannelResponse" ],
"payload" : "SMSChannelResponse"
},
"GetUserEndpointsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"UserId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "user-id",
"documentation" : "The unique ID of the user."
}
},
"required" : [ "ApplicationId", "UserId" ]
},
"GetUserEndpointsResponse" : {
"type" : "structure",
"members" : {
"EndpointsResponse" : {
"shape" : "EndpointsResponse"
}
},
"required" : [ "EndpointsResponse" ],
"payload" : "EndpointsResponse"
},
"ImportJobRequest" : {
"type" : "structure",
"members" : {
@ -4986,7 +5920,9 @@
"shape" : "__string",
"documentation" : "A custom name for the segment created by the import job. Use if DefineSegment is true."
}
}
},
"documentation" : "Import job request.",
"required" : [ ]
},
"ImportJobResource" : {
"type" : "structure",
@ -5023,7 +5959,9 @@
"shape" : "__string",
"documentation" : "A custom name for the segment created by the import job. Use if DefineSegment is true."
}
}
},
"documentation" : "Import job resource",
"required" : [ ]
},
"ImportJobResponse" : {
"type" : "structure",
@ -5080,7 +6018,9 @@
"shape" : "__string",
"documentation" : "The job type. Will be Import."
}
}
},
"documentation" : "Import job response.",
"required" : [ ]
},
"ImportJobsResponse" : {
"type" : "structure",
@ -5094,14 +6034,19 @@
"documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response."
}
},
"documentation" : "Import job list."
"documentation" : "Import job list.",
"required" : [ ]
},
"Include" : {
"type" : "string",
"enum" : [ "ALL", "ANY", "NONE" ]
},
"InternalServerErrorException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -5118,156 +6063,6 @@
"type" : "string",
"enum" : [ "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED" ]
},
"ListOfActivityResponse" : {
"type" : "list",
"member" : {
"shape" : "ActivityResponse"
}
},
"ListOfApplicationResponse" : {
"type" : "list",
"member" : {
"shape" : "ApplicationResponse"
}
},
"ListOfCampaignResponse" : {
"type" : "list",
"member" : {
"shape" : "CampaignResponse"
}
},
"ListOfEndpointBatchItem" : {
"type" : "list",
"member" : {
"shape" : "EndpointBatchItem"
}
},
"ListOfExportJobResponse" : {
"type" : "list",
"member" : {
"shape" : "ExportJobResponse"
}
},
"ListOfImportJobResponse" : {
"type" : "list",
"member" : {
"shape" : "ImportJobResponse"
}
},
"ListOfSegmentResponse" : {
"type" : "list",
"member" : {
"shape" : "SegmentResponse"
}
},
"ListOfTreatmentResource" : {
"type" : "list",
"member" : {
"shape" : "TreatmentResource"
}
},
"ListOfWriteTreatmentResource" : {
"type" : "list",
"member" : {
"shape" : "WriteTreatmentResource"
}
},
"ListOf__string" : {
"type" : "list",
"member" : {
"shape" : "__string"
}
},
"MapOfAddressConfiguration" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "AddressConfiguration"
}
},
"MapOfAttributeDimension" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "AttributeDimension"
}
},
"MapOfEndpointMessageResult" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "EndpointMessageResult"
}
},
"MapOfEndpointSendConfiguration" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "EndpointSendConfiguration"
}
},
"MapOfListOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "ListOf__string"
}
},
"MapOfMapOfEndpointMessageResult" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "MapOfEndpointMessageResult"
}
},
"MapOfMessageResult" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "MessageResult"
}
},
"MapOf__double" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__double"
}
},
"MapOf__integer" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__integer"
}
},
"MapOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__string"
}
},
"Message" : {
"type" : "structure",
"members" : {
@ -5307,6 +6102,10 @@
"shape" : "__boolean",
"documentation" : "Indicates if the message should display on the users device.\n\nSilent pushes can be used for Remote Configuration and Phone Home use cases. "
},
"TimeToLive" : {
"shape" : "__integer",
"documentation" : "This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM"
},
"Title" : {
"shape" : "__string",
"documentation" : "The message title that displays above the message on the user's device."
@ -5315,14 +6114,16 @@
"shape" : "__string",
"documentation" : "The URL to open in the user's mobile browser. Used if the value for Action is URL."
}
}
},
"documentation" : "Message to send",
"required" : [ ]
},
"MessageBody" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -5370,7 +6171,7 @@
"members" : {
"Addresses" : {
"shape" : "MapOfAddressConfiguration",
"documentation" : "A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value."
"documentation" : "A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address."
},
"Context" : {
"shape" : "MapOf__string",
@ -5378,14 +6179,15 @@
},
"Endpoints" : {
"shape" : "MapOfEndpointSendConfiguration",
"documentation" : "A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value."
"documentation" : "A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions."
},
"MessageConfiguration" : {
"shape" : "DirectMessageConfiguration",
"documentation" : "Message configuration."
}
},
"documentation" : "Send message request."
"documentation" : "Send message request.",
"required" : [ ]
},
"MessageResponse" : {
"type" : "structure",
@ -5407,7 +6209,8 @@
"documentation" : "A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value."
}
},
"documentation" : "Send message response."
"documentation" : "Send message response.",
"required" : [ ]
},
"MessageResult" : {
"type" : "structure",
@ -5416,6 +6219,10 @@
"shape" : "DeliveryStatus",
"documentation" : "Delivery status of message."
},
"MessageId" : {
"shape" : "__string",
"documentation" : "Unique message identifier associated with the message that was sent."
},
"StatusCode" : {
"shape" : "__integer",
"documentation" : "Downstream service status code."
@ -5429,7 +6236,8 @@
"documentation" : "If token was updated as part of delivery. (This is GCM Specific)"
}
},
"documentation" : "The result from sending a message to an address."
"documentation" : "The result from sending a message to an address.",
"required" : [ ]
},
"MessageType" : {
"type" : "string",
@ -5440,7 +6248,7 @@
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -5453,6 +6261,20 @@
"httpStatusCode" : 405
}
},
"MetricDimension" : {
"type" : "structure",
"members" : {
"ComparisonOperator" : {
"shape" : "__string",
"documentation" : "GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL"
},
"Value" : {
"shape" : "__double",
"documentation" : "Value to be compared."
}
},
"documentation" : "Custom metric dimension"
},
"Mode" : {
"type" : "string",
"enum" : [ "DELIVERY", "FILTER" ]
@ -5462,7 +6284,7 @@
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -5475,6 +6297,102 @@
"httpStatusCode" : 404
}
},
"NumberValidateRequest" : {
"type" : "structure",
"members" : {
"IsoCountryCode" : {
"shape" : "__string",
"documentation" : "(Optional) The two-character ISO country code for the country where the phone number was originally registered."
},
"PhoneNumber" : {
"shape" : "__string",
"documentation" : "The phone number to get information about."
}
},
"documentation" : "Phone Number Information request."
},
"NumberValidateResponse" : {
"type" : "structure",
"members" : {
"Carrier" : {
"shape" : "__string",
"documentation" : "The carrier that the phone number is registered with."
},
"City" : {
"shape" : "__string",
"documentation" : "The city where the phone number was originally registered."
},
"CleansedPhoneNumberE164" : {
"shape" : "__string",
"documentation" : "The cleansed (standardized) phone number in E.164 format."
},
"CleansedPhoneNumberNational" : {
"shape" : "__string",
"documentation" : "The cleansed phone number in national format."
},
"Country" : {
"shape" : "__string",
"documentation" : "The country where the phone number was originally registered."
},
"CountryCodeIso2" : {
"shape" : "__string",
"documentation" : "The two-character ISO country code for the country where the phone number was originally registered."
},
"CountryCodeNumeric" : {
"shape" : "__string",
"documentation" : "The numeric country code for the country where the phone number was originally registered."
},
"County" : {
"shape" : "__string",
"documentation" : "The county where the phone number was originally registered."
},
"OriginalCountryCodeIso2" : {
"shape" : "__string",
"documentation" : "The two-character ISO country code that was included in the request body."
},
"OriginalPhoneNumber" : {
"shape" : "__string",
"documentation" : "The phone number that you included in the request body."
},
"PhoneType" : {
"shape" : "__string",
"documentation" : "A description of the phone type. Possible values include MOBILE, LANDLINE, VOIP, INVALID, and OTHER."
},
"PhoneTypeCode" : {
"shape" : "__integer",
"documentation" : "The phone type as an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), and 4 (OTHER)."
},
"Timezone" : {
"shape" : "__string",
"documentation" : "The time zone for the location where the phone number was originally registered."
},
"ZipCode" : {
"shape" : "__string",
"documentation" : "The zip code for the location where the phone number was originally registered."
}
},
"documentation" : "Phone Number Information response."
},
"PhoneNumberValidateRequest" : {
"type" : "structure",
"members" : {
"NumberValidateRequest" : {
"shape" : "NumberValidateRequest"
}
},
"required" : [ "NumberValidateRequest" ],
"payload" : "NumberValidateRequest"
},
"PhoneNumberValidateResponse" : {
"type" : "structure",
"members" : {
"NumberValidateResponse" : {
"shape" : "NumberValidateResponse"
}
},
"required" : [ "NumberValidateResponse" ],
"payload" : "NumberValidateResponse"
},
"PutEventStreamRequest" : {
"type" : "structure",
"members" : {
@ -5482,11 +6400,10 @@
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "ApplicationId"
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"WriteEventStream" : {
"shape" : "WriteEventStream",
"documentation" : "EventStream to write."
"shape" : "WriteEventStream"
}
},
"required" : [ "ApplicationId", "WriteEventStream" ],
@ -5528,12 +6445,45 @@
"documentation" : "The recency dimension type:\nACTIVE - Users who have used your app within the specified duration are included in the segment.\nINACTIVE - Users who have not used your app within the specified duration are included in the segment."
}
},
"documentation" : "Define how a segment based on recency of use."
"documentation" : "Define how a segment based on recency of use.",
"required" : [ ]
},
"RecencyType" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE" ]
},
"RemoveAttributesRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"AttributeType" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "attribute-type",
"documentation" : "Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes."
},
"UpdateAttributesRequest" : {
"shape" : "UpdateAttributesRequest"
}
},
"required" : [ "AttributeType", "ApplicationId", "UpdateAttributesRequest" ],
"payload" : "UpdateAttributesRequest"
},
"RemoveAttributesResponse" : {
"type" : "structure",
"members" : {
"AttributesResource" : {
"shape" : "AttributesResource"
}
},
"required" : [ "AttributesResource" ],
"payload" : "AttributesResource"
},
"SMSChannelRequest" : {
"type" : "structure",
"members" : {
@ -5550,7 +6500,8 @@
"documentation" : "ShortCode registered with phone provider."
}
},
"documentation" : "SMS Channel Request"
"documentation" : "SMS Channel Request",
"required" : [ ]
},
"SMSChannelResponse" : {
"type" : "structure",
@ -5569,7 +6520,7 @@
},
"HasCredential" : {
"shape" : "__boolean",
"documentation" : "If the channel is registered with a credential for authentication."
"documentation" : "Not used. Retained for backwards compatibility."
},
"Id" : {
"shape" : "__string",
@ -5591,6 +6542,10 @@
"shape" : "__string",
"documentation" : "Platform type. Will be \"SMS\""
},
"PromotionalMessagesPerSecond" : {
"shape" : "__integer",
"documentation" : "Promotional messages per second that can be sent"
},
"SenderId" : {
"shape" : "__string",
"documentation" : "Sender identifier of your messages."
@ -5599,19 +6554,28 @@
"shape" : "__string",
"documentation" : "The short code registered with the phone provider."
},
"TransactionalMessagesPerSecond" : {
"shape" : "__integer",
"documentation" : "Transactional messages per second that can be sent"
},
"Version" : {
"shape" : "__integer",
"documentation" : "Version of channel"
}
},
"documentation" : "SMS Channel Response."
"documentation" : "SMS Channel Response.",
"required" : [ ]
},
"SMSMessage" : {
"type" : "structure",
"members" : {
"Body" : {
"shape" : "__string",
"documentation" : "The message body of the notification, the email body or the text message."
"documentation" : "The body of the SMS message."
},
"Keyword" : {
"shape" : "__string",
"documentation" : "The SMS program name that you provided to AWS Support when you requested your dedicated number."
},
"MessageType" : {
"shape" : "MessageType",
@ -5660,7 +6624,8 @@
"documentation" : "The starting UTC offset for the schedule if the value for isLocalTime is true\n\nValid values: \nUTC\nUTC+01\nUTC+02\nUTC+03\nUTC+03:30\nUTC+04\nUTC+04:30\nUTC+05\nUTC+05:30\nUTC+05:45\nUTC+06\nUTC+06:30\nUTC+07\nUTC+08\nUTC+09\nUTC+09:30\nUTC+10\nUTC+10:30\nUTC+11\nUTC+12\nUTC+13\nUTC-02\nUTC-03\nUTC-04\nUTC-05\nUTC-06\nUTC-07\nUTC-08\nUTC-09\nUTC-10\nUTC-11"
}
},
"documentation" : "Shcedule that defines when a campaign is run."
"documentation" : "Shcedule that defines when a campaign is run.",
"required" : [ ]
},
"SegmentBehaviors" : {
"type" : "structure",
@ -5721,6 +6686,10 @@
"shape" : "SegmentLocation",
"documentation" : "The segment location attributes."
},
"Metrics" : {
"shape" : "MapOfMetricDimension",
"documentation" : "Custom segment metrics."
},
"UserAttributes" : {
"shape" : "MapOfAttributeDimension",
"documentation" : "Custom segment user attributes."
@ -5728,6 +6697,44 @@
},
"documentation" : "Segment dimensions"
},
"SegmentGroup" : {
"type" : "structure",
"members" : {
"Dimensions" : {
"shape" : "ListOfSegmentDimensions",
"documentation" : "List of dimensions to include or exclude."
},
"SourceSegments" : {
"shape" : "ListOfSegmentReference",
"documentation" : "Segments that define the source of this segment. Currently a maximum of 1 import segment is supported."
},
"SourceType" : {
"shape" : "SourceType",
"documentation" : "Include or exclude the source."
},
"Type" : {
"shape" : "Type",
"documentation" : "How should the dimensions be applied for the result"
}
},
"documentation" : "Segment group definition.",
"required" : [ ]
},
"SegmentGroupList" : {
"type" : "structure",
"members" : {
"Groups" : {
"shape" : "ListOfSegmentGroup",
"documentation" : "List of dimension groups to evaluate."
},
"Include" : {
"shape" : "Include",
"documentation" : "How should the groups be applied for the result"
}
},
"documentation" : "Segment group definition.",
"required" : [ ]
},
"SegmentImportResource" : {
"type" : "structure",
"members" : {
@ -5756,7 +6763,8 @@
"documentation" : "The number of endpoints that were successfully imported to create this segment."
}
},
"documentation" : "Segment import definition."
"documentation" : "Segment import definition.",
"required" : [ ]
},
"SegmentLocation" : {
"type" : "structure",
@ -5764,10 +6772,28 @@
"Country" : {
"shape" : "SetDimension",
"documentation" : "The country filter according to ISO 3166-1 Alpha-2 codes."
},
"GPSPoint" : {
"shape" : "GPSPointDimension",
"documentation" : "The GPS Point dimension."
}
},
"documentation" : "Segment location dimensions"
},
"SegmentReference" : {
"type" : "structure",
"members" : {
"Id" : {
"shape" : "__string",
"documentation" : "Segment Id."
},
"Version" : {
"shape" : "__integer",
"documentation" : "If specified contains a specific version of the segment included."
}
},
"documentation" : "Segment reference."
},
"SegmentResponse" : {
"type" : "structure",
"members" : {
@ -5799,6 +6825,10 @@
"shape" : "__string",
"documentation" : "The name of segment"
},
"SegmentGroups" : {
"shape" : "SegmentGroupList",
"documentation" : "Segment definition groups. We currently only support one. If specified Dimensions must be empty."
},
"SegmentType" : {
"shape" : "SegmentType",
"documentation" : "The segment type:\nDIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource.\nIMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource."
@ -5808,7 +6838,8 @@
"documentation" : "The segment version number."
}
},
"documentation" : "Segment definition."
"documentation" : "Segment definition.",
"required" : [ ]
},
"SegmentType" : {
"type" : "string",
@ -5826,7 +6857,8 @@
"documentation" : "An identifier used to retrieve the next page of results. The token is null if no additional pages exist."
}
},
"documentation" : "Segments in your account."
"documentation" : "Segments in your account.",
"required" : [ ]
},
"SendMessagesRequest" : {
"type" : "structure",
@ -5834,7 +6866,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"MessageRequest" : {
"shape" : "MessageRequest"
@ -5858,36 +6891,38 @@
"members" : {
"Context" : {
"shape" : "MapOf__string",
"documentation" : "A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes."
"documentation" : "A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries."
},
"MessageConfiguration" : {
"shape" : "DirectMessageConfiguration",
"documentation" : "Message configuration."
"documentation" : "Message definitions for the default message and any messages that are tailored for specific channels."
},
"Users" : {
"shape" : "MapOfEndpointSendConfiguration",
"documentation" : "A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value."
"documentation" : "A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions."
}
},
"documentation" : "Send message request."
"documentation" : "Send message request.",
"required" : [ ]
},
"SendUsersMessageResponse" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "Application id of the message."
"documentation" : "The unique ID of the Amazon Pinpoint project used to send the message."
},
"RequestId" : {
"shape" : "__string",
"documentation" : "Original request Id for which this message was delivered."
"documentation" : "The unique ID assigned to the users-messages request."
},
"Result" : {
"shape" : "MapOfMapOfEndpointMessageResult",
"documentation" : "A map containing of UserId to Map of EndpointId to Endpoint Message Result."
"documentation" : "An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object."
}
},
"documentation" : "User send message response."
"documentation" : "User send message response.",
"required" : [ ]
},
"SendUsersMessagesRequest" : {
"type" : "structure",
@ -5895,7 +6930,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"SendUsersMessageRequest" : {
"shape" : "SendUsersMessageRequest"
@ -5926,14 +6962,19 @@
"documentation" : "The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type."
}
},
"documentation" : "Dimension specification of a segment."
"documentation" : "Dimension specification of a segment.",
"required" : [ ]
},
"SourceType" : {
"type" : "string",
"enum" : [ "ALL", "ANY" ]
},
"TooManyRequestsException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "The error message returned from the API."
"documentation" : "The error message that's returned from the API."
},
"RequestID" : {
"shape" : "__string",
@ -5978,7 +7019,12 @@
"documentation" : "The custom name of a variation of the campaign used for A/B testing."
}
},
"documentation" : "Treatment resource"
"documentation" : "Treatment resource",
"required" : [ ]
},
"Type" : {
"type" : "string",
"enum" : [ "ALL", "ANY", "NONE" ]
},
"UpdateAdmChannelRequest" : {
"type" : "structure",
@ -5989,7 +7035,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId", "ADMChannelRequest" ],
@ -6014,7 +7061,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId", "APNSChannelRequest" ],
@ -6039,7 +7087,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId", "APNSSandboxChannelRequest" ],
@ -6064,7 +7113,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId", "APNSVoipChannelRequest" ],
@ -6089,7 +7139,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
}
},
"required" : [ "ApplicationId", "APNSVoipSandboxChannelRequest" ],
@ -6111,7 +7162,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"WriteApplicationSettingsRequest" : {
"shape" : "WriteApplicationSettingsRequest"
@ -6130,13 +7182,24 @@
"required" : [ "ApplicationSettingsResource" ],
"payload" : "ApplicationSettingsResource"
},
"UpdateAttributesRequest" : {
"type" : "structure",
"members" : {
"Blacklist" : {
"shape" : "ListOf__string",
"documentation" : "The GLOB wildcard for removing the attributes in the application"
}
},
"documentation" : "Update attributes request"
},
"UpdateBaiduChannelRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"BaiduChannelRequest" : {
"shape" : "BaiduChannelRequest"
@ -6161,12 +7224,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"CampaignId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "campaign-id"
"locationName" : "campaign-id",
"documentation" : "The unique ID of the campaign."
},
"WriteCampaignRequest" : {
"shape" : "WriteCampaignRequest"
@ -6191,7 +7256,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"EmailChannelRequest" : {
"shape" : "EmailChannelRequest"
@ -6216,12 +7282,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"EndpointId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "endpoint-id"
"locationName" : "endpoint-id",
"documentation" : "The unique ID of the endpoint."
},
"EndpointRequest" : {
"shape" : "EndpointRequest"
@ -6246,7 +7314,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"EndpointBatchRequest" : {
"shape" : "EndpointBatchRequest"
@ -6271,7 +7340,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"GCMChannelRequest" : {
"shape" : "GCMChannelRequest"
@ -6296,12 +7366,14 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"SegmentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "segment-id"
"locationName" : "segment-id",
"documentation" : "The unique ID of the segment."
},
"WriteSegmentRequest" : {
"shape" : "WriteSegmentRequest"
@ -6326,7 +7398,8 @@
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id"
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"SMSChannelRequest" : {
"shape" : "SMSChannelRequest"
@ -6352,6 +7425,10 @@
"shape" : "CampaignHook",
"documentation" : "Default campaign hook information."
},
"CloudWatchMetricsEnabled" : {
"shape" : "__boolean",
"documentation" : "The CloudWatchMetrics settings for the app."
},
"Limits" : {
"shape" : "CampaignLimits",
"documentation" : "The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own."
@ -6433,7 +7510,8 @@
"documentation" : "The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account."
}
},
"documentation" : "Request to save an EventStream."
"documentation" : "Request to save an EventStream.",
"required" : [ ]
},
"WriteSegmentRequest" : {
"type" : "structure",
@ -6445,9 +7523,14 @@
"Name" : {
"shape" : "__string",
"documentation" : "The name of segment"
},
"SegmentGroups" : {
"shape" : "SegmentGroupList",
"documentation" : "Segment definition groups. We currently only support one. If specified Dimensions must be empty."
}
},
"documentation" : "Segment definition."
"documentation" : "Segment definition.",
"required" : [ ]
},
"WriteTreatmentResource" : {
"type" : "structure",
@ -6473,7 +7556,8 @@
"documentation" : "The custom name of a variation of the campaign used for A/B testing."
}
},
"documentation" : "Used to create a campaign treatment."
"documentation" : "Used to create a campaign treatment.",
"required" : [ ]
},
"__boolean" : {
"type" : "boolean"
@ -6484,11 +7568,211 @@
"__integer" : {
"type" : "integer"
},
"ListOfActivityResponse" : {
"type" : "list",
"member" : {
"shape" : "ActivityResponse"
}
},
"ListOfApplicationResponse" : {
"type" : "list",
"member" : {
"shape" : "ApplicationResponse"
}
},
"ListOfCampaignResponse" : {
"type" : "list",
"member" : {
"shape" : "CampaignResponse"
}
},
"ListOfEndpointBatchItem" : {
"type" : "list",
"member" : {
"shape" : "EndpointBatchItem"
}
},
"ListOfEndpointResponse" : {
"type" : "list",
"member" : {
"shape" : "EndpointResponse"
}
},
"ListOfExportJobResponse" : {
"type" : "list",
"member" : {
"shape" : "ExportJobResponse"
}
},
"ListOfImportJobResponse" : {
"type" : "list",
"member" : {
"shape" : "ImportJobResponse"
}
},
"ListOfSegmentDimensions" : {
"type" : "list",
"member" : {
"shape" : "SegmentDimensions"
}
},
"ListOfSegmentGroup" : {
"type" : "list",
"member" : {
"shape" : "SegmentGroup"
}
},
"ListOfSegmentReference" : {
"type" : "list",
"member" : {
"shape" : "SegmentReference"
}
},
"ListOfSegmentResponse" : {
"type" : "list",
"member" : {
"shape" : "SegmentResponse"
}
},
"ListOfTreatmentResource" : {
"type" : "list",
"member" : {
"shape" : "TreatmentResource"
}
},
"ListOfWriteTreatmentResource" : {
"type" : "list",
"member" : {
"shape" : "WriteTreatmentResource"
}
},
"ListOf__string" : {
"type" : "list",
"member" : {
"shape" : "__string"
}
},
"__long" : {
"type" : "long"
},
"MapOfAddressConfiguration" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "AddressConfiguration"
}
},
"MapOfAttributeDimension" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "AttributeDimension"
}
},
"MapOfChannelResponse" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "ChannelResponse"
}
},
"MapOfEndpointMessageResult" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "EndpointMessageResult"
}
},
"MapOfEndpointSendConfiguration" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "EndpointSendConfiguration"
}
},
"MapOfMessageResult" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "MessageResult"
}
},
"MapOfMetricDimension" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "MetricDimension"
}
},
"MapOf__double" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__double"
}
},
"MapOf__integer" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__integer"
}
},
"MapOfListOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "ListOf__string"
}
},
"MapOfMapOfEndpointMessageResult" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "MapOfEndpointMessageResult"
}
},
"MapOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__string"
}
},
"__string" : {
"type" : "string"
},
"__timestamp" : {
"type" : "timestamp"
"__timestampIso8601" : {
"type" : "timestamp",
"timestampFormat" : "iso8601"
},
"__timestampUnix" : {
"type" : "timestamp",
"timestampFormat" : "unixTimestamp"
}
}
}
}

3
botocore/data/polly/2016-06-10/service-2.json
View file

@ -546,7 +546,7 @@
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The value of the \"Text\" parameter is longer than the accepted limits. The limit for input text is a maximum of 3000 characters total, of which no more than 1500 can be billed characters. SSML tags are not counted as billed characters.</p>",
"documentation":"<p>The value of the \"Text\" parameter is longer than the accepted limits. The limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. SSML tags are not counted as billed characters.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -630,6 +630,7 @@
"Penelope",
"Chantal",
"Celine",
"Lea",
"Mathieu",
"Dora",
"Karl",

1
botocore/data/pricing/2017-10-15/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"AWS Pricing",
"serviceFullName":"AWS Price List Service",
"serviceId":"Pricing",
"signatureVersion":"v4",
"signingName":"pricing",
"targetPrefix":"AWSPriceListService",

505
botocore/data/rds/2014-10-31/service-2.json
View file

File diff suppressed because one or more lines are too long

308
botocore/data/redshift/2012-12-01/service-2.json
View file

@ -11,6 +11,28 @@
"xmlNamespace":"http://redshift.amazonaws.com/doc/2012-12-01/"
},
"operations":{
"AcceptReservedNodeExchange":{
"name":"AcceptReservedNodeExchange",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AcceptReservedNodeExchangeInputMessage"},
"output":{
"shape":"AcceptReservedNodeExchangeOutputMessage",
"resultWrapper":"AcceptReservedNodeExchangeResult"
},
"errors":[
{"shape":"ReservedNodeNotFoundFault"},
{"shape":"InvalidReservedNodeStateFault"},
{"shape":"ReservedNodeAlreadyMigratedFault"},
{"shape":"ReservedNodeOfferingNotFoundFault"},
{"shape":"UnsupportedOperationFault"},
{"shape":"DependentServiceUnavailableFault"},
{"shape":"ReservedNodeAlreadyExistsFault"}
],
"documentation":"<p>Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs. </p>"
},
"AuthorizeClusterSecurityGroupIngress":{
"name":"AuthorizeClusterSecurityGroupIngress",
"http":{
@ -102,7 +124,7 @@
{"shape":"LimitExceededFault"},
{"shape":"DependentServiceRequestThrottlingFault"}
],
"documentation":"<p>Creates a new cluster.</p> <p>To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
"documentation":"<p>Creates a new cluster.</p> <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"CreateClusterParameterGroup":{
"name":"CreateClusterParameterGroup",
@ -283,7 +305,7 @@
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidTagFault"}
],
"documentation":"<p>Adds one or more tags to a specified resource.</p> <p>A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.</p> <p>If you specify a key that already exists for the resource, the value for that key will be updated with the new value.</p>"
"documentation":"<p>Adds one or more tags to a specified resource.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.</p> <p>If you specify a key that already exists for the resource, the value for that key will be updated with the new value.</p>"
},
"DeleteCluster":{
"name":"DeleteCluster",
@ -426,6 +448,22 @@
],
"documentation":"<p>Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.</p>"
},
"DescribeClusterDbRevisions":{
"name":"DescribeClusterDbRevisions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeClusterDbRevisionsMessage"},
"output":{
"shape":"ClusterDbRevisionsMessage",
"resultWrapper":"DescribeClusterDbRevisionsResult"
},
"errors":[
{"shape":"ClusterNotFoundFault"}
],
"documentation":"<p>Returns an array of <code>ClusterDbRevision</code> objects.</p>"
},
"DescribeClusterParameterGroups":{
"name":"DescribeClusterParameterGroups",
"http":{
@ -860,6 +898,27 @@
],
"documentation":"<p>Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with <code>IAM:</code> if <code>AutoCreate</code> is <code>False</code> or <code>IAMA:</code> if <code>AutoCreate</code> is <code>True</code>. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html\">Using IAM Authentication to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide.</p> <p>The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources\">Resource Policies for GetClusterCredentials</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the <code>redshift:JoinGroup</code> action with access to the listed <code>dbgroups</code>. </p> <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>, then the policy must include the <code>redshift:CreateClusterUser</code> privilege.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource <code>dbname</code> for the specified database name. </p>"
},
"GetReservedNodeExchangeOfferings":{
"name":"GetReservedNodeExchangeOfferings",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReservedNodeExchangeOfferingsInputMessage"},
"output":{
"shape":"GetReservedNodeExchangeOfferingsOutputMessage",
"resultWrapper":"GetReservedNodeExchangeOfferingsResult"
},
"errors":[
{"shape":"ReservedNodeNotFoundFault"},
{"shape":"InvalidReservedNodeStateFault"},
{"shape":"ReservedNodeAlreadyMigratedFault"},
{"shape":"ReservedNodeOfferingNotFoundFault"},
{"shape":"UnsupportedOperationFault"},
{"shape":"DependentServiceUnavailableFault"}
],
"documentation":"<p>Returns an array of ReservedNodeOfferings which is filtered by payment type, term, and instance type.</p>"
},
"ModifyCluster":{
"name":"ModifyCluster",
"http":{
@ -887,10 +946,29 @@
{"shape":"ClusterAlreadyExistsFault"},
{"shape":"LimitExceededFault"},
{"shape":"DependentServiceRequestThrottlingFault"},
{"shape":"InvalidElasticIpFault"}
{"shape":"InvalidElasticIpFault"},
{"shape":"TableLimitExceededFault"}
],
"documentation":"<p>Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p>"
},
"ModifyClusterDbRevision":{
"name":"ModifyClusterDbRevision",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyClusterDbRevisionMessage"},
"output":{
"shape":"ModifyClusterDbRevisionResult",
"resultWrapper":"ModifyClusterDbRevisionResult"
},
"errors":[
{"shape":"ClusterNotFoundFault"},
{"shape":"ClusterOnLatestRevisionFault"},
{"shape":"InvalidClusterStateFault"}
],
"documentation":"<p>Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.</p>"
},
"ModifyClusterIamRoles":{
"name":"ModifyClusterIamRoles",
"http":{
@ -1156,6 +1234,29 @@
}
},
"shapes":{
"AcceptReservedNodeExchangeInputMessage":{
"type":"structure",
"required":[
"ReservedNodeId",
"TargetReservedNodeOfferingId"
],
"members":{
"ReservedNodeId":{
"shape":"String",
"documentation":"<p>A string representing the identifier of the Reserved Node to be exchanged.</p>"
},
"TargetReservedNodeOfferingId":{
"shape":"String",
"documentation":"<p>The unique identifier of the Reserved Node offering to be used for the exchange.</p>"
}
}
},
"AcceptReservedNodeExchangeOutputMessage":{
"type":"structure",
"members":{
"ExchangedReservedNode":{"shape":"ReservedNode"}
}
},
"AccessToSnapshotDeniedFault":{
"type":"structure",
"members":{
@ -1449,6 +1550,10 @@
"IamRoles":{
"shape":"ClusterIamRoleList",
"documentation":"<p>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.</p>"
},
"PendingActions":{
"shape":"PendingActionsList",
"documentation":"<p>Cluster operations that are waiting to be started.</p>"
}
},
"documentation":"<p>Describes a cluster.</p>",
@ -1484,6 +1589,48 @@
},
"documentation":"<p>Temporary credentials with authorization to log on to an Amazon Redshift database. </p>"
},
"ClusterDbRevision":{
"type":"structure",
"members":{
"ClusterIdentifier":{
"shape":"String",
"documentation":"<p>The unique identifier of the cluster.</p>"
},
"CurrentDatabaseRevision":{
"shape":"String",
"documentation":"<p>A string representing the current cluster version.</p>"
},
"DatabaseRevisionReleaseDate":{
"shape":"TStamp",
"documentation":"<p>The date on which the database revision was released.</p>"
},
"RevisionTargets":{
"shape":"RevisionTargetsList",
"documentation":"<p>A list of <code>RevisionTarget</code> objects, where each object describes the database revision that a cluster can be updated to.</p>"
}
},
"documentation":"<p>Describes a <code>ClusterDbRevision</code>.</p>"
},
"ClusterDbRevisionsList":{
"type":"list",
"member":{
"shape":"ClusterDbRevision",
"locationName":"ClusterDbRevision"
}
},
"ClusterDbRevisionsMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the <code>marker</code> parameter and retrying the command. If the <code>marker</code> field is empty, all revisions have already been returned.</p>"
},
"ClusterDbRevisions":{
"shape":"ClusterDbRevisionsList",
"documentation":"<p>A list of revisions.</p>"
}
}
},
"ClusterIamRole":{
"type":"structure",
"members":{
@ -1546,6 +1693,18 @@
},
"exception":true
},
"ClusterOnLatestRevisionFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Cluster is already on the latest database revision.</p>",
"error":{
"code":"ClusterOnLatestRevision",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ClusterParameterGroup":{
"type":"structure",
"members":{
@ -2664,6 +2823,23 @@
},
"exception":true
},
"DescribeClusterDbRevisionsMessage":{
"type":"structure",
"members":{
"ClusterIdentifier":{
"shape":"String",
"documentation":"<p>A unique identifier for a cluster whose <code>ClusterDbRevisions</code> you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the <code>marker</code> field of the response. You can retrieve the next set of response records by providing the returned <code>marker</code> value in the <code>marker</code> parameter and retrying the request. </p> <p>Default: 100</p> <p>Constraints: minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional parameter that specifies the starting point for returning a set of response records. When the results of a <code>DescribeClusterDbRevisions</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Redshift returns a value in the <code>marker</code> field of the response. You can retrieve the next set of response records by providing the returned <code>marker</code> value in the <code>marker</code> parameter and retrying the request. </p> <p>Constraints: You can specify either the <code>ClusterIdentifier</code> parameter, or the <code>marker</code> parameter, but not both.</p>"
}
}
},
"DescribeClusterParameterGroupsMessage":{
"type":"structure",
"members":{
@ -3551,6 +3727,38 @@
},
"documentation":"<p>The request parameters to get cluster credentials.</p>"
},
"GetReservedNodeExchangeOfferingsInputMessage":{
"type":"structure",
"required":["ReservedNodeId"],
"members":{
"ReservedNodeId":{
"shape":"String",
"documentation":"<p>A string representing the node identifier for the Reserved Node to be exchanged.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p>An integer setting the maximum number of ReservedNodeOfferings to retrieve.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>A value that indicates the starting point for the next set of ReservedNodeOfferings.</p>"
}
},
"documentation":"<p/>"
},
"GetReservedNodeExchangeOfferingsOutputMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>An optional parameter that specifies the starting point for returning a set of response records. When the results of a <code>GetReservedNodeExchangeOfferings</code> request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. </p>"
},
"ReservedNodeOfferings":{
"shape":"ReservedNodeOfferingList",
"documentation":"<p>Returns an array of <a>ReservedNodeOffering</a> objects.</p>"
}
}
},
"HsmClientCertificate":{
"type":"structure",
"members":{
@ -3931,6 +4139,18 @@
},
"exception":true
},
"InvalidReservedNodeStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Indicates that the Reserved Node being exchanged is not in an active state.</p>",
"error":{
"code":"InvalidReservedNodeState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidRestoreFault":{
"type":"structure",
"members":{
@ -4083,6 +4303,29 @@
},
"Long":{"type":"long"},
"LongOptional":{"type":"long"},
"ModifyClusterDbRevisionMessage":{
"type":"structure",
"required":[
"ClusterIdentifier",
"RevisionTarget"
],
"members":{
"ClusterIdentifier":{
"shape":"String",
"documentation":"<p>The unique identifier of a cluster whose database revision you want to modify. </p> <p>Example: <code>examplecluster</code> </p>"
},
"RevisionTarget":{
"shape":"String",
"documentation":"<p>The identifier of the database revision. You can retrieve this value from the response to the <a>DescribeClusterDbRevisions</a> request.</p>"
}
}
},
"ModifyClusterDbRevisionResult":{
"type":"structure",
"members":{
"Cluster":{"shape":"Cluster"}
}
},
"ModifyClusterIamRolesMessage":{
"type":"structure",
"required":["ClusterIdentifier"],
@ -4134,7 +4377,7 @@
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of virtual private cloud (VPC) security groups to be associated with the cluster.</p>"
"documentation":"<p>A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.</p>"
},
"MasterUserPassword":{
"shape":"String",
@ -4435,6 +4678,10 @@
"locationName":"Parameter"
}
},
"PendingActionsList":{
"type":"list",
"member":{"shape":"String"}
},
"PendingModifiedValues":{
"type":"structure",
"members":{
@ -4578,7 +4825,7 @@
},
"State":{
"shape":"String",
"documentation":"<p>The state of the reserved compute node.</p> <p>Possible Values:</p> <ul> <li> <p>pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.</p> </li> <li> <p>active-This reserved node is owned by the caller and is available for use.</p> </li> <li> <p>payment-failed-Payment failed for the purchase attempt.</p> </li> </ul>"
"documentation":"<p>The state of the reserved compute node.</p> <p>Possible Values:</p> <ul> <li> <p>pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.</p> </li> <li> <p>active-This reserved node is owned by the caller and is available for use.</p> </li> <li> <p>payment-failed-Payment failed for the purchase attempt.</p> </li> <li> <p>retired-The reserved node is no longer available. </p> </li> <li> <p>exchanging-The owner is exchanging the reserved node for another reserved node.</p> </li> </ul>"
},
"OfferingType":{
"shape":"String",
@ -4605,6 +4852,18 @@
},
"exception":true
},
"ReservedNodeAlreadyMigratedFault":{
"type":"structure",
"members":{
},
"documentation":"<p>Indicates that the reserved node has already been exchanged.</p>",
"error":{
"code":"ReservedNodeAlreadyMigrated",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ReservedNodeList":{
"type":"list",
"member":{
@ -5019,6 +5278,31 @@
"TableRestoreStatus":{"shape":"TableRestoreStatus"}
}
},
"RevisionTarget":{
"type":"structure",
"members":{
"DatabaseRevision":{
"shape":"String",
"documentation":"<p>A unique string that identifies the version to update the cluster to. You can use this value in <a>ModifyClusterDbRevision</a>.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding <a>ClusterDbRevision</a>.</p>"
},
"DatabaseRevisionReleaseDate":{
"shape":"TStamp",
"documentation":"<p>The date on which the database revision was released.</p>"
}
},
"documentation":"<p>Describes a <code>RevisionTarget</code>.</p>"
},
"RevisionTargetsList":{
"type":"list",
"member":{
"shape":"RevisionTarget",
"locationName":"RevisionTarget"
}
},
"RevokeClusterSecurityGroupIngressMessage":{
"type":"structure",
"required":["ClusterSecurityGroupName"],
@ -5535,6 +5819,18 @@
}
},
"TStamp":{"type":"timestamp"},
"TableLimitExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The number of tables in the cluster exceeds the limit for the requested new cluster node type. </p>",
"error":{
"code":"TableLimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"TableRestoreNotFoundFault":{
"type":"structure",
"members":{
@ -5666,7 +5962,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The request exceeds the limit of 10 tags for the resource.</p>",
"documentation":"<p>The number of tables in your source cluster exceeds the limit for the target cluster. Resize to a larger cluster node type.</p>",
"error":{
"code":"TagLimitExceededFault",
"httpStatusCode":400,

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